WorkType

Represents a type of work to be performed in Field Service and Lightning Scheduler. Work types are templates that can be applied to work order or work order line items.

Introduced in API version 38.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

  • Field Service must be enabled.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 58.0

  • Relationship name: AppointmentCategory

  • Relationship type: relationship

  • Refers to: AppointmentCategory

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 57.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 44.0
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 44.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 44.0
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 44.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 44.0
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The description of the work type. Try to add details about the task or tasks that this work type represents.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 65.0
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 49.0
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The unit of the Estimated Duration: Minutes or Hours.
  • Type: double
  • Properties: Create, Filter, Sort, Update
  • Description: The estimated length of the work. The estimated duration is in minutes or hours based on the value selected in the Duration Type field.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 68.0

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 65.0

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 68.0

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 68.0

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 68.0

  • Default value: false

  • Type: int

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 41.0

  • Description:

    The minimum crew size allowed for a crew assigned to the work. Work orders and work order line items inherit their work type’s minimum crew size.

    If you’re not using the Field Service managed package, this field serves as a suggestion rather than a rule. If you are using the managed package, the scheduling optimizer counts the number of service crew members on a service crew to determine whether it fits the minimum crew size requirement.

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the work type. Try to use a name that helps users quickly understand the type of work orders that can be created from the work type. For example, “Annual Refrigerator Maintenance” or “Valve Replacement.”
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 68.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 44.0

  • Relationship name: OperatingHours

  • Relationship type: relationship

  • Refers to: OperatingHours

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 63.0

  • Relationship name: Product

  • Relationship type: relationship

  • Refers to: Product2

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 41.0
  • Description: The recommended number of people on the service crew assigned to the work. For example, you might have a Minimum Crew Size of 2 and a Recommended Crew Size of 3. Work orders and work order line items inherit their work type’s recommended crew size.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: The document template ID. If ServiceDocumentTemplateId isn’t specified, this document template ID determines which service document template is used for service documents generated from a service appointment. The ID is 15 to 18 characters long.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 68.0
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 39.0
  • Description: The service report template associated with the work type. When users create service reports from a work order or work order line item that uses this work type, the reports use this template.
  • Relationship name: ServiceReportTemplate
  • Relationship type: relationship
  • Refers to: ServiceReportLayout

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description: Select this option to have a service appointment automatically created on work orders and work order line items that use the work type.

  • Default value: false

    • By default, the Due Date on auto-created service appointments is seven days after the created date. Admins can adjust this offset from the Field Service Settings page in Setup.

  • If a work type with the Auto-Create Service Appointment option selected is added to an existing work order or work order line item, a service appointment is only created for the work order or work order line item if it doesn’t yet have one.

  • If someone updates an existing work type by selecting the Auto-Create Service Appointment option, service appointments aren’t created on work orders and work order line items that were already using the work type. :::

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 44.0
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 44.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 44.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 44.0
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: The document template ID. If ServiceDocumentTemplateId isn’t specified, this document template ID determines which service document template is used for service documents generated from a work order. The ID is 15 to 18 characters long.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: The document template ID. If ServiceDocumentTemplateId isn’t specified, this document template ID determines which service document template is used for service documents generated from a work order line item. The ID is 15 to 18 characters long.

Adding a work type to a work order or work order line item causes the record to inherit the work type’s duration values and required skills and products.

  • If needed, you can update the duration values and required skills and products on a work order or work order line item after they’re inherited from the work type.
  • If a work order or work order line item already has required skills or products, associating it with a work type doesn’t cause it to inherit the work type’s requirements.
  • If a work order or work order line item already has a duration value in its Duration field, associating it with a work type doesn’t cause it to inherit the work type’s duration value.
  • Customizations to required skills or products, such as validation rules or Apex triggers, are not carried over from work types to work orders and work order line items.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.