1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Work Orders

Update a work order

patch

/crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}

Request

Path Parameters
  • The alternate unique identifier of the work order. This value is system-generated, and is configured in the work order profile options SVC_WO_NUMBER PREFIX and SVC_WO_NUMBER_FORMAT. The default configuration is WO0000000000.
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Account ID
    The unique identifier of the account party associated with the work order.
  • Title: Account
    Maximum Length: 900
    The name of the customer account associated with the work order.
  • Title: Actual End Date
    The actual end date and time of the work completed at the customer location. This value is updated through integration after the service is complete.
  • Title: Actual Start Date
    The actual start date and time of the work at the customer location. This value is updated through integration after the service is started.
  • Title: Address Line 1
    Maximum Length: 240
    The first line of the address where the service will be performed.
  • Title: Address Line 2
    Maximum Length: 240
    The second line of the address where the service will be performed.
  • Title: Address Line 3
    Maximum Length: 240
    The third line of the address where the service will be performed.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line of the address where the service will be performed.
  • Title: Address ID
    The unique identifier of the address where the service will be performed.
  • Title: Address Source Code
    Maximum Length: 30
    The lookup code of the source of the address.
  • Title: Assigned To
    Maximum Length: 360
    The name of the resource assigned to the work order.
  • Title: Assigned to ID
    The unique identifier of the resource assigned to the work order.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Bill-To Customer Account ID
    The customer account to be billed for the work order.
  • Title: Bill-To Customer Account Site ID
    The customer account site to be billed for the work order.
  • Title: Bill-To Customer ID
    The customer to be billed for the work order.
  • Title: Bill-To Customer Site ID
    The party site to be billed for the work order.
  • Title: Booked Date
    The date and time when the Field Service Cloud activity was booked.
  • Title: Business Unit ID
    The unique identifier of the service business unit associated with the customer work order.
  • Title: Cancel Reason
    Maximum Length: 256
    The reason for cancelling the work order.
  • Title: Case Note
    Maximum Length: 65535
    The additional information captured to share with the field service resource assigned to the work order.
  • Title: City
    Maximum Length: 60
    The city where the service will be performed.
  • Title: Other Phone
    Maximum Length: 240
    The alternate phone number of the contact for whom the service will be performed.
  • Title: Email
    Maximum Length: 320
    The email of the contact for whom the service will be performed.
  • Title: Contact Name
    Maximum Length: 420
    The name of the contact for whom the service will be performed.
  • Title: Contact ID
    The unique identifier of the contact for whom the service will be performed.
  • Title: Contact Party Site ID
    The contact party site ID of the work order address where the service will be performed.
  • Title: Phone
    Maximum Length: 240
    The primary phone number of the contact for whom the service will be performed.
  • Title: Country
    Maximum Length: 2
    The country where the service will be performed.
  • Title: County
    Maximum Length: 60
    The county where the service will be performed.
  • Title: Delivery Window End Date
    The estimated date and time when the window, for the arrival of the field service resource at the customer location, ends. For example, the technician is estimated to arrive on May 31, 2018 between 2:15 PM and 2:45 PM, where May 31, 2018 at 2:45 PM is the delivery window end date.
  • Title: Delivery Window Start Date
    The estimated date and time when the window, for the arrival of the field service resource at the customer location, begins. For example, the technician is estimated to arrive on May 31, 2018 between 2:15 PM and 2:45 PM, where May 31, 2018 at 2:15 PM is the delivery window start date.
  • Title: Estimated Duration
    The estimated time required to complete the work order based on the work order type. This value is updated with the estimated duration from Field Service Cloud based on the activity type. After the work is completed, the value is updated with the actual duration that was required to complete the work order.
  • Title: Estimated Start Date
    The estimated arrival date of the field service technician at the service location. This value is updated from Oracle Field Service Cloud.
  • Title: Field Service Resource ID
    The unique identifier of the field service resource assigned to the work order.
  • Title: Address
    The formatted address where the service will be performed.
  • Title: Activity ID
    The unique identifier of the corresponding activity in Oracle Field Service Cloud.
  • Title: Field Service Contact Indicator
    Maximum Length: 1
    Default Value: false
    Indicates whether the contact came from Oracle Field Service Cloud or Oracle Engagement Cloud.
  • Title: FS Error Detail
    Maximum Length: 500
    The error message returned from Oracle Integration Cloud during the most recent integration event of the work order with an activity in Oracle Field Service Cloud.
  • Title: Field Service Note
    Maximum Length: 65535
    The information added to the work order from Oracle Field Service Cloud activity integration.
  • Title: Resource
    Maximum Length: 256
    The name of the field service resource assigned to the work order.
  • Title: Resource External ID
    Maximum Length: 32
    The external ID of the resource being used to complete this work order.
  • Title: Scheduled Resource
    Maximum Length: 256
    The scheduled resource being used to complete the work order.
  • Title: Scheduled Resource External ID
    Maximum Length: 32
    The external ID of the scheduled resource being used to complete the work order.
  • Title: Oracle Field Service Technician Locator URL
    Maximum Length: 2000
    The URL used to track the location of the technician.
  • Title: Installed Base Asset ID
    The ID of the installed base asset attached to the work order.
  • Title: Inventory Item ID
    The unique identifier of the product associated with the work order.
  • Title: Inventory Organization ID
    The unique identifier of the organization of the product that is associated with the work order.
  • Title: Last Updated by Source
    Maximum Length: 30
    The source who last updated the work order.
  • Title: Opportunity ID
    The unique identifier of the opportunity associated with the work order.
  • Title: Owner Type
    Maximum Length: 30
    The code indicating the type of account that owns the work order. A list of accepted values is defined in the lookup type ORA_SVC_OWNER_TYPE_CD. The valid owner types are customer and partner.
  • Title: Partner Account
    Maximum Length: 900
    The name of the partner account associated with the work order. Two accounts can have the same party name but not the same unique name.
  • Title: Partner Account ID
    The unique identifier of the partner account associated with the work order.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the area where the service will be performed.
  • Title: Primary Asset ID
    The unique identifier of the primary asset associated with the work order.
  • Title: Product Group ID
    The unique identifier of the product group associated with the work order.
  • Title: Product Group
    Maximum Length: 255
    The product group on the work order.
  • Title: Product Description
    Maximum Length: 255
    The product description on the work order.
  • Title: Province
    Maximum Length: 60
    The province where the service will be performed.
  • Title: Remind Customer
    The time in minutes before the estimated arrival time when the customer will be sent a reminder from Oracle Field Service Cloud.
  • Title: Requested By
    The unique identifier of the resource that requested the work order be created.
  • Title: Requested Date
    The date when the service to be scheduled, as requested by the customer.
  • Title: Requested Date and End Time
    The requested date and end time for the work order.
  • Title: Requested Date and Start Time
    The requested date and start time for the work order.
  • Title: Requested Time Slot
    Maximum Length: 40
    The time slot requested by the customer for the service to be scheduled.
  • Title: Reschedule Reason
    Maximum Length: 256
    The reason for rescheduling the work order.
  • Title: Resolution Due
    The date and time when the work order or the service request is expected to be resolved. This value is based on the customer's service level agreement milestone, or is manually set.
  • Title: Scheduled Date
    The date when the service is scheduled to be performed.
  • Title: Scheduled Date and End Time
    The scheduled date and end time for the work order.
  • Title: Scheduled Date and Start Time
    The scheduled date and start time for the work order.
  • Title: Scheduled Time Slot
    Maximum Length: 40
    The time slot when the service is scheduled to be performed.
  • Title: Service Profile ID
    The unique identifier of the service profile associated with the customer work order.
  • Title: Service Request ID
    The unique identifier of the service request associated to the work order.
  • Title: Service Request
    Maximum Length: 30
    The alternate key identifier of the service request associated with the work order.
  • Title: State
    Maximum Length: 60
    The state where the service will be performed.
  • Title: Time Zone
    Maximum Length: 64
    The time zone where the service will be performed.
  • Title: Title
    Maximum Length: 400
    The label displaying the title of a work order.
  • Title: Travel Time
    The time in minutes from Oracle Field Service Cloud for the field service agent to travel from a previous activity location to the current activity location.
  • Title: Trigger Update Event
    Maximum Length: 80
    Indicates a work order related object has been updated and used to trigger an update event for the work order to allow updates to flow through an OIC flow.
  • Title: Work Order Integration Message Code
    Maximum Length: 30
    The code indicating the integration message to be used to share information about the most recent integration event for the work order with end users. A list of accepted values is defined in the lookup type ORA_SVC_WO_INT_MSG_CD. You can review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Integration Messages.
  • Title: Work Order Integration Status Code
    Maximum Length: 30
    The code indicating the integration status of the most recent integration event for the work order. A list of accepted values is defined in the lookup type ORA_SVC_WO_INT_STATUS_CD.
  • Links
    Title: Links
    The work order link resource is used to view, create, and delete a customer work order link. A work order link is a transactional record, which is created when a customer needs to define a relationship between field service work orders.
  • Title: Work Order Parent ID
    The ID of the parent work order. This is a foreign key reference to SVC_WORK_ORDERS (WO_ID).
  • Title: Record Type
    Maximum Length: 60
    The type of the work order such as regular, multiday work order, or multiday work order segment.
  • Title: Status
    Maximum Length: 30
    The code indicating the status of the work order, for example, Submitted, Scheduled, Started, Complete, Suspended, Canceled, and so on. A list of accepted values is defined in the lookup type ORA_SVC_WO_STATUS_CD. You can review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Work Order Statuses.
  • Title: Status ID
    The ID for the work order status selected on the work order.
  • Title: Type
    The unique identifier of the type of the work order. This value is required when creating a work order.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type: array
Title: Links
The work order link resource is used to view, create, and delete a customer work order link. A work order link is a transactional record, which is created when a customer needs to define a relationship between field service work orders.
Show Source
Nested Schema : customerWorkOrders-Attachment-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : customerWorkOrders-item-response
Type: object
Show Source
  • Title: Account ID
    The unique identifier of the account party associated with the work order.
  • Title: Account
    Maximum Length: 900
    The name of the customer account associated with the work order.
  • Title: Account Name
    Read Only: true
    Maximum Length: 360
    The alternate name of the customer account associated with the work order.
  • Title: Account Party Number
    Read Only: true
    Maximum Length: 30
    The PUID of the account party associated with the customer work order.
  • Title: Account Status
    Read Only: true
    Maximum Length: 1
    The status of the account associated with the work order.
  • Title: Actual End Date
    The actual end date and time of the work completed at the customer location. This value is updated through integration after the service is complete.
  • Title: Actual Start Date
    The actual start date and time of the work at the customer location. This value is updated through integration after the service is started.
  • Title: Address Line 1
    Maximum Length: 240
    The first line of the address where the service will be performed.
  • Title: Address Line 2
    Maximum Length: 240
    The second line of the address where the service will be performed.
  • Title: Address Line 3
    Maximum Length: 240
    The third line of the address where the service will be performed.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line of the address where the service will be performed.
  • Title: Address ID
    The unique identifier of the address where the service will be performed.
  • Title: Address Source
    Read Only: true
    Maximum Length: 255
    The source field to which the service address is associated to such as account, contact, service profile, asset, or a one-time address.
  • Title: Address Source Code
    Maximum Length: 30
    The lookup code of the source of the address.
  • Title: Assigned to Email
    Read Only: true
    Maximum Length: 320
    The email of the resource assigned to the work order.
  • Title: Assigned To
    Maximum Length: 360
    The name of the resource assigned to the work order.
  • Title: Assigned to Phone
    Read Only: true
    The phone number of the resource assigned to the work order.
  • Title: Assigned to ID
    The unique identifier of the resource assigned to the work order.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Bill-To Customer Account ID
    The customer account to be billed for the work order.
  • Title: Bill-To Customer Account Site ID
    The customer account site to be billed for the work order.
  • Title: Bill-To Customer ID
    The customer to be billed for the work order.
  • Title: Bill-To Customer Account Name
    Read Only: true
    Maximum Length: 240
    The bill-to customer account name.
  • Title: Bill-To Customer Account Number
    Read Only: true
    Maximum Length: 30
    The account number to be billed for the work order.
  • Title: Bill-To Customer Site ID
    The party site to be billed for the work order.
  • Title: Bill-To Customer Name
    Read Only: true
    Maximum Length: 360
    The name of the customer to be billed for the work order.
  • Title: Bill-To Customer Number
    Read Only: true
    Maximum Length: 30
    The PUID of the customer account to be billed for the work order.
  • Title: Bill-To Address
    Read Only: true
    Maximum Length: 5000
    The formatted address of the party site to be billed for the work order.
  • Title: Bill-To Customer Site Location ID
    Read Only: true
    The location identifier of the party site to be billed for the work order.
  • Title: Bill-To Customer Site Name
    Read Only: true
    Maximum Length: 240
    The name of the party site to be billed for the work order.
  • Title: Bill-To Customer Site Number
    Read Only: true
    Maximum Length: 30
    The PUID of the party site to be billed for the work order.
  • Title: Bill-To Unique Customer Name
    Read Only: true
    Maximum Length: 900
    The unique name of the customer to be billed for the work order.
  • Title: Booked Date
    The date and time when the Field Service Cloud activity was booked.
  • Title: Business Unit ID
    The unique identifier of the service business unit associated with the customer work order.
  • Title: Business Unit Name
    Read Only: true
    The name of the business unit associated with the work order.
  • Title: Cancel Reason
    Maximum Length: 256
    The reason for cancelling the work order.
  • Title: Case Note
    Maximum Length: 65535
    The additional information captured to share with the field service resource assigned to the work order.
  • Title: City
    Maximum Length: 60
    The city where the service will be performed.
  • Title: Other Phone
    Maximum Length: 240
    The alternate phone number of the contact for whom the service will be performed.
  • Title: Email
    Maximum Length: 320
    The email of the contact for whom the service will be performed.
  • Title: Contact Language
    Read Only: true
    Maximum Length: 4
    The language spoken by the contact for whom the service will be performed.
  • Title: Contact Name
    Maximum Length: 420
    The name of the contact for whom the service will be performed.
  • Title: Contact LOV
    Read Only: true
    The LOV switcher for the name of the contact for whom the service will be performed.
  • Title: Contact First Name
    Read Only: true
    Maximum Length: 150
    The first name of the contact for whom the service will be performed.
  • Title: Contact ID
    The unique identifier of the contact for whom the service will be performed.
  • Title: Contact Last Name
    Read Only: true
    Maximum Length: 150
    The last name of the contact for whom the service will be performed.
  • Title: Contact Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the customer for whom the service is to be performed.
  • Title: Contact Party Site ID
    The contact party site ID of the work order address where the service will be performed.
  • Title: Phone
    Maximum Length: 240
    The primary phone number of the contact for whom the service will be performed.
  • Title: Contact Status
    Read Only: true
    Maximum Length: 1
    The status of the contact for whom the service will be performed.
  • Title: Country
    Maximum Length: 2
    The country where the service will be performed.
  • Title: County
    Maximum Length: 60
    The county where the service will be performed.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the work order.
  • Title: Creation Date
    Read Only: true
    The date and time when the work order is created.
  • Title: Deleted
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Indicates whether the work order is deleted and should not to be displayed in the UI.
  • Title: Delivery Window End Date
    The estimated date and time when the window, for the arrival of the field service resource at the customer location, ends. For example, the technician is estimated to arrive on May 31, 2018 between 2:15 PM and 2:45 PM, where May 31, 2018 at 2:45 PM is the delivery window end date.
  • Title: Delivery Window Start Date
    The estimated date and time when the window, for the arrival of the field service resource at the customer location, begins. For example, the technician is estimated to arrive on May 31, 2018 between 2:15 PM and 2:45 PM, where May 31, 2018 at 2:15 PM is the delivery window start date.
  • Title: Estimated Duration
    The estimated time required to complete the work order based on the work order type. This value is updated with the estimated duration from Field Service Cloud based on the activity type. After the work is completed, the value is updated with the actual duration that was required to complete the work order.
  • Title: Editable
    Read Only: true
    Indicates whether the work order is read-only or editable.
  • Title: Estimated Arrival Time
    Read Only: true
    The estimated arrival time of the field service technician at the service location. This value is updated from Oracle Field Service Cloud.
  • Title: Estimated Start Date
    The estimated arrival date of the field service technician at the service location. This value is updated from Oracle Field Service Cloud.
  • Title: Field Service Resource Email
    Read Only: true
    Maximum Length: 320
    The email of the field service resource assigned to complete the work order.
  • Title: Field Service Resource ID
    The unique identifier of the field service resource assigned to the work order.
  • Title: Field Service Resource
    Read Only: true
    Maximum Length: 360
    The name of the field service resource assigned to complete the work order.
  • Title: Field Service Resource Phone Number
    Read Only: true
    The phone number of the field service resource who is assigned to complete the work order.
  • Title: Address
    The formatted address where the service will be performed.
  • Title: Activity ID
    The unique identifier of the corresponding activity in Oracle Field Service Cloud.
  • Title: Field Service Contact Indicator
    Maximum Length: 1
    Default Value: false
    Indicates whether the contact came from Oracle Field Service Cloud or Oracle Engagement Cloud.
  • Title: FS Error Detail
    Maximum Length: 500
    The error message returned from Oracle Integration Cloud during the most recent integration event of the work order with an activity in Oracle Field Service Cloud.
  • Title: Field Service Note
    Maximum Length: 65535
    The information added to the work order from Oracle Field Service Cloud activity integration.
  • Title: Resource
    Maximum Length: 256
    The name of the field service resource assigned to the work order.
  • Title: Resource External ID
    Maximum Length: 32
    The external ID of the resource being used to complete this work order.
  • Title: Scheduled Resource
    Maximum Length: 256
    The scheduled resource being used to complete the work order.
  • Title: Scheduled Resource External ID
    Maximum Length: 32
    The external ID of the scheduled resource being used to complete the work order.
  • Title: Oracle Field Service Technician Locator URL
    Maximum Length: 2000
    The URL used to track the location of the technician.
  • Title: Activity Type Code
    Read Only: true
    Maximum Length: 30
    The code indicating the type of the activity for a work order. This value maps the work order type to an activity type in Oracle Field Service Cloud.
  • Title: Installed Base Asset Active Status
    Read Only: true
    The active status of the installed base asset attached to the work order.
  • Title: Installed Base Asset Description
    Read Only: true
    Maximum Length: 240
    The description of the installed base asset attached to the work order.
  • Title: Installed Base Asset End Date
    Read Only: true
    The end date of the installed base asset attached to the work order.
  • Title: Installed Base Asset ID
    The ID of the installed base asset attached to the work order.
  • Title: Installed Base Asset Installed Date
    Read Only: true
    The install date of the installed base asset attached to the work order.
  • Title: Installed Base Asset Product Name
    Read Only: true
    Maximum Length: 255
    The product description of the installed base asset attached to the work order.
  • Title: Installed Base Asset Product Number
    Read Only: true
    Maximum Length: 255
    The product number of the installed base asset attached to the work order.
  • Title: Installed Base Asset Number
    Read Only: true
    Maximum Length: 80
    The number of the installed base asset attached to the work order.
  • Title: Installed Base Asset Purchase Date
    Read Only: true
    The purchase date of the installed base asset attached to the work order.
  • Title: Installed Base Asset Quantity
    Read Only: true
    The quantity of the installed base asset attached to the work order.
  • Title: Installed Base Asset Serial Number
    Read Only: true
    Maximum Length: 80
    The serial number of the installed base asset attached to the work order.
  • Title: Installed Base Asset Start Date
    Read Only: true
    The start date of the installed base asset attached to the work order.
  • Title: Installed Base Asset Status
    Read Only: true
    Maximum Length: 30
    The status of the installed base asset attached to the work order.
  • Title: Installed Base Asset Tag
    Read Only: true
    Maximum Length: 240
    The tag of the installed base asset attached to the work order.
  • Title: Installed Base Asset UOM
    Read Only: true
    Maximum Length: 3
    The unit of measure for the quantity of the installed base asset attached to the work order.
  • Title: Inventory Item ID
    The unique identifier of the product associated with the work order.
  • Title: Inventory Organization ID
    The unique identifier of the organization of the product that is associated with the work order.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the work order was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the work order.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the work order.
  • Title: Last Updated by Source
    Maximum Length: 30
    The source who last updated the work order.
  • Links
  • Title: Opportunity ID
    The unique identifier of the opportunity associated with the work order.
  • Title: Owner Type
    Maximum Length: 30
    The code indicating the type of account that owns the work order. A list of accepted values is defined in the lookup type ORA_SVC_OWNER_TYPE_CD. The valid owner types are customer and partner.
  • Title: Partner Account
    Maximum Length: 900
    The name of the partner account associated with the work order. Two accounts can have the same party name but not the same unique name.
  • Title: Partner Account ID
    The unique identifier of the partner account associated with the work order.
  • Title: Partner Account Type
    Read Only: true
    Maximum Length: 30
    The type of sales channel associated with the partner.
  • Title: Partner Account Status
    Read Only: true
    The status of the partner account associated with the work order.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the area where the service will be performed.
  • Title: Primary Asset Description
    Read Only: true
    Maximum Length: 2000
    The description of the primary asset associated with the work order.
  • Title: Primary Asset End Date
    Read Only: true
    The date after which the primary asset will no longer be active.
  • Title: Primary Asset ID
    The unique identifier of the primary asset associated with the work order.
  • Title: Primary Asset Install Date
    Read Only: true
    The date when the primary asset was installed.
  • Title: Primary Asset
    Read Only: true
    Maximum Length: 300
    The name of the primary asset associated with the work order.
  • Title: Primary Asset Number
    Read Only: true
    Maximum Length: 100
    The alternate key identifier of the primary asset associated with the work order.
  • Title: Primary Asset Product Name
    Read Only: true
    Maximum Length: 255
    The name of the product associated with the primary asset.
  • Title: Primary Asset Purchase Date
    Read Only: true
    The date when the primary asset was purchased.
  • Title: Primary Asset Quantity
    Read Only: true
    The quantity of the work order primary asset.
  • Title: Primary Asset Serial Number
    Read Only: true
    Maximum Length: 100
    The serial number of the primary asset associated with the work order.
  • Title: Primary Asset Start Date
    Read Only: true
    The date when the primary asset became active.
  • Title: Primary Asset Status Code
    Read Only: true
    Maximum Length: 50
    The code indicating the status of the work order primary asset.
  • Title: Primary Asset Tag
    Read Only: true
    Maximum Length: 50
    The tag of the primary asset associated with the work order.
  • Title: Primary Asset UOM
    Read Only: true
    Maximum Length: 3
    The unit of measure associated with the primary asset.
  • Title: Product Group ID
    The unique identifier of the product group associated with the work order.
  • Title: Product Group
    Maximum Length: 255
    The product group on the work order.
  • Title: Product Description
    Maximum Length: 255
    The product description on the work order.
  • Title: Province
    Maximum Length: 60
    The province where the service will be performed.
  • Title: Remind Customer
    The time in minutes before the estimated arrival time when the customer will be sent a reminder from Oracle Field Service Cloud.
  • Title: Requested By
    The unique identifier of the resource that requested the work order be created.
  • Title: Requested Date
    The date when the service to be scheduled, as requested by the customer.
  • Title: Requested Date and End Time
    The requested date and end time for the work order.
  • Title: Requested Date and Start Time
    The requested date and start time for the work order.
  • Title: Requested
    Read Only: true
    Maximum Length: 255
    The combined requested date and time slot for the service to be scheduled. For example, May 31, 2018 1:00 - 3:00 PM.
  • Title: Requested Time Slot
    Maximum Length: 40
    The time slot requested by the customer for the service to be scheduled.
  • Title: Total Cancelable Part Orders
    Read Only: true
    The total number of parts orders that are cancelable.
  • Title: Total Canceled Part Orders
    Read Only: true
    The total number of canceled part orders.
  • Title: Earliest Part Order Arrival Date in UTC
    Read Only: true
    The earliest arrival date of a part order in UTC.
  • Title: Earliest Part Order Arrival Date
    Read Only: true
    The earliest arrival date of a part order in the work order time zone.
  • Title: Latest Part Order Arrival Date in UTC
    Read Only: true
    The latest arrival date of a part order in UTC.
  • Title: Latest Part Order Arrival Date
    Read Only: true
    The latest arrival date of a part order in the work order time zone.
  • Title: Total Open Part Orders
    Read Only: true
    The total number of open part orders.
  • Title: Total Shipped Part Orders
    Read Only: true
    The total number of shipped part orders.
  • Title: Total Part Orders
    Read Only: true
    The total number of part orders.
  • Title: Reschedule Reason
    Maximum Length: 256
    The reason for rescheduling the work order.
  • Title: Resolution Due
    The date and time when the work order or the service request is expected to be resolved. This value is based on the customer's service level agreement milestone, or is manually set.
  • Title: Resolution Due in Local Time Zone
    Read Only: true
    The date and time, in the customer's time zone, when the work order or the service request is expected to be resolved. This value is based on the customer's service level agreement milestone, or is manually set.
  • Title: Scheduled Date
    The date when the service is scheduled to be performed.
  • Title: Scheduled Date and End Time
    The scheduled date and end time for the work order.
  • Title: Scheduled Date and Start Time
    The scheduled date and start time for the work order.
  • Title: Scheduled
    Read Only: true
    Maximum Length: 255
    The combined scheduled date and time slot for the service to be scheduled. For example, May 31, 2018 1:00 - 3:00 PM.
  • Title: Scheduled Time Slot
    Maximum Length: 40
    The time slot when the service is scheduled to be performed.
  • Title: Service Profile ID
    The unique identifier of the service profile associated with the customer work order.
  • Title: Service Profile Name
    Read Only: true
    Maximum Length: 400
    The name of the service profile associated with the customer work order.
  • Title: Service Profile Number
    Read Only: true
    Maximum Length: 30
    The PUID of the service profile associated with the customer work order.
  • Title: Source
    Maximum Length: 30
    The code indicating how the work order was created in the application, for example, Agent_UI, Customer_UI, API, and so on. A list of accepted values is defined in the lookup type ORA_SVC_SOURCE_CD.
  • Title: Service Request ID
    The unique identifier of the service request associated to the work order.
  • Title: Service Request
    Maximum Length: 30
    The alternate key identifier of the service request associated with the work order.
  • Title: State
    Maximum Length: 60
    The state where the service will be performed.
  • Title: Stripe Code
    Read Only: true
    Maximum Length: 30
    The code indicating the application stripe of the work order.
  • Title: Time Zone
    Maximum Length: 64
    The time zone where the service will be performed.
  • Title: Time Zone Long Name
    Read Only: true
    Indicates the long name of the time zone on the work order.
  • Title: Title
    Maximum Length: 400
    The label displaying the title of a work order.
  • Title: Travel Time
    The time in minutes from Oracle Field Service Cloud for the field service agent to travel from a previous activity location to the current activity location.
  • Title: Trigger Update Event
    Maximum Length: 80
    Indicates a work order related object has been updated and used to trigger an update event for the work order to allow updates to flow through an OIC flow.
  • Title: Enable Cancel Process
    Read Only: true
    Maximum Length: 1
    The field label for the enable cancel process which enables the process to cancel part orders on a work order that is canceled.
  • Title: Work Order Area
    Maximum Length: 256
    The location where the service will be performed. For integration with Oracle Field Service Cloud, this value is defined and populated through point to point integration.
  • Title: Work Order ID
    Read Only: true
    The unique identifier of the work order record, generated during a create action.
  • Title: Integration Category
    Read Only: true
    The calculated field based on integration field to identify the work order is associated to either an external application or internal with no association.
  • Title: Integration
    Maximum Length: 30
    The application association of the work order. For example, if the work order is associated to an activity in Oracle Field Service Cloud, this field will contain a code identifying it as a work order integrated with Oracle Field Service Cloud.
  • Title: Integration
    Read Only: true
    The application association of the work order. For example, if the work order is associated to an activity in Oracle Field Service Cloud, this field will contain a code identifying it as a work order integrated with Oracle Field Service Cloud.
  • Title: Work Order Integration Message Code
    Maximum Length: 30
    The code indicating the integration message to be used to share information about the most recent integration event for the work order with end users. A list of accepted values is defined in the lookup type ORA_SVC_WO_INT_MSG_CD. You can review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Integration Messages.
  • Title: Work Order Integration Message Code
    Read Only: true
    Maximum Length: 30
    The display value for the work order integration message code.
  • Title: Work Order Integration Status Code
    Maximum Length: 30
    The code indicating the integration status of the most recent integration event for the work order. A list of accepted values is defined in the lookup type ORA_SVC_WO_INT_STATUS_CD.
  • Title: Work Order Integration Status
    Read Only: true
    Maximum Length: 30
    The display value for the work order integration status code.
  • Links
  • Title: Reference Number
    Read Only: true
    Maximum Length: 30
    The alternate unique identifier of the work order. This value is system-generated, and is configured in the work order profile options SVC_WO_NUMBER PREFIX and SVC_WO_NUMBER_FORMAT. The default configuration is WO0000000000.
  • Title: Has Child Work Orders
    Read Only: true
    Indicates a work order has child work orders.
  • Title: Work Order Parent ID
    The ID of the parent work order. This is a foreign key reference to SVC_WORK_ORDERS (WO_ID).
  • Title: Parent Work Order Reference Number
    Read Only: true
    The unique work order reference number of the parent work order.
  • Title: Record Type
    Maximum Length: 60
    The type of the work order such as regular, multiday work order, or multiday work order segment.
  • Title: Status Category
    Read Only: true
    Maximum Length: 30
    Indicates the current life cycle status of the work order such as Open, Closed, or Canceled.
  • Title: Status
    Maximum Length: 30
    The code indicating the status of the work order, for example, Submitted, Scheduled, Started, Complete, Suspended, Canceled, and so on. A list of accepted values is defined in the lookup type ORA_SVC_WO_STATUS_CD. You can review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Work Order Statuses.
  • Title: Status
    Read Only: true
    The display value for the work order status code.
  • Title: Status LOV
    Read Only: true
    The list of values used when selecting the work order status.
  • Title: Status ID
    The ID for the work order status selected on the work order.
  • Title: Type Code
    Read Only: true
    The code indicating the type of service to be performed for a work order. A list of accepted values is defined in the lookup type ORA_SVC_WO_TYPE_CD. You can review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Work Order Types.
  • Title: Type
    Read Only: true
    The display value for the work order type code.
  • Title: Type
    The unique identifier of the type of the work order. This value is required when creating a work order.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : customerWorkOrders-Attachment-item-response
Type: object
Show Source
Links
AccountPickerLOV
The list of values indicating the names of the customer accounts associated with the work order.

The following properties are defined on the LOV link relation:
  • Source Attribute: AccountPartyName; Target Attribute: PartyUniqueName
  • Display Attribute: PartyUniqueName, PartyNumber
ActiveAssetLOV
The list of values indicating the assets.

The following properties are defined on the LOV link relation:
  • Source Attribute: PrimaryAssetId; Target Attribute: AssetId
  • Display Attribute: AssetId, AssetName, AssetNumber, AssetTag, Description
Attachment
Parameters:
  • WoNumber: $request.path.WoNumber
The attachments resource is used to view, create, and update attachments.
PartnerPickerLOV
The list of values indicating the names of the partner accounts associated with the work order

The following properties are defined on the LOV link relation:
  • Source Attribute: PartnerAccountName; Target Attribute: PartyUniqueName
  • Display Attribute: PartyUniqueName, PartyNumber
PersonPartyLOV
The following properties are defined on the LOV link relation:
  • Source Attribute: ContactName; Target Attribute: PartyName
  • Display Attribute: PartyName, PrimaryEmailAddress, PartyNumber
ResourcePickerLOV
The list of values indicating the names of the work order assignees.

The following properties are defined on the LOV link relation:
  • Source Attribute: AssigneePersonName; Target Attribute: PartyName
  • Display Attribute: PartyName, EmailAddress
ServiceRequestLOV
The list of values indicating the service request numbers.

The following properties are defined on the LOV link relation:
  • Source Attribute: SrNumber; Target Attribute: SrNumber
  • Display Attribute: SrNumber, Title
WoIntegrationCdLookupLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_WO_INT_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: WoIntegrationCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
WoIntegrationStatusCdLookupVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_WO_INT_STATUS_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: WoIntegrationStatusCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
WoIntegrationWoTypesLOV
Parameters:
  • finder: ByWoIntegrationCdFinder%3BBindWoIntegrationCd%3D{WoIntegrationCd}
The following properties are defined on the LOV link relation:
  • Source Attribute: WoTypeId; Target Attribute: WoTypeIdPK
  • Display Attribute: Meaning
WoLink
Parameters:
  • WoNumber: $request.path.WoNumber
The work order link resource is used to view, create, and delete a customer work order link. A work order link is a transactional record, which is created when a customer needs to define a relationship between field service work orders.
WoStatusCodesLOV
Parameters:
  • finder: ByWoIntegrationCdFinder%3BBindWoIntegrationCd%3D{WoIntegrationCd}
The following properties are defined on the LOV link relation:
  • Source Attribute: WoStatusCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
getAccessSchedulePayload
Parameters:
  • WoNumber: $request.path.WoNumber
The method gets the access schedule payload to be used when querying for scheduler data.
submitCancelPartsLines
Parameters:
  • WoNumber: $request.path.WoNumber
Back to Top

Examples

The following example shows how to update a work order with a parent service request by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/customerWorkOrders/0000030023

Example of Request Body

The following example shows the contents of the request body in JSON format.

{   
    "SrNumber": "SR0000138385"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.
{
    "WoId": 300100554499664,
    "CreationDate": "2022-05-09T21:29:15+00:00",
    "CreatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2022-05-09T21:51:31+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateLogin": "DE2A32B24CE12D52E0531C5CF00A51E3",
    "LastUpdateSourceCd": "ORA_SVC_API",
    "WoNumber": "0000030023",
    "Title": null,
    "WoTypeId": 300100206601356,
    "WoTypeCd": "SVR_MTN",
    "WoTypeCdMeaning": "Server Maintenance",
    "FsTypeCd": "65",
    "WoStatusMapId": 6,
    "WoStatusCd": "ORA_SVC_WO_PENDING",
    "WoStatusCdMeaning": "Scheduled",
    "WoIntegrationCd": "ORA_WO_INT_OFSC",
    "WoIntegrationCdMeaning": "Oracle Field Service Cloud",
    "WoIntegrationCatCdMeaning": "External",
    "WoIntegrationMsgCd": "ORA_WO_INT_MSG_UPDATE_SUB",
    "WoIntegrationStatusCd": "ORA_WO_INT_UPDATE_SUBMITTED",
    "SourceCd": "ORA_SVC_API",
    "SrId": 300100554495253,
    "OpportunityId": null,
    "PrimaryAssetId": null,
    "PrimaryAssetNumber": null,
    "PrimaryAssetName": null,
    "PrimaryAssetSerialNumber": null,
    "PrimaryAssetTag": null,
    "PrimaryAssetStartDate": null,
    "PrimaryAssetEndDate": null,
    "PrimaryAssetInstallDate": null,
    "PrimaryAssetPurchaseDate": null,
    "PrimaryAssetStatusCode": null,
    "PrimaryAssetQuantity": null,
    "PrimaryAssetDescription": null,
    "PrimaryAssetUOMCode": null,
    "PrimaryAssetProduct": null,
    "IBAssetId": null,
    "IBAssetTag": null,
    "IBAssetDescription": null,
    "IBAssetNumber": null,
    "IBAssetSerialNumber": null,
    "IBAssetEndDate": null,
    "IBAssetStartDate": null,
    "IBAssetPurchaseDate": null,
    "IBAssetQuantity": null,
    "IBAssetStatusCode": null,
    "IBAssetUOMCode": null,
    "IBAssetInstalledDate": null,
    "IBAssetItemNumber": null,
    "IBAssetItemDescription": null,
    "IBAssetActiveFlag": "true",
    "RequestedByPartyId": 100010025532672,
    "AssigneeResourceId": 100010025532672,
    "AssigneePersonName": "Gabrielle   Lee",
    "AssigneeEmail": "sendmail-test-discard@oracle.com",
    "AssigneePhoneNumber": "+1 (650) 506-6601",
    "AccountPartyId": null,
    "AccountPartyName": null,
    "AccountStatus": null,
    "PartnerAccountPartyId": null,
    "PartnerAccountName": null,
    "PartnerAccountPartyType": null,
    "PartnerAccountStatus": null,
    "OwnerTypeCd": "ORA_SVC_CUSTOMER",
    "ContactPartyId": 300100126721684,
    "ContactPartyNumber": "CDRM_721532",
    "ContactStatus": "A",
    "ContactPartyFirstName": "Bob",
    "ContactPartyLastName": "kohli",
    "ContactNameLovSwitcher": "LOV_SrContactMemberName",
    "ContactName": null,
    "ContactEmail": null,
    "ContactPhoneNumber": "+1 (122)12312312",
    "ContactAltPhoneNumber": null,
    "ContactLanguageCode": null,
    "ContactPartySiteId": null,
    "Address1": "1 Main Street",
    "Address2": "Suite 500",
    "Address3": null,
    "Address4": null,
    "City": "DENVER",
    "County": null,
    "PostalCode": "80202",
    "State": "CO",
    "Province": null,
    "Country": "US",
    "TimezoneCode": "America/Denver",
    "TimezoneLongName": "(UTC-07:00) Denver - Mountain Time (MT)",
    "WoArea": "South Denver",
    "CaseNote": "hello",
    "Duration": 60,
    "ReminderTime": null,
    "ResolutionDueDate": null,
    "ResolutionDueDateLocal": null,
    "RequestedDate": "2022-05-30",
    "RequestedTimeSlot": "13-15",
    "RequestedDateStartTime": null,
    "RequestedDateEndTime": null,
    "RequestedTime": "5/29/22 13-15",
    "ScheduledDate": "2022-05-30",
    "ScheduledTimeSlot": "13-15",
    "ScheduledTime": "2022-05-30 13-15",
    "ScheduledDateStartTime": "2022-05-30T19:00:00+00:00",
    "ScheduledDateEndTime": "2022-05-30T21:00:00+00:00",
    "FsActivityId": 561,
    "FsErrorDetail": null,
    "FsNote": null,
    "FsResource": null,
    "FsResourceExternalId": null,
    "FsContactFlag": false,
    "TravelTime": null,
    "BookedDate": null,
    "ActualStartDate": null,
    "ActualEndDate": null,
    "DeliveryWinStartDate": null,
    "DeliveryWinEndDate": null,
    "EstimatedArrivalTime": "",
    "EstimatedStartDate": null,
    "CancelReason": null,
    "RescheduleReason": null,
    "DeletedFlag": false,
    "StripeCd": "ORA_SVC_CRM",
    "FormattedAddress": null,
    "SrNumber": "SR0000138385",
    "WoIntegrationMsgCdDisp": "ORA_WO_INT_MSG_UPDATE_SUB",
    "WoIntegrationStatusCdDisp": "ORA_WO_INT_UPDATE_SUBMITTED",
    "AddressId": null,
    "FieldServiceResourceId": null,
    "FieldServiceResourceEmail": null,
    "FieldServiceResourcePhoneNumber": null,
    "FieldServiceResourcePersonName": null,
    "BUOrgName": "Vision Operations",
    "EditModeFlag": "false",
    "WoStatusCatCd": "ORA_SVC_WO_CAT_OPEN",
    "UseCancelProcessFlag": null,
    "WoStatusesLOVSwitcher": "LOV_WoStatusesByIntegration",
    "RequirementCancelledLines": 0,
    "RequirementOpenLines": 0,
    "RequirementShippedLines": "0",
    "RequirementTotalLines": 0,
    "RequirementCancellableLines": 0,
    "RequirementEarliestArrivalDate": null,
    "RequirementLatestArrivalDate": null,
    "RequirementEarliestArrivalDateLocal": null,
    "RequirementLatestArrivalDateLocal": null,
    "FsSchedResource": null,
    "FsSchedResourceExternalId": null,
    "InventoryItemId": null,
    "InventoryOrgId": null,
    "ProductItemDescription": null,
    "ProdGroupId": null,
    "ProdGroupName": null,
    "WoParentId": null,
    "WoParentFlag": "false",
    "WoParentNumber": null,
    "FsTechnicianLocatorUrl": "https://w.fs.etadirect.com/rx3Gv37Z",
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/customerWorkOrders/0000030023",
            "name": "customerWorkOrders",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
            }
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/customerWorkOrders/0000030023",
            "name": "customerWorkOrders",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/customerWorkOrders/0000030023/child/Attachment",
            "name": "Attachment",
            "kind": "collection"
        }
    ]
}
Back to Top