Class WorkOrderAdmin

Hierarchy

WorkOrderAdmin

Index

Methods - WorkOrders Admin

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

WorkOrders Admin Methods

getEntityGroups

getEntityGroups(): Promise<unknown>
Get entity groups

Returns
Returns Promise that represents a collection of all entity groups

Returns Promise<unknown>
- Defined in workorder_admin.ts:23

getEntityTypes

getEntityTypes(entityGroups: string[]): Promise<unknown>
Get entity types

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

getRelatedInspectionTemplates

getRelatedInspectionTemplates(wOTemplateId: number): Promise<unknown>
Get inspections connected to provided WorkOrder template

Returns
Returns Promise that represents a collection of all tasks on WorkOrder template
Parameters
- wOTemplateId: number
  
  WorkOrder Template ID
Returns Promise<unknown>
- Defined in workorder_admin.ts:238

getTemplateActivity

getTemplateActivity(wOTemplateIds: number[]): Promise<unknown>
Get template activity services for provided WorkOrder Templates

Returns
Returns Promise that represents a collection of all
Parameters
- wOTemplateIds: number[]
  
  Array one or more WorkOrder Template IDs
Returns Promise<unknown>
- Defined in workorder_admin.ts:112

getTemplateEquipment

getTemplateEquipment(wOTemplateId: number): Promise<unknown>
Get equipment

Returns
Returns Promise that represents a collection of all
Parameters
- wOTemplateId: number
Returns Promise<unknown>
- Defined in workorder_admin.ts:148

getTemplateGroupRights

getTemplateGroupRights(wOTemplateIds: number[]): Promise<unknown>
Get template group rights for provided WorkOrder Templates

Returns
Returns Promise that represents a collection of all
Parameters
- wOTemplateIds: number[]
  
  Array one or more WorkOrder Template IDs
Returns Promise<unknown>
- Defined in workorder_admin.ts:94

getTemplateLabor

getTemplateLabor(wOTemplateId: number): Promise<unknown>
Get labor

Returns
Returns Promise that represents a collection of all
Parameters
- wOTemplateId: number
Returns Promise<unknown>
- Defined in workorder_admin.ts:166

getTemplateMapLayerFields

getTemplateMapLayerFields(wOTemplateId: number): Promise<unknown>
Get map layer fields configured for provided WorkOrder template

Returns
Returns Promise that represents a collection of all
Parameters
- wOTemplateId: number
  
  WorkOrder Template ID
Returns Promise<unknown>
- Defined in workorder_admin.ts:202

getTemplateMaterial

getTemplateMaterial(wOTemplateId: number): Promise<unknown>
Get material

Returns
Returns Promise that represents a collection of all
Parameters
- wOTemplateId: number
  
  WorkOrder Template ID
Returns Promise<unknown>
- Defined in workorder_admin.ts:184

getTemplateTasks

getTemplateTasks(wOTemplateId: number): Promise<unknown>
Get tasks configured for provided WorkOrder template

Returns
Returns Promise that represents a collection of all tasks on WorkOrder template
Parameters
- wOTemplateId: number
  
  WorkOrder Template ID
Returns Promise<unknown>
- Defined in workorder_admin.ts:220

getTemplates

getTemplates(entityType: string, includeComments?: boolean, includeInstructions?: boolean): Promise<unknown>
Get WorkOrder templates

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

getUpdateFields

getUpdateFields(wOTemplateIds: number[]): Promise<unknown>
Get fields which will be updated when provided WorkOrder Template instance closes

Returns
Returns Promise that represents a collection of all
Parameters
- wOTemplateIds: number[]
  
  Array one or more WorkOrder Template IDs
Returns Promise<unknown>
- Defined in workorder_admin.ts:130

updateTemplate

updateTemplate(wOTemplate: Object): Promise<unknown>
Update WorkOrder template

Returns
Returns Promise that represents a collection of all
Parameters
- wOTemplate: Object
  
  Obect that describes the WorkOrder Template
Returns Promise<unknown>
- Defined in workorder_admin.ts:75