Get all work orders

get

/api/boss/data/objects/ora/cxServiceCore/workOrder/v1/$en/customerWorkOrders

Request

Query Parameters
  • Effective date value in the ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
  • Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
  • The resource collection will be queried using the specified filter condition.
  • Specifies whether the server should estimate the total number of records for a given query and include the count in the response.
  • Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.
    Default Value: 25
  • Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
    Default Value: 0
  • Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".

There's no request body for this operation.

Back to Top

Response

Default Response

An array of items response
Body ()
Root Schema : customerWorkOrders_view-default
Match All
Show Source
Nested Schema : __collection_context
Type: object
Show Source
Nested Schema : customerWorkOrders_view-default-allOf[1]
Type: object
Show Source
Nested Schema : totalItems
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : oraCxServiceCoreWorkOrder.WorkOrder_item-response
Match All
Show Source
Nested Schema : oraCxServiceCoreWorkOrder.WorkOrder_item
Match All
The work order resource is used to view, create, and update a customer work order. A work order is a transaction record, which is created when a customer needs to schedule a field service resource to perform work at the customer's location.
Show Source
Nested Schema : oraCxServiceCoreWorkOrder.WorkOrder_item-fields
Type: object
Show Source
Nested Schema : Work Order
Type: object
Title: Work Order
The work order resource is used to view, create, and update a customer work order. A work order is a transaction record, which is created when a customer needs to schedule a field service resource to perform work at the customer's location.
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : installedBaseAsset
Match All
The unique identifier of the associated install base asset record.
Show Source
Nested Schema : productGroup
Match All
Show Source
Nested Schema : productItem
Match All
Show Source
Nested Schema : serviceRequest
Match All
The service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.
Show Source
Nested Schema : woIntegration
Match All
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.
Show Source
Nested Schema : woIntegrationMessage
Match All
Unique code indicating the integration message used to share information about the most recent integration event for the work order with end users. A list of accepted values are defined in the lookup type ORA_SVC_WO_INT_MSG_CD. You can review and update the value using the Setup and Maintenance work area, and the Manage Integration Messages.
Show Source
Nested Schema : woStatus
Match All
A work order status is used to indicate the current status of the work order such as Scheduled, Started, Completed. This resource is used to view, create, update and delete status for a given type of service work order.
Show Source
Nested Schema : woType
Match All
The code indicating the type of service to be performed for a work order. You can review and update the value using the Setup and Maintenance work area, and the Manage Work Order Types.
Show Source
Nested Schema : Installed Base Asset ID
Type: object
Title: Installed Base Asset ID
The unique identifier of the associated install base asset record.
Nested Schema : $context
Type: object
Show Source
Nested Schema : Product Group
Type: object
Title: Product Group
Nested Schema : Product
Type: object
Title: Product
Nested Schema : oraCxServiceCoreSrMgmt.ServiceRequest_item-fields
Type: object
Show Source
Nested Schema : Service Request
Type: object
Title: Service Request
The service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.
Nested Schema : assigneeResource
Match All
Show Source
Nested Schema : businessUnit
Match All
Show Source
Nested Schema : category
Match All
Show Source
Nested Schema : channelType
Match All
The channel type.
Show Source
Nested Schema : createdByParty
Match All
Show Source
Nested Schema : customer
Match All
Show Source
Nested Schema : installedBaseAsset
Match All
The unique identifier of the associated install base asset record.
Show Source
Nested Schema : internalPriority
Match All
The internal priority of the service request.
Show Source
Nested Schema : lastUpdatedByParty
Match All
Show Source
Nested Schema : ownerTypeCode
Match All
The type of the service request owner. For example, customer or partner.
Show Source
  • Title: Owner Type
    Read Only: true
    The type of the service request owner. For example, customer or partner.
  • Allowed Values: [ "ORA_SVC_CUSTOMER", "ORA_SVC_PARTNER" ]
Nested Schema : primaryContact
Match All
Show Source
Nested Schema : problemType
Match All
The problem code of the service request.
Show Source
Nested Schema : productGroup
Match All
Show Source
Nested Schema : productItem
Match All
Show Source
Nested Schema : queue
Match All
Show Source
Nested Schema : reportedByParty
Match All
Show Source
Nested Schema : resolution
Match All
The resolution code of the service request.
Show Source
Nested Schema : resolvedByParty
Match All
Show Source
Nested Schema : resolveOutcome
Match All
The outcome of a service request resolution.
Show Source
Nested Schema : severity
Match All
The severity of the service request.
Show Source
Nested Schema : source
Match All
Indicates how the service request was created.
Show Source
Nested Schema : sourceUpdatedByParty
Match All
Show Source
Nested Schema : status
Match All
The status code of the service request.
Show Source
Nested Schema : statusType
Match All
The status type of the service request.
Show Source
Nested Schema : transferReason
Match All
The lookup code that indicates the transfer reason.
Show Source
Nested Schema : oraCxSalesCommonResourceMgmt.Resource_item-fields
Type: object
Show Source
Nested Schema : Assignee Resource
Type: object
Title: Assignee Resource
Nested Schema : person
Match All
Show Source
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item
Match All
Resource Person records essential details pertaining to an individual within the resource framework.
Show Source
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields
Match All
Show Source
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields-allOf[0]
Type: object
Show Source
  • Title: Internal
    Read Only: true
    Default Value: false
    Indicates whether the person is an internal member of the organization. If Y, the person is an internal member. For example, employee or retired employee. If N they're an external person. For example, partner contact, supplier contact. Default value is set to N.
  • Title: Middle Name
    The middle name of the person.
  • Title: Name
    Read Only: true
    The combination of title, first, middle, last, and suffix names of the person.
Nested Schema : oraCxSalesCommonParty.Person_abstract-item
Type: object
Show Source
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields-allOf[2]
Type: object
Show Source
  • Title: Comments
    The free text comments about the person.
  • Title: Do Not Call
    Indicates whether the person can be called or not. If the value is True, then the person must not be called. The default is False. A list of accepted values is defined using the lookup YES_NO.
  • Title: Do Not Contact
    Indicates whether the person can be contacted or not by phone, e-mail, or mail. If the value is True, then the person must not be contacted. The default is False. A list of accepted values is defined using the lookup YES_NO.
  • Title: Do Not Mail
    Indicates whether the person can be sent mail or not. If the value is True, then the person must not be sent mail. The default is False. A list of accepted values is defined using the lookup YES_NO.
  • Title: First Name
    First name of the person.
  • Title: Gender
    The gender of the person as identified by them. A list of accepted values are defined in the lookup HZ_GENDER.
  • Title: Person ID
    The unique identifier of the person profile.
  • Title: Job Title
    The free form text for job title of the person.
  • Title: Job Title Code
    The code given to the job title.
  • Title: Last Name
    The last name of the person.
  • Title: Preferred Contact Method
    The preferred communication method of a person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD.
  • Title: Registry ID
    The alternate identifier of the contact.
  • Title: Salutation
    The phrase used to address a contact party in any correspondence.
  • Title: Prefix
    Contains titles or honorifics preceding a person's name, like Mr., Mrs., Ms., and so on. For example, Mr. in Mr. John Smith.
  • Title: Title
    A professional or family title, such as Don or The Right Honorable.
Nested Schema : Resource Person
Type: object
Title: Resource Person
Resource Person records essential details pertaining to an individual within the resource framework.
Nested Schema : gender
Match All
Show Source
Nested Schema : jobTitleCode
Match All
Show Source
  • Allowed Values: [ "ACCOUNTANT", "ACCOUNTS_PAYABLE_SPECIALIST", "ADMINISTRATOR", "ANALYST", "ARCHITECT", "ARTIST", "ASSISTANT", "ASSOCIATE", "ATTORNEY", "AUDITOR", "BROKER", "BUYER", "CEO", "CFO", "CHAIRMAN", "CIO", "CONSULTANT", "CONTRLR", "COO", "CTO", "DESIGNER", "DEVELOPER", "DIRECTOR", "EDITOR", "ENGINEER", "MANAGER", "OFFICER", "OPERATOR", "OWNER", "PARALEGAL", "PARTNER", "PHYSICIAN", "PLANNER", "PRESIDENT", "PRODUCER", "RECEPTIONIST", "REPORTER", "REPRESENTATIVE", "RESEARCHER", "STAFF", "SUPERVISOR", "TRAINER", "VICE PRESIDENT", "WRITER" ]
Nested Schema : preferredContactMethod
Match All
Show Source
Nested Schema : salutoryIntroduction
Match All
Show Source
Nested Schema : timezone
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.Timezone_item
Match All
The time zones list of values resource is used to query the time zones.
Show Source
Nested Schema : oraCommonAppsInfraObjects.Timezone_item-fields
Type: object
Show Source
Nested Schema : Time Zone
Type: object
Title: Time Zone
The time zones list of values resource is used to query the time zones.
Nested Schema : timezone-allOf[2]
Type: object
Nested Schema : Business Unit
Type: object
Title: Business Unit
Nested Schema : Category
Type: object
Title: Category
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Channel Type
Type: object
Title: Channel Type
The channel type.
Nested Schema : owningType
Match All
The standard lookup types list of values resource is used to query the list of standard lookup types.
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.LookupType_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Standard Lookup Type
Type: object
Title: Standard Lookup Type
The standard lookup types list of values resource is used to query the list of standard lookup types.
Nested Schema : configurationLevel
Match All
Show Source
Nested Schema : restAccessSecured
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "ANON", "AUTH", "SECURE" ]
Nested Schema : taxonomyNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Taxonomy Node
Type: object
Title: Taxonomy Node
The taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : hierarchySource
Match All
The taxonomy hierarchy represents relationships between taxonomy nodes.
Show Source
Nested Schema : moduleType
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "APPLICATION", "LBA", "PAGE", "PRODUCT_LINE", "DELIVERY_ROOT", "FAMILY" ]
Nested Schema : oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields
Type: object
Show Source
Nested Schema : Taxonomy Hierarchy
Type: object
Title: Taxonomy Hierarchy
The taxonomy hierarchy represents relationships between taxonomy nodes.
Nested Schema : sourceNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
Nested Schema : targetNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
Nested Schema : Taxonomy Node
Type: object
Title: Taxonomy Node
The taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : Taxonomy Node
Type: object
Title: Taxonomy Node
The taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : Created by Party
Type: object
Title: Created by Party
Nested Schema : Customer
Type: object
Title: Customer
Nested Schema : Installed Base Asset ID
Type: object
Title: Installed Base Asset ID
The unique identifier of the associated install base asset record.
Nested Schema : Internal Priority Code
Type: object
Title: Internal Priority Code
The internal priority of the service request.
Nested Schema : Last Updated by Party
Type: object
Title: Last Updated by Party
Nested Schema : Primary Contact
Type: object
Title: Primary Contact
Nested Schema : Problem Type Code
Type: object
Title: Problem Type Code
The problem code of the service request.
Nested Schema : Product Group
Type: object
Title: Product Group
Nested Schema : Product
Type: object
Title: Product
Nested Schema : Queue
Type: object
Title: Queue
Nested Schema : Reported by Party
Type: object
Title: Reported by Party
Nested Schema : Resolution Code
Type: object
Title: Resolution Code
The resolution code of the service request.
Nested Schema : Resolved by Party
Type: object
Title: Resolved by Party
Nested Schema : Outcome
Type: object
Title: Outcome
The outcome of a service request resolution.
Nested Schema : Severity Code
Type: object
Title: Severity Code
The severity of the service request.
Nested Schema : Source Code
Type: object
Title: Source Code
Indicates how the service request was created.
Nested Schema : Source Updated by Party
Type: object
Title: Source Updated by Party
Nested Schema : Status
Type: object
Title: Status
The status code of the service request.
Nested Schema : Status Type
Type: object
Title: Status Type
The status type of the service request.
Nested Schema : Transfer Reason
Type: object
Title: Transfer Reason
The lookup code that indicates the transfer reason.
Nested Schema : Integration
Type: object
Title: Integration
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.
Nested Schema : Work Order Integration Message Code
Type: object
Title: Work Order Integration Message Code
Unique code indicating the integration message used to share information about the most recent integration event for the work order with end users. A list of accepted values are defined in the lookup type ORA_SVC_WO_INT_MSG_CD. You can review and update the value using the Setup and Maintenance work area, and the Manage Integration Messages.
Nested Schema : oraCxServiceCoreWorkOrder.WorkOrderStatus_item-fields
Type: object
Show Source
Nested Schema : Work Order Status
Type: object
Title: Work Order Status
A work order status is used to indicate the current status of the work order such as Scheduled, Started, Completed. This resource is used to view, create, update and delete status for a given type of service work order.
Nested Schema : category
Match All
The type of the service work order.
Show Source
Nested Schema : Status Category
Type: object
Title: Status Category
The type of the service work order.
Nested Schema : oraCxServiceCoreWorkOrder.WorkOrderType_item-fields
Type: object
Show Source
Nested Schema : Work Order Type Code
Type: object
Title: Work Order Type Code
The code indicating the type of service to be performed for a work order. You can review and update the value using the Setup and Maintenance work area, and the Manage Work Order Types.
Back to Top