Class WorkOrderAdmin

Index

WorkOrders Admin

getEntityGroups getEntityTypes getRelatedInspectionTemplates getTemplateActivity getTemplateById getTemplateEquipment getTemplateGroupRights getTemplateLabor getTemplateMapLayerFields getTemplateMaterial getTemplates getTemplatesByIds getTemplateTasks getUpdateFields updateTemplate

WorkOrders Admin

getEntityGroups

getEntityGroups(): Promise<unknown>
Get entity groups

Returns Promise<unknown>
Returns Promise that represents a collection of all entity groups
- Defined in workorder_admin.ts:23

getEntityTypes

getEntityTypes(entityGroups: string[]): Promise<unknown>
Get entity types
Parameters
- entityGroups: string[]
Returns Promise<unknown>
Returns Promise that represents a collection of all GIS WorkOrder entity types
- Defined in workorder_admin.ts:40

getRelatedInspectionTemplates

getRelatedInspectionTemplates(wOTemplateId: number): Promise<unknown>
Get inspections connected to provided WorkOrder template
Parameters
- wOTemplateId: number
  WorkOrder Template ID
Returns Promise<unknown>
Returns Promise that represents a collection of all tasks on WorkOrder template
- Defined in workorder_admin.ts:276

getTemplateActivity

getTemplateActivity(wOTemplateIds: number[]): Promise<unknown>
Get template activity services for provided WorkOrder Templates
Parameters
- wOTemplateIds: number[]
  Array one or more WorkOrder Template IDs
Returns Promise<unknown>
Returns Promise that represents a collection of all
- Defined in workorder_admin.ts:150

getTemplateById

getTemplateById(templateId?: number): Promise<any>
Get work order template by ID
Parameters
- OptionaltemplateId: number
  The ID of the template to retrieve
Returns Promise<any>
Returns Promise that represents the WorkOrder template matching the provided ID
- Defined in workorder_admin.ts:75

getTemplateEquipment

getTemplateEquipment(wOTemplateId: number): Promise<unknown>
Get equipment
Parameters
- wOTemplateId: number
Returns Promise<unknown>
Returns Promise that represents a collection of all
- Defined in workorder_admin.ts:186

getTemplateGroupRights

getTemplateGroupRights(wOTemplateIds: number[]): Promise<unknown>
Get template group rights for provided WorkOrder Templates
Parameters
- wOTemplateIds: number[]
  Array one or more WorkOrder Template IDs
Returns Promise<unknown>
Returns Promise that represents a collection of all
- Defined in workorder_admin.ts:132

getTemplateLabor

getTemplateLabor(wOTemplateId: number): Promise<unknown>
Get labor
Parameters
- wOTemplateId: number
Returns Promise<unknown>
Returns Promise that represents a collection of all
- Defined in workorder_admin.ts:204

getTemplateMapLayerFields

getTemplateMapLayerFields(wOTemplateId: number): Promise<unknown>
Get map layer fields configured for provided WorkOrder template
Parameters
- wOTemplateId: number
  WorkOrder Template ID
Returns Promise<unknown>
Returns Promise that represents a collection of all
- Defined in workorder_admin.ts:240

getTemplateMaterial

getTemplateMaterial(wOTemplateId: number): Promise<unknown>
Get material
Parameters
- wOTemplateId: number
  WorkOrder Template ID
Returns Promise<unknown>
Returns Promise that represents a collection of all
- Defined in workorder_admin.ts:222

getTemplates

getTemplates(
    entityType: string,
    includeComments?: boolean,
    includeInstructions?: boolean,
): Promise<unknown>
Get WorkOrder templates
Parameters
- entityType: string
- includeComments: boolean = true
- includeInstructions: boolean = true
Returns Promise<unknown>
Returns Promise that represents a collection of all WorkOrder templates
- Defined in workorder_admin.ts:57

getTemplatesByIds

getTemplatesByIds(templateIds?: number[]): Promise<any[]>
Get work order templates by IDs
Parameters
- OptionaltemplateIds: number[]
  The Entity Type(s) to return potential work orders for
Returns Promise<any[]>
Returns Promise that represents a collection of all WorkOrder templates matching the provided IDs
- Defined in workorder_admin.ts:92

getTemplateTasks

getTemplateTasks(wOTemplateId: number): Promise<unknown>
Get tasks configured for provided WorkOrder template
Parameters
- wOTemplateId: number
  WorkOrder Template ID
Returns Promise<unknown>
Returns Promise that represents a collection of all tasks on WorkOrder template
- Defined in workorder_admin.ts:258

getUpdateFields

getUpdateFields(wOTemplateIds: number[]): Promise<unknown>
Get fields which will be updated when provided WorkOrder Template instance closes
Parameters
- wOTemplateIds: number[]
  Array one or more WorkOrder Template IDs
Returns Promise<unknown>
Returns Promise that represents a collection of all
- Defined in workorder_admin.ts:168

updateTemplate

updateTemplate(wOTemplate: Object): Promise<unknown>
Update WorkOrder template
Parameters
- wOTemplate: Object
  Obect that describes the WorkOrder Template
Returns Promise<unknown>
Returns Promise that represents a collection of all
- Defined in workorder_admin.ts:113