1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Service Request Summarizations v1

Get a service request summarization using advanced query

post

/api/boss/data/objects/ora/cxServiceCore/analytics/v1/serviceRequestSummarizations/{serviceRequestSummarizations_id}/$query

Request

Path Parameters
Query Parameters
  • The effective date value in ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • accessors
    Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
  • fields
    Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
  • subTypes
    Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : accessors
Type: object
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
Nested Schema : fields
Type: array
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
Show Source
Nested Schema : subTypes
Type: object
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Back to Top

Response

Default Response

A single item response
Body ()
Root Schema : serviceRequestSummarizations_item-response
Match All
Show Source
Nested Schema : oraCxServiceCoreAnalytics.ServiceRequestSummarization_item
Match All
Show Source
Nested Schema : oraCxServiceCoreAnalytics.ServiceRequestSummarization_item-fields
Type: object
Show Source
Nested Schema : Service Request Summarization
Type: object
Title: Service Request Summarization
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : stripeCode
Match All
The product area associated with the summary.
Show Source
  • Title: Stripe Code
    Read Only: true
    The product area associated with the summary.
  • Allowed Values: [ "ORA_SVC_CRM", "ORA_SVC_HRHD", "ORA_SVC_ISR" ]
Nested Schema : $context
Type: object
Show Source
Nested Schema : links
Type: object
Read Only: true
Show Source
Nested Schema : $self
Type: object
Show Source
Links
$self
Parameters:
  • serviceRequestSummarizations_id: $request.path.serviceRequestSummarizations_id
Back to Top

Examples

The following example shows how to create an advanced query to get a service request summarization by submitting a POST request on the REST resource.

cURL Command

curl -X POST --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/analytics/v1/serviceRequestSummarizations/{serviceRequestSummarizations_id}/$query 
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' -D @request.json

Example of Request Body

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

{
    "fields": [
                "serviceRequestsSummarizationId",
                "stripeCode",
                "summarizationDate",
                "serviceRequestsAllOpen",
                "serviceRequestsAllInProgress",
                "serviceRequestsAllResolved",
                "serviceRequestsAllClosed"
                ]
}

Example of Response Body

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

{
    "serviceRequestsSummarizationId": "10030",
    "stripeCode": "ORA_SVC_ISR",
    "summarizationDate": "2025-03-07T00:00:00Z",
    "serviceRequestsAllOpen": "3781",
    "serviceRequestsAllInProgress": "68",
    "serviceRequestsAllResolved": "65",
    "serviceRequestsAllClosed": "22",
    "$id": "10030",
    "$context": {
        "etag": "1",
        "links": {
            "$self": {
                "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/analytics/v1/serviceRequestSummarizations/10030"
            }
        }
    }
}
Back to Top