WorkPlan

Represents a work plan for a work order or work order line item.

Introduced in API version 49.0.

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

  • Field Service must be enabled.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The description of the work plan.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The order in which the work plan is executed. Only positive values or null are supported.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the work plan.

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Introduced: API version 54.0

  • Description:

    The ID of the work order, work order line item, or change request that the work plan is associated with.

    This field is a polymorphic relationship field.

  • Relationship name: ParentRecord

  • Relationship type: polymorphic

  • Refers to: ChangeRequest, MessagingSession, UserAssistanceCapability, WorkOrder, WorkOrderLineItem

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 54.0
  • Description: Describes whether the parent record is a work order, work order line item, or change request.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Required. The ID of the work order.
  • Relationship name: WorkOrder
  • Relationship type: relationship
  • Refers to: WorkOrder
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the work order line item.
  • Relationship name: WorkOrderLineItem
  • Relationship type: relationship
  • Refers to: WorkOrderLineItem

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 54.0

  • Description:

    The ID of the work plan template record.

    This field is a relationship field.

  • Relationship name: WorkPlanTemplate

  • Relationship type: relationship

  • Refers to: WorkPlanTemplate

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.