Get all work orders
get
/crmRestApi/resources/11.13.18.05/customerWorkOrders
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a work order with the specified work order identifier.
Finder Variables:- WoId; integer.
- WorkOrderByNumberFinder: Finds a work order with the specified work order number.
Finder Variables:- WoNumber; string.
- WorkOrdersByStripeCdFinder: Finds a work order with the specified stripe code.
Finder Variables:- StripeCd; string.
- PrimaryKey: Finds a work order with the specified work order identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountPartyName; string; The name of the customer account associated with the work order.
- AccountPartyNameNonUnique; string; The alternate name of the customer account associated with the work order.
- AccountPartyNumber; string; The PUID of the account party associated with the customer work order.
- ActualEndDate; string; 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.
- ActualStartDate; string; The actual start date and time of the work at the customer location. This value is updated through integration after the service is started.
- AddressId; integer; The unique identifier of the address where the service will be performed.
- AddressSource; string; The source field to which the service address is associated to such as account, contact, service profile, asset, or a one-time address.
- AddressSourceCd; string; The lookup code of the source of the address.
- AssigneeEmail; string; The email of the resource assigned to the work order.
- AssigneePersonName; string; The name of the resource assigned to the work order.
- BUOrgId; integer; The unique identifier of the service business unit associated with the customer work order.
- BUOrgName; string; The name of the business unit associated with the work order.
- BillToCustAccountId; integer; The customer account to be billed for the work order.
- BillToCustAccountSiteId; integer; The customer account site to be billed for the work order.
- BillToCustId; integer; The customer to be billed for the work order.
- BillToCustPartySiteId; integer; The party site to be billed for the work order.
- BillToCustomerAccountName; string; The bill-to customer account name.
- BillToCustomerAccountNumber; string; The account number to be billed for the work order.
- BillToPartyName; string; The name of the customer to be billed for the work order.
- BillToPartyNumber; string; The PUID of the customer account to be billed for the work order.
- BillToPartySiteFormattedAddress; string; The formatted address of the party site to be billed for the work order.
- BillToPartySiteLocationId; integer; The location identifier of the party site to be billed for the work order.
- BillToPartySiteName; string; The name of the party site to be billed for the work order.
- BillToPartySiteNumber; string; The PUID of the party site to be billed for the work order.
- BillToPartyUniqueName; string; The unique name of the customer to be billed for the work order.
- BookedDate; string; The date and time when the Field Service Cloud activity was booked.
- City; string; The city where the service will be performed.
- ContactAltPhoneNumber; string; The alternate phone number of the contact for whom the service will be performed.
- ContactEmail; string; The email of the contact for whom the service will be performed.
- ContactName; string; The name of the contact for whom the service will be performed.
- ContactPartySiteId; integer; The contact party site ID of the work order address where the service will be performed.
- ContactPhoneNumber; string; The primary phone number of the contact for whom the service will be performed.
- Country; string; The country where the service will be performed.
- County; string; The county where the service will be performed.
- CreatedBy; string; The user who created the work order.
- CreationDate; string; The date and time when the work order is created.
- EstimatedStartDate; string; The estimated arrival date of the field service technician at the service location. This value is updated from Oracle Field Service Cloud.
- FieldServiceResourceEmail; string; The email of the field service resource assigned to complete the work order.
- FieldServiceResourceId; integer; The unique identifier of the field service resource assigned to the work order.
- FieldServiceResourcePersonName; string; The name of the field service resource assigned to complete the work order.
- FsActivityId; integer; The unique identifier of the corresponding activity in Oracle Field Service Cloud.
- FsResource; string; The name of the field service resource assigned to the work order.
- FsResourceExternalId; string; The external ID of the resource being used to complete this work order.
- FsSchedResource; string; The scheduled resource being used to complete the work order.
- FsSchedResourceExternalId; string; The external ID of the scheduled resource being used to complete the work order.
- FsTechnicianLocatorUrl; string; The URL used to track the location of the technician.
- FsTypeCd; string; 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.
- IBAssetActiveFlag; boolean; The active status of the installed base asset attached to the work order.
- IBAssetDescription; string; The description of the installed base asset attached to the work order.
- IBAssetId; integer; The ID of the installed base asset attached to the work order.
- IBAssetNumber; string; The number of the installed base asset attached to the work order.
- IBAssetSerialNumber; string; The serial number of the installed base asset attached to the work order.
- InventoryItemId; integer; The unique identifier of the product associated with the work order.
- InventoryOrgId; integer; The unique identifier of the organization of the product that is associated with the work order.
- LastUpdateDate; string; The date and time when the work order was last updated.
- LastUpdateSourceCd; string; The source who last updated the work order.
- LastUpdatedBy; string; The user who last updated the work order.
- OwnerTypeCd; string; 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.
- PostalCode; string; The postal code of the area where the service will be performed.
- PrimaryAssetNumber; string; The alternate key identifier of the primary asset associated with the work order.
- PrimaryAssetSerialNumber; string; The serial number of the primary asset associated with the work order.
- ProdGroupId; integer; The unique identifier of the product group associated with the work order.
- Province; string; The province where the service will be performed.
- RequestedDate; string; The date when the service to be scheduled, as requested by the customer.
- RequestedDateEndTime; string; The requested date and end time for the work order.
- RequestedDateStartTime; string; The requested date and start time for the work order.
- RequestedTimeSlot; string; The time slot requested by the customer for the service to be scheduled.
- ResolutionDueDate; string; 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.
- ScheduledDate; string; The date when the service is scheduled to be performed.
- ScheduledDateEndTime; string; The scheduled date and end time for the work order.
- ScheduledDateStartTime; string; The scheduled date and start time for the work order.
- ScheduledTimeSlot; string; The time slot when the service is scheduled to be performed.
- ServiceProfileId; integer; The unique identifier of the service profile associated with the customer work order.
- ServiceProfileName; string; The name of the service profile associated with the customer work order.
- ServiceProfileNumber; string; The PUID of the service profile associated with the customer work order.
- SourceCd; string; 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.
- SrId; integer; The unique identifier of the service request associated to the work order.
- SrNumber; string; The alternate key identifier of the service request associated with the work order.
- State; string; The state where the service will be performed.
- Title; string; The label displaying the title of a work order.
- UseCancelProcessFlag; boolean; The field label for the enable cancel process which enables the process to cancel part orders on a work order that is canceled.
- WoArea; string; 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.
- WoId; integer; The unique identifier of the work order record, generated during a create action.
- WoIntegrationCd; string; 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.
- WoIntegrationMsgCd; string; 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.
- WoIntegrationMsgCdDisp; string; The display value for the work order integration message code.
- WoIntegrationStatusCd; string; 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.
- WoIntegrationStatusCdDisp; string; The display value for the work order integration status code.
- WoNumber; string; 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.
- WoParentId; integer; The ID of the parent work order. This is a foreign key reference to SVC_WORK_ORDERS (WO_ID).
- WoRecordType; string; The type of the work order such as regular, multiday work order, or multiday work order segment.
- WoStatusCatCd; string; Indicates the current life cycle status of the work order such as Open, Closed, or Canceled.
- WoStatusCd; string; 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : customerWorkOrders
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : customerWorkOrders-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account party associated with the work order. -
AccountPartyName: string
Title:
Account
Maximum Length:900
The name of the customer account associated with the work order. -
AccountPartyNameNonUnique: string
Title:
Account Name
Read Only:true
Maximum Length:360
The alternate name of the customer account associated with the work order. -
AccountPartyNumber: string
Title:
Account Party Number
Read Only:true
Maximum Length:30
The PUID of the account party associated with the customer work order. -
AccountStatus: string
Title:
Account Status
Read Only:true
Maximum Length:1
The status of the account associated with the work order. -
ActualEndDate: string
(date-time)
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. -
ActualStartDate: string
(date-time)
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. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address where the service will be performed. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address where the service will be performed. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address where the service will be performed. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address where the service will be performed. -
AddressId: integer
(int64)
Title:
Address ID
The unique identifier of the address where the service will be performed. -
AddressSource: string
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. -
AddressSourceCd: string
Title:
Address Source Code
Maximum Length:30
The lookup code of the source of the address. -
AssigneeEmail: string
Title:
Assigned to Email
Read Only:true
Maximum Length:320
The email of the resource assigned to the work order. -
AssigneePersonName: string
Title:
Assigned To
Maximum Length:360
The name of the resource assigned to the work order. -
AssigneePhoneNumber: string
Title:
Assigned to Phone
Read Only:true
The phone number of the resource assigned to the work order. -
AssigneeResourceId: integer
(int64)
Title:
Assigned to ID
The unique identifier of the resource assigned to the work order. -
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BillToCustAccountId: integer
(int64)
Title:
Bill-To Customer Account ID
The customer account to be billed for the work order. -
BillToCustAccountSiteId: integer
(int64)
Title:
Bill-To Customer Account Site ID
The customer account site to be billed for the work order. -
BillToCustId: integer
(int64)
Title:
Bill-To Customer ID
The customer to be billed for the work order. -
BillToCustomerAccountName: string
Title:
Bill-To Customer Account Name
Read Only:true
Maximum Length:240
The bill-to customer account name. -
BillToCustomerAccountNumber: string
Title:
Bill-To Customer Account Number
Read Only:true
Maximum Length:30
The account number to be billed for the work order. -
BillToCustPartySiteId: integer
(int64)
Title:
Bill-To Customer Site ID
The party site to be billed for the work order. -
BillToPartyName: string
Title:
Bill-To Customer Name
Read Only:true
Maximum Length:360
The name of the customer to be billed for the work order. -
BillToPartyNumber: string
Title:
Bill-To Customer Number
Read Only:true
Maximum Length:30
The PUID of the customer account to be billed for the work order. -
BillToPartySiteFormattedAddress: string
Title:
Bill-To Address
Read Only:true
Maximum Length:5000
The formatted address of the party site to be billed for the work order. -
BillToPartySiteLocationId: integer
(int64)
Title:
Bill-To Customer Site Location ID
Read Only:true
The location identifier of the party site to be billed for the work order. -
BillToPartySiteName: string
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. -
BillToPartySiteNumber: string
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. -
BillToPartyUniqueName: string
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. -
BookedDate: string
(date-time)
Title:
Booked Date
The date and time when the Field Service Cloud activity was booked. -
BUOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the service business unit associated with the customer work order. -
BUOrgName: string
Title:
Business Unit Name
Read Only:true
The name of the business unit associated with the work order. -
CancelReason: string
Title:
Cancel Reason
Maximum Length:256
The reason for cancelling the work order. -
CaseNote: string
Title:
Case Note
Maximum Length:65535
The additional information captured to share with the field service resource assigned to the work order. -
City: string
Title:
City
Maximum Length:60
The city where the service will be performed. -
ContactAltPhoneNumber: string
Title:
Other Phone
Maximum Length:240
The alternate phone number of the contact for whom the service will be performed. -
ContactEmail: string
Title:
Email
Maximum Length:320
The email of the contact for whom the service will be performed. -
ContactLanguageCode: string
Title:
Contact Language
Read Only:true
Maximum Length:4
The language spoken by the contact for whom the service will be performed. -
ContactName: string
Title:
Contact Name
Maximum Length:420
The name of the contact for whom the service will be performed. -
ContactNameLovSwitcher: string
Title:
Contact LOV
Read Only:true
The LOV switcher for the name of the contact for whom the service will be performed. -
ContactPartyFirstName: string
Title:
Contact First Name
Read Only:true
Maximum Length:150
The first name of the contact for whom the service will be performed. -
ContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact for whom the service will be performed. -
ContactPartyLastName: string
Title:
Contact Last Name
Read Only:true
Maximum Length:150
The last name of the contact for whom the service will be performed. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The public unique identifier of the customer for whom the service is to be performed. -
ContactPartySiteId: integer
(int64)
Title:
Contact Party Site ID
The contact party site ID of the work order address where the service will be performed. -
ContactPhoneNumber: string
Title:
Phone
Maximum Length:240
The primary phone number of the contact for whom the service will be performed. -
ContactStatus: string
Title:
Contact Status
Read Only:true
Maximum Length:1
The status of the contact for whom the service will be performed. -
Country: string
Title:
Country
Maximum Length:2
The country where the service will be performed. -
County: string
Title:
County
Maximum Length:60
The county where the service will be performed. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the work order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the work order is created. -
DeletedFlag: boolean
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. -
DeliveryWinEndDate: string
(date-time)
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. -
DeliveryWinStartDate: string
(date-time)
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. -
Duration: integer
(int32)
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. -
EditModeFlag: boolean
Title:
Editable
Read Only:true
Indicates whether the work order is read-only or editable. -
EstimatedArrivalTime: string
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. -
EstimatedStartDate: string
(date-time)
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. -
FieldServiceResourceEmail: string
Title:
Field Service Resource Email
Read Only:true
Maximum Length:320
The email of the field service resource assigned to complete the work order. -
FieldServiceResourceId: integer
(int64)
Title:
Field Service Resource ID
The unique identifier of the field service resource assigned to the work order. -
FieldServiceResourcePersonName: string
Title:
Field Service Resource
Read Only:true
Maximum Length:360
The name of the field service resource assigned to complete the work order. -
FieldServiceResourcePhoneNumber: string
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. -
FormattedAddress: string
Title:
Address
The formatted address where the service will be performed. -
FsActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the corresponding activity in Oracle Field Service Cloud. -
FsContactFlag: boolean
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. -
FsErrorDetail: string
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. -
FsNote: string
Title:
Field Service Note
Maximum Length:65535
The information added to the work order from Oracle Field Service Cloud activity integration. -
FsResource: string
Title:
Resource
Maximum Length:256
The name of the field service resource assigned to the work order. -
FsResourceExternalId: string
Title:
Resource External ID
Maximum Length:32
The external ID of the resource being used to complete this work order. -
FsSchedResource: string
Title:
Scheduled Resource
Maximum Length:256
The scheduled resource being used to complete the work order. -
FsSchedResourceExternalId: string
Title:
Scheduled Resource External ID
Maximum Length:32
The external ID of the scheduled resource being used to complete the work order. -
FsTechnicianLocatorUrl: string
Title:
Oracle Field Service Technician Locator URL
Maximum Length:2000
The URL used to track the location of the technician. -
FsTypeCd: string
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. -
IBAssetActiveFlag: boolean
Title:
Installed Base Asset Active Status
Read Only:true
The active status of the installed base asset attached to the work order. -
IBAssetDescription: string
Title:
Installed Base Asset Description
Read Only:true
Maximum Length:240
The description of the installed base asset attached to the work order. -
IBAssetEndDate: string
(date-time)
Title:
Installed Base Asset End Date
Read Only:true
The end date of the installed base asset attached to the work order. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset ID
The ID of the installed base asset attached to the work order. -
IBAssetInstalledDate: string
(date)
Title:
Installed Base Asset Installed Date
Read Only:true
The install date of the installed base asset attached to the work order. -
IBAssetItemDescription: string
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. -
IBAssetItemNumber: string
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. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
The number of the installed base asset attached to the work order. -
IBAssetPurchaseDate: string
(date)
Title:
Installed Base Asset Purchase Date
Read Only:true
The purchase date of the installed base asset attached to the work order. -
IBAssetQuantity: number
Title:
Installed Base Asset Quantity
Read Only:true
The quantity of the installed base asset attached to the work order. -
IBAssetSerialNumber: string
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. -
IBAssetStartDate: string
(date-time)
Title:
Installed Base Asset Start Date
Read Only:true
The start date of the installed base asset attached to the work order. -
IBAssetStatusCode: string
Title:
Installed Base Asset Status
Read Only:true
Maximum Length:30
The status of the installed base asset attached to the work order. -
IBAssetTag: string
Title:
Installed Base Asset Tag
Read Only:true
Maximum Length:240
The tag of the installed base asset attached to the work order. -
IBAssetUOMCode: string
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. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the product associated with the work order. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization of the product that is associated with the work order. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the work order was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the work order. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the work order. -
LastUpdateSourceCd: string
Title:
Last Updated by Source
Maximum Length:30
The source who last updated the work order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity associated with the work order. -
OwnerTypeCd: string
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. -
PartnerAccountName: string
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. -
PartnerAccountPartyId: integer
(int64)
Title:
Partner Account ID
The unique identifier of the partner account associated with the work order. -
PartnerAccountPartyType: string
Title:
Partner Account Type
Read Only:true
Maximum Length:30
The type of sales channel associated with the partner. -
PartnerAccountStatus: string
Title:
Partner Account Status
Read Only:true
The status of the partner account associated with the work order. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the area where the service will be performed. -
PrimaryAssetDescription: string
Title:
Primary Asset Description
Read Only:true
Maximum Length:2000
The description of the primary asset associated with the work order. -
PrimaryAssetEndDate: string
(date)
Title:
Primary Asset End Date
Read Only:true
The date after which the primary asset will no longer be active. -
PrimaryAssetId: integer
(int64)
Title:
Primary Asset ID
The unique identifier of the primary asset associated with the work order. -
PrimaryAssetInstallDate: string
(date)
Title:
Primary Asset Install Date
Read Only:true
The date when the primary asset was installed. -
PrimaryAssetName: string
Title:
Primary Asset
Read Only:true
Maximum Length:300
The name of the primary asset associated with the work order. -
PrimaryAssetNumber: string
Title:
Primary Asset Number
Read Only:true
Maximum Length:100
The alternate key identifier of the primary asset associated with the work order. -
PrimaryAssetProduct: string
Title:
Primary Asset Product Name
Read Only:true
Maximum Length:255
The name of the product associated with the primary asset. -
PrimaryAssetPurchaseDate: string
(date)
Title:
Primary Asset Purchase Date
Read Only:true
The date when the primary asset was purchased. -
PrimaryAssetQuantity: number
Title:
Primary Asset Quantity
Read Only:true
The quantity of the work order primary asset. -
PrimaryAssetSerialNumber: string
Title:
Primary Asset Serial Number
Read Only:true
Maximum Length:100
The serial number of the primary asset associated with the work order. -
PrimaryAssetStartDate: string
(date)
Title:
Primary Asset Start Date
Read Only:true
The date when the primary asset became active. -
PrimaryAssetStatusCode: string
Title:
Primary Asset Status Code
Read Only:true
Maximum Length:50
The code indicating the status of the work order primary asset. -
PrimaryAssetTag: string
Title:
Primary Asset Tag
Read Only:true
Maximum Length:50
The tag of the primary asset associated with the work order. -
PrimaryAssetUOMCode: string
Title:
Primary Asset UOM
Read Only:true
Maximum Length:3
The unit of measure associated with the primary asset. -
ProdGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group associated with the work order. -
ProdGroupName: string
Title:
Product Group
Maximum Length:255
The product group on the work order. -
ProductItemDescription: string
Title:
Product Description
Maximum Length:255
The product description on the work order. -
Province: string
Title:
Province
Maximum Length:60
The province where the service will be performed. -
ReminderTime: integer
(int32)
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. -
RequestedByPartyId: integer
(int64)
Title:
Requested By
The unique identifier of the resource that requested the work order be created. -
RequestedDate: string
(date)
Title:
Requested Date
The date when the service to be scheduled, as requested by the customer. -
RequestedDateEndTime: string
(date-time)
Title:
Requested Date and End Time
The requested date and end time for the work order. -
RequestedDateStartTime: string
(date-time)
Title:
Requested Date and Start Time
The requested date and start time for the work order. -
RequestedTime: string
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. -
RequestedTimeSlot: string
Title:
Requested Time Slot
Maximum Length:40
The time slot requested by the customer for the service to be scheduled. -
RequirementCancellableLines: integer
Title:
Total Cancelable Part Orders
Read Only:true
The total number of parts orders that are cancelable. -
RequirementCancelledLines: integer
Title:
Total Canceled Part Orders
Read Only:true
The total number of canceled part orders. -
RequirementEarliestArrivalDate: string
(date-time)
Title:
Earliest Part Order Arrival Date in UTC
Read Only:true
The earliest arrival date of a part order in UTC. -
RequirementEarliestArrivalDateLocal: string
(date-time)
Title:
Earliest Part Order Arrival Date
Read Only:true
The earliest arrival date of a part order in the work order time zone. -
RequirementLatestArrivalDate: string
(date-time)
Title:
Latest Part Order Arrival Date in UTC
Read Only:true
The latest arrival date of a part order in UTC. -
RequirementLatestArrivalDateLocal: string
(date-time)
Title:
Latest Part Order Arrival Date
Read Only:true
The latest arrival date of a part order in the work order time zone. -
RequirementOpenLines: integer
Title:
Total Open Part Orders
Read Only:true
The total number of open part orders. -
RequirementShippedLines: string
Title:
Total Shipped Part Orders
Read Only:true
The total number of shipped part orders. -
RequirementTotalLines: integer
Title:
Total Part Orders
Read Only:true
The total number of part orders. -
RescheduleReason: string
Title:
Reschedule Reason
Maximum Length:256
The reason for rescheduling the work order. -
ResolutionDueDate: string
(date-time)
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. -
ResolutionDueDateLocal: string
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. -
ScheduledDate: string
(date)
Title:
Scheduled Date
The date when the service is scheduled to be performed. -
ScheduledDateEndTime: string
(date-time)
Title:
Scheduled Date and End Time
The scheduled date and end time for the work order. -
ScheduledDateStartTime: string
(date-time)
Title:
Scheduled Date and Start Time
The scheduled date and start time for the work order. -
ScheduledTime: string
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. -
ScheduledTimeSlot: string
Title:
Scheduled Time Slot
Maximum Length:40
The time slot when the service is scheduled to be performed. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
The unique identifier of the service profile associated with the customer work order. -
ServiceProfileName: string
Title:
Service Profile Name
Read Only:true
Maximum Length:400
The name of the service profile associated with the customer work order. -
ServiceProfileNumber: string
Title:
Service Profile Number
Read Only:true
Maximum Length:30
The PUID of the service profile associated with the customer work order. -
SourceCd: string
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. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request associated to the work order. -
SrNumber: string
Title:
Service Request
Maximum Length:30
The alternate key identifier of the service request associated with the work order. -
State: string
Title:
State
Maximum Length:60
The state where the service will be performed. -
StripeCd: string
Title:
Stripe Code
Read Only:true
Maximum Length:30
The code indicating the application stripe of the work order. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone where the service will be performed. -
TimezoneLongName: string
Title:
Time Zone Long Name
Read Only:true
Indicates the long name of the time zone on the work order. -
Title: string
Title:
Title
Maximum Length:400
The label displaying the title of a work order. -
TravelTime: integer
(int32)
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. -
TriggerUpdateEvent: string
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. -
UseCancelProcessFlag: boolean
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. -
WoArea: string
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. -
WoId: integer
(int64)
Title:
Work Order ID
Read Only:true
The unique identifier of the work order record, generated during a create action. -
WoIntegrationCatCdMeaning: string
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. -
WoIntegrationCd: string
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. -
WoIntegrationCdMeaning: string
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. -
WoIntegrationMsgCd: string
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. -
WoIntegrationMsgCdDisp: string
Title:
Work Order Integration Message Code
Read Only:true
Maximum Length:30
The display value for the work order integration message code. -
WoIntegrationStatusCd: string
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. -
WoIntegrationStatusCdDisp: string
Title:
Work Order Integration Status
Read Only:true
Maximum Length:30
The display value for the work order integration status code. -
WoLink: array
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. -
WoNumber: string
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. -
WoParentFlag: boolean
Title:
Has Child Work Orders
Read Only:true
Indicates a work order has child work orders. -
WoParentId: integer
(int64)
Title:
Work Order Parent ID
The ID of the parent work order. This is a foreign key reference to SVC_WORK_ORDERS (WO_ID). -
WoParentNumber: string
Title:
Parent Work Order Reference Number
Read Only:true
The unique work order reference number of the parent work order. -
WoRecordType: string
Title:
Record Type
Maximum Length:60
The type of the work order such as regular, multiday work order, or multiday work order segment. -
WoStatusCatCd: string
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. -
WoStatusCd: string
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. -
WoStatusCdMeaning: string
Title:
Status
Read Only:true
The display value for the work order status code. -
WoStatusesLOVSwitcher: string
Title:
Status LOV
Read Only:true
The list of values used when selecting the work order status. -
WoStatusMapId: integer
(int64)
Title:
Status ID
The ID for the work order status selected on the work order. -
WoTypeCd: string
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. -
WoTypeCdMeaning: string
Title:
Type
Read Only:true
The display value for the work order type code. -
WoTypeId: integer
(int64)
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 link relations associated with the resource instance.
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-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique document ID of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating status of the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : customerWorkOrders-WoLink-item-response
Type:
Show Source
object
-
AssignmentConstraintCd: string
Title:
Assignment Constraints Code
Read Only:true
Maximum Length:30
The code that identifies the assignment constraint set on the link template. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the work order link. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of creating the work order link. -
FirstWoId: integer
(int64)
Title:
First Work Order ID
The unique identifier of the first work order in the link. -
FirstWoNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:30
Value that uniquely identifies the alternate unique identifier of the first 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. -
FirstWoScheduledDate: string
(date)
Title:
Scheduled Date
Read Only:true
The date when the scheduled service will be performed for the first work order. -
FirstWoScheduledTimeSlot: string
Title:
Scheduled Time Slot
Read Only:true
Maximum Length:40
The time slot to perform the scheduled service for the first work order. -
FirstWoStatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Indicates the work order status code for the first work order. -
FirstWoStatusCdMeaning: string
Title:
Status
Read Only:true
The meaning of the first work order status code. -
FirstWoTitle: string
Title:
Title
Read Only:true
Maximum Length:400
The title of the first work order. -
FsFirstActivityId: integer
(int64)
Title:
First Activity ID
The unique identifier of the corresponding first activity in Oracle Field Service Cloud for the work order activity. -
FsSecondActivityId: integer
(int64)
Title:
Second Activity ID
The unique identifier of the corresponding second activity in Oracle Field Service Cloud for the work order activity. -
LastUpdateDate: string
(date-time)
Title:
Object Version Number
Read Only:true
Indicates the date and time of last update for the work order link. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the work order link. -
LastUpdateSourceCd: string
Title:
Last Updated by Source
Maximum Length:30
The source who last updated the work order link. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LinkTemplateCatCd: string
Title:
Link Template Category Code
Read Only:true
Maximum Length:30
The code that identifies template category selected for this link template. -
LinkTemplateCatDirFirstCd: string
Title:
Link Template Category Direction Code for First Link
Read Only:true
Maximum Length:37
The code that identifies template category direction for the first link in this link template. -
LinkTemplateCatDirFirstCdMeaning: string
Title:
Link Template Category Direction for First Link
Read Only:true
Maximum Length:377
The meaning of the template category direction for the first link in this link template. -
LinkTemplateCatDirSecondCd: string
Title:
Link Template Category Direction Code for Second Link
Read Only:true
Maximum Length:37
The code that identifies template category direction for the second link in this link template. -
LinkTemplateCatDirSecondCdMeaning: string
Title:
Link Template Category Direction for Second Link
Read Only:true
Maximum Length:377
The meaning of the template category direction for the second link in this link template. -
LinkTemplateId: integer
(int64)
Title:
Link Template ID
The unique identifier of the link template in the link. -
LinkTemplateNumber: string
Title:
Link Template Number
Read Only:true
Maximum Length:30
Value that uniquely identifies the alternate unique identifier of the template number. This value can be system-generated, or can be configured. The default configuration is CDRM-0000000000. -
LinkTypeDirectionCd: string
Title:
Link Type Direction Code
Maximum Length:30
The code that identifies the direction of the link relationship, whether this link is for the first or second work order. -
LinkTypeLabelFirst: string
Title:
Link Label for First Work Order
Read Only:true
Maximum Length:160
The link type label that identifies the link for the first work order. This must exactly match the link label provided in the link template in Oracle Field Service. -
LinkTypeLabelSecond: string
Title:
Link Label for Second Work Order
Read Only:true
Maximum Length:160
The link type label that identifies the link for the second work order. This must exactly match the link label provided in the link template in Oracle Field Service. -
LinkTypeNameFirst: string
Title:
Link Name for First Work Order
Read Only:true
Maximum Length:256
The link type name that identifies the link for the first work order. -
LinkTypeNameSecond: string
Title:
Link Name for Second Work Order
Read Only:true
Maximum Length:256
The link type name that identifies the link for the second work order. -
MaximumIntervalMinutes: integer
(int32)
Title:
Maximum Interval (minutes)
Read Only:true
The default maximum interval in minutes. -
MaximumIntervalTypeCd: string
Title:
Maximum Interval Type Code
Read Only:true
Maximum Length:30
The code that identifies the maximum interval type between work order set on the link template. -
MaximumIntervalValue: integer
(int32)
Title:
Maximum Interval
The actual maximum interval in minutes for this link. -
MinimumIntervalMinutes: integer
(int32)
Title:
Minimum Interval (minutes)
Read Only:true
The default minimum interval in minutes. -
MinimumIntervalTypeCd: string
Title:
Minimum Interval Type Code
Read Only:true
Maximum Length:30
The code that identifies the minimum interval type between work order set on the link template. -
MinimumIntervalValue: integer
(int32)
Title:
Minimum Interval
The actual minimum interval in minutes for this link. -
SchedulingConstraintCd: string
Title:
Scheduling Constraints Code
Read Only:true
Maximum Length:30
The code that identifies the scheduling constraint set on the link template. -
SecondWoId: integer
(int64)
Title:
Second Work Order ID
The unique identifier of the second work order in the link. -
SecondWoNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:30
Value that uniquely identifies the alternate unique identifier of the second 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. -
SecondWoScheduledDate: string
(date)
Title:
Scheduled Date
Read Only:true
The date of when the scheduled service will be performed for the second work order. -
SecondWoScheduledTimeSlot: string
Title:
Scheduled Time Slot
Read Only:true
Maximum Length:40
The time slot to perform the scheduled service for the second work order. -
SecondWoStatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Indicates the work order status code for the second work order. -
SecondWoStatusCdMeaning: string
Title:
Status
Read Only:true
The meaning of the second work order status code. -
SecondWoTitle: string
Title:
Title
Read Only:true
Maximum Length:400
The title of the second work order. -
TemplateActiveFlag: boolean
Title:
Active
Read Only:true
Maximum Length:1
Default Value:false
Indicates if link template for the link is active. -
WoLinkId: integer
(int64)
Title:
Work Order Link ID
Read Only:true
The unique identifier of the work order link.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- setIbAssetIdViewCriteria
- setSrIdViewCriteria
- setWoIdViewCriteria
- setWoParentIdViewCriteria
Examples
The following example shows how to get all work orders by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/customerWorkOrders
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "WoId": 300100152032209, "CreationDate": "2018-07-20T07:31:49+00:00", "CreatedBy": "FUSION", "LastUpdateDate": "2018-07-20T07:33:48.541+00:00", "LastUpdatedBy": "FUSION", "LastUpdateLogin": "71685ED2BA9B3A31E053773AF80AA4BA", "LastUpdateSourceCd": null, "WoNumber": "WO0000000113", "WoTypeId": 300100151606204, "WoTypeCd": "WO_MRI_ES", "WoTypeCdMeaning": "MRI Emergency Service", "FsTypeCd": "MRI_ES", "WoStatusCd": "ORA_SVC_WO_SUBMITTED", "WoStatusCdMeaning": "Submitted_123", "WoIntegrationMsgCd": "ORA_WO_INT_MSG_CREATE_SUB", "WoIntegrationStatusCd": "ORA_WO_INT_CREATE_SUBMITTED", "SourceCd": "ORA_SVC_AGENT_UI", "SrId": 300100152032205, "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": null, "AssigneeResourceId": null, "AssigneePersonName": null, "AssigneeEmail": null, "AssigneePhoneNumber": null, "AccountPartyId": 300100126721679, "AccountPartyName": "FSACCOUNT (DENVER, US)", "AccountStatus": "A", "PartnerAccountPartyId": 100000016934014, "PartnerAccountName": "Perficient Service", "PartnerAccountPartyType": "ORGANIZATION", "PartnerAccountStatus": "A", "OwnerTypeCd": "ORA_SVC_PARTNER", "ContactPartyId": 100000016934230, "ContactStatus": "A", "ContactPartyFirstName": "Lynda", "ContactPartyLastName": "Jones", "ContactNameLovSwitcher": "LOV_PersonPartyNameByPartnerAccount", "ContactName": "Lynda Jones", "ContactEmail": "lynda.jones@us2.oraclecloud.com", "ContactPhoneNumber": "+1 (645) 345-3217 x5645", "ContactAltPhoneNumber": null, "ContactLanguageCode": null, "ContactPartySiteId": 300100151899629, "Address1": "Hello`123", "Address2": null, "Address3": null, "Address4": null, "City": "DENVER", "County": null, "PostalCode": "80202", "State": "CO", "Province": null, "Country": "US", "TimezoneCode": "America/Denver", "WoArea": "South Denver", "CaseNote": null, "Duration": 0, "ReminderTime": null, "ResolutionDueDate": "2018-07-20T08:31:00+00:00", "ResolutionDueDateLocal": "2018-07-20T02:31:00.000-06:00", "RequestedDate": "2018-07-20", "RequestedTimeSlot": "10-12", "RequestedTime": "2018-07-20 10-12", "ScheduledDate": null, "ScheduledTimeSlot": null, "ScheduledTime": " ", "FsActivityId": null, "FsErrorDetail": null, "FsNote": null, "FsResource": 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", "PrimaryAssetProductInventoryItemId": null, "PrimaryAssetProductOrganizationId": null, "FormattedAddress": null, "SrNumber": "SR0000021047", "WoIntegrationMsgCdDisp": "ORA_WO_INT_MSG_CREATE_SUB", "WoIntegrationStatusCdDisp": "ORA_WO_INT_CREATE_SUBMITTED", "AddressId": 300100151899628, "FieldServiceResourceId": null, "FieldServiceResourceEmail": null, "FieldServiceResourcePhoneNumber": null, "FieldServiceResourcePersonName": null, "links": [ ... ] }, { "WoId": 300100152095238, "CreationDate": "2018-07-23T09:38:14+00:00", "CreatedBy": "autouisadminfs1", "LastUpdateDate": "2018-08-01T21:52:22+00:00", "LastUpdatedBy": "SERVICE_APP_ICS_ID", "LastUpdateLogin": "72645B7DEB5B0AC2E053773AF80A0E3E", "LastUpdateSourceCd": null, "WoNumber": "WO0000000144", "WoTypeId": 300100151606205, "WoTypeCd": "WO_MRI_SS", "WoTypeCdMeaning": "MRI Standard Service", "FsTypeCd": "MRI_SS", "WoStatusCd": "ORA_SVC_WO_PENDING", "WoStatusCdMeaning": "Completed", "WoIntegrationMsgCd": null, "WoIntegrationStatusCd": "ORA_WO_INT_CREATE_SUCCESSFUL", "SourceCd": "ORA_SVC_AGENT_UI", "SrId": 300100152095224, "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": 300100098079709, "AssigneeResourceId": 300100098079709, "AssigneePersonName": "autouisadminfs1 svc", "AssigneeEmail": "autouisadminfs1.svc@oracle.com", "AssigneePhoneNumber": null, "AccountPartyId": 300100126721679, "AccountPartyName": "FSACCOUNT (DENVER, US)", "AccountStatus": "A", "PartnerAccountPartyId": null, "PartnerAccountName": null, "PartnerAccountPartyType": null, "PartnerAccountStatus": null, "OwnerTypeCd": "ORA_SVC_CUSTOMER", "ContactPartyId": 300100126721684, "ContactStatus": "A", "ContactPartyFirstName": "John", "ContactPartyLastName": "Wilson", "ContactNameLovSwitcher": "LOV_PersonPartyNameByAccount", "ContactName": "John Wilson", "ContactEmail": "John.Wilson@oracle.com", "ContactPhoneNumber": "+1 (122)12312312", "ContactAltPhoneNumber": null, "ContactLanguageCode": null, "ContactPartySiteId": 300100136173693, "Address1": "addr1", "Address2": "addr2", "Address3": null, "Address4": null, "City": "DENVER", "County": null, "PostalCode": "80202", "State": "CO", "Province": null, "Country": "US", "TimezoneCode": "America/Denver", "WoArea": "South Denver", "CaseNote": "WO Created via automation on Mon Jul 23 02:38:37 PDT 2018", "Duration": 0, "ReminderTime": null, "ResolutionDueDate": null, "ResolutionDueDateLocal": null, "RequestedDate": "2018-07-23", "RequestedTimeSlot": "08-10", "RequestedTime": "2018-07-23 08-10", "ScheduledDate": "2018-08-10", "ScheduledTimeSlot": "13-15", "ScheduledTime": "2018-08-10 13-15", "FsActivityId": 4236961, "FsErrorDetail": null, "FsNote": null, "FsResource": 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", "PrimaryAssetProductInventoryItemId": null, "PrimaryAssetProductOrganizationId": null, "FormattedAddress": null, "SrNumber": "SR0000021351", "WoIntegrationMsgCdDisp": null, "WoIntegrationStatusCdDisp": "ORA_WO_INT_CREATE_SUCCESSFUL", "AddressId": 300100136173692, "FieldServiceResourceId": null, "FieldServiceResourceEmail": null, "FieldServiceResourcePhoneNumber": null, "FieldServiceResourcePersonName": null, "links": [ ... ] }, ...