Class WorkOrder

Hierarchy

WorkOrder

Index

Properties

Methods - WorkOrder Options

getCategories getCycleFrom getCycleIntervals getCycleTypes getEmployeeLists getExpenseTypes getPriorities getStages getStatuses getSubmitTos getSupervisors

Methods - WorkOrder Search

getSearchList getWOsByEntities

Properties

admin

admin: any

WorkOrder Administration methods

attachments

attachments: any

WorkOrder Comments methods

comment

comment: any

WorkOrder Comments methods

costs

costs: any

WorkOrder Costing methods

WorkOrder Options Methods

getCategories

getCategories(): Promise<unknown>
Get Categories

Returns
Returns Promise that represents an array of configured workorder category code descriptions

Returns Promise<unknown>
- Defined in workorder.ts:742

getCycleFrom

getCycleFrom(): Promise<unknown>
Get Cycle From

Returns
Returns Promise that represents an array of string/string Cycle From options for workorders

Returns Promise<unknown>
- Defined in workorder.ts:774

getCycleIntervals

getCycleIntervals(): Promise<unknown>
Get Cycle Intervals

Returns
Returns Promise that represents an array of string/string Cycle Interval options for workorders

Returns Promise<unknown>
- Defined in workorder.ts:790

getCycleTypes

getCycleTypes(): Promise<unknown>
Get Cycle Types

Returns
Returns Promise that represents an array of string/string Cycle Type options for workorders

Returns Promise<unknown>
- Defined in workorder.ts:806

getEmployeeLists

getEmployeeLists(listType: string, includeInactiveEmployees?: boolean, domainIds?: number[]): Promise<unknown>
Get WorkOrder Employee lists

Returns
Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
Parameters
- listType: string
  
  Which list (endpoint) to get. Includes Supervisors & SubmitTos.
- includeInactiveEmployees: boolean = false
  
  Whether to include inactive employees in the returned list. Defaults to false.
- Optional domainIds: number[]
  
  Filter to certain domains within the Cityworks instance.
Returns Promise<unknown>
- Defined in workorder.ts:676

getExpenseTypes

getExpenseTypes(): Promise<unknown>
Get Expense Types

Returns
Returns Promise that represents an array of string/string Expense Type options for workorders

Returns Promise<unknown>
- Defined in workorder.ts:838

getPriorities

getPriorities(): Promise<unknown>
Get Priorities

Returns
Returns Promise that represents an array of configured workorder priorities

Returns Promise<unknown>
- Defined in workorder.ts:758

getStages

getStages(): Promise<unknown>
Get WorkOrder Stages

Returns
Returns Promise that represents an array of string/string Stage options for WorkOrders

Returns Promise<unknown>
- Defined in workorder.ts:822

getStatuses

getStatuses(): Promise<unknown>
Get Status Options

Returns
Returns Promise that represents a collection of codes. See: /{subdirectory}/apidocs/#/data-type-info;dataType=CodeDesc

Returns Promise<unknown>
- Defined in workorder.ts:726

getSubmitTos

getSubmitTos(includeInactiveEmployees?: boolean, domainIds?: number[]): Promise<unknown>
Get SubmitTo list

Returns
Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
Parameters
- includeInactiveEmployees: boolean = false
  
  Whether to include inactive employees in the returned list. Defaults to false.
- Optional domainIds: number[]
  
  Filter to certain domains within the Cityworks instance.
Returns Promise<unknown>
- Defined in workorder.ts:704

getSupervisors

getSupervisors(includeInactiveEmployees?: boolean, domainIds?: number[]): Promise<unknown>
Get Supervisors list

Returns
Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
Parameters
- includeInactiveEmployees: boolean = false
  
  Whether to include inactive employees in the returned list. Defaults to false.
- Optional domainIds: number[]
  
  Filter to certain domains within the Cityworks instance.
Returns Promise<unknown>
- Defined in workorder.ts:716

WorkOrder Search Methods

getSearchList

getSearchList(workOrderId: string): Promise<unknown>
Get WorkOrderSid and description for provided WorkOrderId

Returns
Returns Promise that represents an object with WorkOrderS/IDs & Description
Parameters
- workOrderId: string
  
  The WorkOrderId for which to get the WorkOrderSid and description
Returns Promise<unknown>
- Defined in workorder.ts:651

getWOsByEntities

getWOsByEntities(entityType: string, entityUids: string[], search?: (string | number)[], s?: boolean): Promise<unknown>
Get WorkOrderS/IDs connected to provided entities

Returns
Returns Promise that represents an array of WorkOrderS/IDs
Parameters
- entityType: string
  
  The entity type to find connected WorkOrders
- entityUids: string[]
- Optional search: (string | number)[]
  
  Any additional search properties of the WorkOrder (open/closed, etc)
- s: boolean = true
  
  Get WorkOrderSids. Defaults to true. When false, returned list is WorkOrderIds
Returns Promise<unknown>
- Defined in workorder.ts:616

WorkOrders Methods

addEntities

addEntities(workOrderSId: string | number, entityInfo: Object, updateXY?: boolean): Promise<unknown>
Add entities to an existing WorkOrder

Returns
Returns object that represents a list of entities removed.
Parameters
- workOrderSId: string | number
  
  The workorder S/ID which the entities should be added to. # for SID, string for ID.
- entityInfo: Object
  
  Entity info object including: (req) EntityType: {string}, (req) EntityUids: {Array}, Facility_Id: {string}, Level_Id: {string}
- updateXY: boolean = true
  
  Update WorkOrder xy after adding entit(y|ies), default is true.
Returns Promise<unknown>
- Defined in workorder.ts:378

cancel

cancel(workOrderIds: number[], cancelReason?: string, dateCancelled?: Date): Promise<unknown>
Cancel workorders

Returns
Returns object that represents a collection of workorders
Parameters
- workOrderIds: number[]
  
  An array of the IDs to cancel the matched workorders
- Optional cancelReason: string
  
  A reason for cancelling the workorder(s)
- Optional dateCancelled: Date
  
  The date/time that it should be indicated the workorder was cancelled
Returns Promise<unknown>
- Defined in workorder.ts:502

close

close(workOrderIds: number[]): Promise<unknown>
Close WorkOrders

Returns
Returns object that represents a collection of WorkOrders
Parameters
- workOrderIds: number[]
  
  An array of the IDs to close the matched WorkOrders
Returns Promise<unknown>
- Defined in workorder.ts:545

combine

combine(fromWorkOrderIds: string[], toWorkOrderId: string, cancelCombinedWorkOrders?: boolean): Promise<unknown>
Combine WorkOrders

Returns
Returns object that represents a collection of WorkOrders
Parameters
- fromWorkOrderIds: string[]
  
  The workorder IDs which should be combined.
- toWorkOrderId: string
  
  The WorkOrder ID for the single WorkOrder that should contain the info/entities from the other WorkOrders
- cancelCombinedWorkOrders: boolean = true
  
  If the WorkOrders combined into the single should then be canceled, default is true.
Returns Promise<unknown>
- Defined in workorder.ts:129

create

create(wo_data: Object, inspectionIds?: number[], requestIds?: number[]): Promise<unknown>
Create new workorders, including linkin to Requests & Inspections (optionally)

Returns
Returns Promise that represents an object describing the newly-created workorder
Parameters
- wo_data: Object
  
  See /{subdirectory}/apidocs/#/data-type-infodataType=WorkOrder on the Cityworks instance
- Optional inspectionIds: number[]
  
  The inspection IDs which the workorder should be linked to.
- Optional requestIds: number[]
  
  The inspection IDs which the workorder should be linked to.
Returns Promise<unknown>
- Defined in workorder.ts:50

createFromParent

createFromParent(wo_data: Object, workOrderSId: string | number, s?: boolean): Promise<unknown>
Create new workorder linked to parent workorder

Returns
Returns Promise that represents an object describing the newly-created workorder
Parameters
- wo_data: Object
  
  See /{subdirectory}/apidocs/#/data-type-infodataType=WorkOrder on the Cityworks instance
- workOrderSId: string | number
  
  The workorder S/ID which the entities should be added to. # for SID, string for ID.
- s: boolean = true
Returns Promise<unknown>
- Defined in workorder.ts:79

delete

delete(workOrderIds: number[]): Promise<unknown>
Delete WorkOrders

Returns
Returns object that represents a collection of WorkOrder Ids which have been deleted
Parameters
- workOrderIds: number[]
  
  An array of the IDs to delete the matched WorkOrders
Returns Promise<unknown>
- Defined in workorder.ts:589

deleteMLFs

deleteMLFs(workOrderSId: string): Promise<unknown>
Delete Map Layer Fields

Returns
Returns Promise that represents a collection of Objects describing the workorders
Parameters
- workOrderSId: string
  
  The workorder S/ID to delete the map layer fields for.
Returns Promise<unknown>
- Defined in workorder.ts:919

getAuditLog

getAuditLog(workOrderSId: number): Promise<unknown>
Get the audit log for a specific workorder

Returns
Returns Promise that represents a collection of Cityworks Metadata Objects
Parameters
- workOrderSId: number
  
  A WorkOrder S/ID to get the audit log for. SID is default.
Returns Promise<unknown>
- Defined in workorder.ts:284

getById

getById(workOrderSId: string | number, s?: boolean): Promise<unknown>
Get a workorder by S/ID

Returns
Returns Promise that represents an object describing the workorder
Parameters
- workOrderSId: string | number
  
  The S/ID of the workorder to retrieve. # for SID, string for ID.
- s: boolean = true
  
  Whether first argument is an SID (true) or an ID (false). Defaults to true.
Returns Promise<unknown>
- Defined in workorder.ts:191

getByIds

getByIds(workOrderSIds: (string | number)[]): Promise<unknown>
Get workorders by an array of S/IDs

Returns
Returns Promise that represents a collection of Objects describing the workorders
Parameters
- workOrderSIds: (string | number)[]
  
  The workorder S/IDs to retrieve. If providing WorkOrderID, should be all strings, else provide all numbers for WorkOrderSID
Returns Promise<unknown>
- Defined in workorder.ts:216

getCustomFieldValues

getCustomFieldValues(workOrderSIds: (string | number)[]): Promise<unknown>
Get custom field values for the workorder S/IDs

Returns
Returns Promise that represents a collection of Objects describing the workorders
Parameters
- workOrderSIds: (string | number)[]
  
  The workorder S/IDs to retrieve. #s for SID, strings for ID.
Returns Promise<unknown>
- Defined in workorder.ts:310

getEntities

getEntities(workOrderSIds: (string | number)[], getGisData?: boolean): Promise<unknown>
Get entities on an existing WorkOrder

Returns
Returns object that represents a list of entities removed.
Parameters
- workOrderSIds: (string | number)[]
  
  The workorder S/IDs which the entities should be added to. # for SID, string for ID.
- getGisData: boolean = true
  
  Query gis to populate Entity.Attributes with current gis data. Defaults to true.
Returns Promise<unknown>
- Defined in workorder.ts:340

getInstructions

getInstructions(workOrderSIds: (string | number)[]): Promise<unknown>
Get instructions by an array of workorders S/IDs

Returns
Returns Promise that represents an array of String, String describing the workorder instructions
Parameters
- workOrderSIds: (string | number)[]
  
  The workorder S/IDs to retrieve. If providing WorkOrderID, should be all strings, else provide all numbers for WorkOrderSID
Returns Promise<unknown>
- Defined in workorder.ts:250

getMLFs

getMLFs(workOrderSId: string): Promise<unknown>
Get Map Layer Fields

Returns
Returns Promise that represents a collection of Objects describing the workorders
Parameters
- workOrderSId: string
  
  The workorder S/ID to get the map layer fields for.
Returns Promise<unknown>
- Defined in workorder.ts:855

move

move(workOrderId: string, x: number, y: number, projection: Object, z?: number): Promise<unknown>
Move a workorder's point

Returns
Returns Promise that represents an object describing the updated workorder
Parameters
- workOrderId: string
- x: number
- y: number
- projection: Object
  
  Should include WKT or WKID attribute. Can also include VcsWKID attribute.
- Optional z: number
  
  Optional Z coordinate
Returns Promise<unknown>
- Defined in workorder.ts:160

removeEntities

removeEntities(workOrderSId: string | number, entityInfo: Object, updateXY?: boolean): Promise<unknown>
Remove entities from a WorkOrder. Provide WorkOrderId and either ObjectIds or EntityType and EntityUids

Returns
Returns object that represents a list of entities removed.
Parameters
- workOrderSId: string | number
  
  The workorder S/ID which the entities should be removed from. # for SID, string for ID.
- entityInfo: Object
  
  Remove entities by WorkOrderEntity.ObjectId (not gis objectId).
- updateXY: boolean = true
  
  Update WorkOrder xy after removing entities, default is true.
Returns Promise<unknown>
- Defined in workorder.ts:462

reopen

reopen(workOrderIds: number[]): Promise<unknown>
Reopen closed WorkOrders

Returns
Returns object that represents a collection of WorkOrders
Parameters
- workOrderIds: number[]
  
  An array of the IDs to reopen the matched WorkOrders
Returns Promise<unknown>
- Defined in workorder.ts:569

uncancel

uncancel(workOrderIds: number[]): Promise<unknown>
Uncancel workorders

Returns
Returns object that represents a collection of workorders
Parameters
- workOrderIds: number[]
  
  An array of the IDs to uncancel the matched workorders
Returns Promise<unknown>
- Defined in workorder.ts:525

update

update(wo_data: Object): Promise<unknown>
Update a WorkOrder

Returns
Returns Promise that represents an object describing the updated workorder
Parameters
- wo_data: Object
  
  See /{subdirectory}/apidocs/#/data-type-infodataType=WorkOrder on the Cityworks instance
Returns Promise<unknown>
- Defined in workorder.ts:106

updateEntity

updateEntity(workOrderSId: string | number, entityInfo: Object, workComplete?: boolean): Promise<unknown>
Update a WorkOrder entity

Returns
Returns object that represents a list of entities removed.
Parameters
- workOrderSId: string | number
  
  The workorder S/ID which the entities should be added to. # for SID, string for ID.
- entityInfo: Object
  
  Entity info object including: (req) EntityType: {string}, (req) EntityUid: {string}, Facility_Id: {string}, Level_Id: {string}
- workComplete: boolean = false
  
  Update WorkOrder completeness, default is true.
Returns Promise<unknown>
- Defined in workorder.ts:420

updateMLFs

updateMLFs(workOrderSId: string, x?: number, y?: number, domainId?: number, z?: number): Promise<unknown>
Update Map Layer Fields

Returns
Returns Promise that represents a ...
Parameters
- workOrderSId: string
  
  The workorder S/ID to get the map layer fields for.
- Optional x: number
- Optional y: number
- Optional domainId: number
  
  Should include WKT or WKID attribute. Can also include VcsWKID attribute.
- Optional z: number
  
  Optional Z coordinate
Returns Promise<unknown>
- Defined in workorder.ts:880

Class WorkOrder

Hierarchy

Index

Properties

Methods - WorkOrder Options

Methods - WorkOrder Search

Methods - WorkOrders

Properties

admin

attachments

comment

costs

WorkOrder Options Methods

getCategories

Returns

Returns Promise<unknown>

getCycleFrom

Returns

Returns Promise<unknown>

getCycleIntervals

Returns

Returns Promise<unknown>

getCycleTypes

Returns

Returns Promise<unknown>

getEmployeeLists

Returns

Parameters

listType: string

includeInactiveEmployees: boolean = false

Optional domainIds: number[]

Returns Promise<unknown>

getExpenseTypes

Returns

Returns Promise<unknown>

getPriorities

Returns

Returns Promise<unknown>

getStages

Returns

Returns Promise<unknown>

getStatuses

Returns

Returns Promise<unknown>

getSubmitTos

Returns

Parameters

includeInactiveEmployees: boolean = false

Optional domainIds: number[]

Returns Promise<unknown>

getSupervisors

Returns

Parameters

includeInactiveEmployees: boolean = false

Optional domainIds: number[]

Returns Promise<unknown>

WorkOrder Search Methods

getSearchList

Returns

Parameters

workOrderId: string

Returns Promise<unknown>

getWOsByEntities

Returns

Parameters

entityType: string

entityUids: string[]

Optional search: (string | number)[]

s: boolean = true

Returns Promise<unknown>

WorkOrders Methods

addEntities

Returns

Parameters

workOrderSId: string | number

entityInfo: Object

updateXY: boolean = true

Returns Promise<unknown>

cancel

Returns

`Optional` domainIds: number[]

`Optional` domainIds: number[]

`Optional` domainIds: number[]

`Optional` search: (string | number)[]

`Optional` cancelReason: string

`Optional` dateCancelled: Date

`Optional` inspectionIds: number[]

`Optional` requestIds: number[]