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

Get all service request summarizations using advanced query

post

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

Request

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
Match All
Show Source
Nested Schema : schema
Match All
Show Source
Nested 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 : type
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
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.
Nested Schema : collection
Type: object
Defines query criteria that can be applied on a resource collection.
Show Source
  • The resource collection will be queried using the specified filter condition.
  • 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.
  • Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
  • Represents the privilege or action required to check for while serving a request to access a resource.
  • sortBy
    Orders a resource collection based on the specified fields.
Nested Schema : sortBy
Type: array
Orders a resource collection based on the specified fields.
Show Source
Nested Schema : items
Match One Schema
Show Source
  • Name of field based on which sorting will happen. Order is ascending.
  • type
    Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.
Nested Schema : type
Type: object
Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.
Nested Schema : parameters
Type: object
Values to be applied in a parameterized filter specific to the view.
Back to Top

Response

Default Response

An array of items response
Body ()
Root Schema : serviceRequestSummarizations_view-default
Match All
Show Source
Nested Schema : __collection_context
Type: object
Show Source
Nested Schema : serviceRequestSummarizations_view-default-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested 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
Back to Top

Examples

The following example shows how to create an advance query to get all service request summarizations 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/$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"
                ],
     "collection": {
                "sortBy": [
                            {
                                "summarizationDate": "desc"
                            }
                        ],
                "limit": 2,
                "filter": "stripeCode='ORA_SVC_CRM'"
                }
}

Example of Response Body

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

{
    "items": [
        {
            "serviceRequestsSummarizationId": "31001",
            "stripeCode": "ORA_SVC_CRM",
            "summarizationDate": "2025-05-21T00:00:00Z",
            "serviceRequestsAllOpen": "844",
            "serviceRequestsAllInProgress": "113",
            "serviceRequestsAllResolved": "374",
            "serviceRequestsAllClosed": "73",
            "$id": "31001",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/analytics/v1/serviceRequestSummarizations/31001"
                    }
                }
            }
        },
        {
            "serviceRequestsSummarizationId": "30001",
            "stripeCode": "ORA_SVC_CRM",
            "summarizationDate": "2025-05-20T00:00:00Z",
            "serviceRequestsAllOpen": "825",
            "serviceRequestsAllInProgress": "109",
            "serviceRequestsAllResolved": "332",
            "serviceRequestsAllClosed": "57",
            "$id": "30001",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/analytics/v1/serviceRequestSummarizations/30001"
                    }
                }
            }
        }
    ],
    "hasMore": true
}
Back to Top