Jump to

• Request
• Response
• Examples

Get a service request summarization

get

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

Request

Path Parameters

• serviceRequestSummarizations_id(required): string
  This path parameter maps to the following field defined in the Service Request Summarizations REST resource:
  

  1. serviceRequestsSummarizationId: The unique identifier of the service request summarization.

Query Parameters

• $effectiveDate: string(date)
  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.
• $fields: string
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

There's no request body for this operation.

Back to Top

Response

Default Response

A single item response

Body ()

Root Schema : serviceRequestSummarizations_item-response

Match All

Show Source

• allOf oraCxServiceCoreAnalytics.ServiceRequestSummarization_item
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreAnalytics.ServiceRequestSummarization_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : oraCxServiceCoreAnalytics.ServiceRequestSummarization_item

Match All

Show Source

• object oraCxServiceCoreAnalytics.ServiceRequestSummarization_item-fields
• object Service Request Summarization
  Title: Service Request Summarization

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreAnalytics.ServiceRequestSummarization_item-fields"
        },
        {
            "type":"object",
            "title":"Service Request Summarization",
            "x-hints":{
                "titlePlural":"Service Request Summarizations"
            }
        }
    ]
}

Nested Schema : oraCxServiceCoreAnalytics.ServiceRequestSummarization_item-fields

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  The resource who has created the SR.
• serviceRequestsAgentReassign: string (big-integer)
  Title: Agent Reassignment Today

  Read Only: true

  The count of all SRs reassigned to a different agent on a specific date.
• serviceRequestsAllAwaitingCustomer: string (big-integer)
  Title: Awaiting response

  Read Only: true

  The count of all SRs awaiting customer response.
• serviceRequestsAllClosed: string (big-integer)
  Title: All Closed

  Read Only: true

  The count of all closed SRs.
• serviceRequestsAllDeleted: string (big-integer)
  Title: All Deleted

  Read Only: true

  The count of all deleted SRs.
• serviceRequestsAllInProgress: string (big-integer)
  Title: All in Progress

  Read Only: true

  The count of all SRs in In Progress status.
• serviceRequestsAllNew: string (big-integer)
  Title: All New

  Read Only: true

  The count of all SRs in New status.
• serviceRequestsAllOpen: string (big-integer)
  Title: All Open

  Read Only: true

  The count of all SRs in Open status.
• serviceRequestsAllOpenCritical: string (big-integer)
  Title: All Open Critical

  Read Only: true

  The count of all SRs that are critical, reopened, and still open as of a specific date.
• serviceRequestsAllPendingAgent: string (big-integer)
  Title: All Pending Agent

  Read Only: true

  The count of all SRs awaiting action by the agent.
• serviceRequestsAllPurged: string (big-integer)
  Title: All Purged

  Read Only: true

  The count of all SRs in Purged status.
• serviceRequestsAllReopen: string (big-integer)
  Title: All Reopened

  Read Only: true

  The count of all SRs that are critical, reopened and still open on a specific date.
• serviceRequestsAllReopenCritical: string (big-integer)
  Title: All Reopened Critical

  Read Only: true

  The count of all SRs that were reopened and still open on a specific date.
• serviceRequestsAllResolved: string (big-integer)
  Title: All Resolved

  Read Only: true

  The count of all resolved SRs but not yet closed.
• serviceRequestsAllUnassigned: string (big-integer)
  Title: All Unassigned

  Read Only: true

  The count of all SRs not yet assigned to a specific agent, including those in queues.
• serviceRequestsAllUnclaim: string (big-integer)
  Title: All Unclaimed

  Read Only: true

  The count of SRs across all queues that haven't been claimed.
• serviceRequestsAllUnresolved: string (big-integer)
  Title: All Unresolved

  Read Only: true

  The count of all unresolved SRs.
• serviceRequestsAllWaiting: string (big-integer)
  Title: All Waiting

  Read Only: true

  The count of all SRs in Waiting status.
• serviceRequestsClosed: string (big-integer)
  Title: Closed Today

  Read Only: true

  The count of all SRs closed on a specific date.
• serviceRequestsCreated: string (big-integer)
  Title: Created Today

  Read Only: true

  The count of all SRs created on a specific date.
• serviceRequestsCriticalCreated: string (big-integer)
  Title: Created Critical Today

  Read Only: true

  The count of critical SRs created on a specific date.
• serviceRequestsDeleted: string (big-integer)
  Title: Deleted Today

  Read Only: true

  The count of critical SRs deleted on a specific date.
• serviceRequestsInitialAgentAssign: string (big-integer)
  Title: Initial Agent Assignment Today

  Read Only: true

  The count of all SRs assigned to a queue for the first time on a specific date.
• serviceRequestsInitialQueueAssign: string (big-integer)
  Title: Initial Queue Assignment Today

  Read Only: true

  The count of all SRs assigned to a named resource for the first time.
• serviceRequestsOpen: string (big-integer)
  Title: Opened Today

  Read Only: true

  The count of all SRs opened on a specific date.
• serviceRequestsOpenCritical: string (big-integer)
  Title: Opened Critical Today

  Read Only: true

  The count of critical SRs opened on a specific date.
• serviceRequestsPurged: string (big-integer)
  Title: Purged Today

  Read Only: true

  The count of critical SRs purged on a specific date.
• serviceRequestsQueueReassign: string (big-integer)
  Title: Queue Reassignment Today

  Read Only: true

  The count of all SRs reassigned to a different queue on a specific date.
• serviceRequestsReopen: string (big-integer)
  Title: Reopened Today

  Read Only: true

  The count of all SRs reopened on a specific date.
• serviceRequestsReopenCritical: string (big-integer)
  Title: Reopened Critical Today

  Read Only: true

  The count of critical SRs reopened on a specific date.
• serviceRequestsResolved: string (big-integer)
  Title: Resolved Today

  Read Only: true

  The count of all SRs resolved on a specific date.
• serviceRequestsSummarizationId: string (big-integer)
  Title: Summarization ID

  Read Only: true

  The unique identifier of the service request summarization.
• serviceRequestsUpdated: string (big-integer)
  Title: Updated Today

  Read Only: true

  The count of all SRs that were updated on a specific date.
• stripeCode: stripeCode
• summarizationDate: string (date-time)
  Title: Summarization Date

  Read Only: true

  The date on which the summarization data is captured.
• timeCreated: string (date-time)
  Title: Created Date

  Read Only: true

  The date and time at which the record was created.
• timeUpdated: string (date-time)
  Title: Updated Date

  Read Only: true

  The date and time at which the record was updated.
• updatedBy: string
  Title: Updated By

  Read Only: true

  The resource who has updated the record.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The resource who has created the SR."
        },
        "serviceRequestsAgentReassign":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Agent Reassignment Today",
            "description":"The count of all SRs reassigned to a different agent on a specific date."
        },
        "serviceRequestsAllAwaitingCustomer":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Awaiting response",
            "description":"The count of all SRs awaiting customer response."
        },
        "serviceRequestsAllClosed":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Closed",
            "description":"The count of all closed SRs."
        },
        "serviceRequestsAllDeleted":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Deleted",
            "description":"The count of all deleted SRs."
        },
        "serviceRequestsAllInProgress":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All in Progress",
            "description":"The count of all SRs in In Progress status."
        },
        "serviceRequestsAllNew":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All New",
            "description":"The count of all SRs in New status."
        },
        "serviceRequestsAllOpen":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Open",
            "description":"The count of all SRs in Open status."
        },
        "serviceRequestsAllOpenCritical":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Open Critical",
            "description":"The count of all SRs that are critical, reopened, and still open as of a specific date."
        },
        "serviceRequestsAllPendingAgent":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Pending Agent",
            "description":"The count of all SRs awaiting action by the agent."
        },
        "serviceRequestsAllPurged":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Purged",
            "description":"The count of all SRs in Purged status."
        },
        "serviceRequestsAllReopen":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Reopened",
            "description":"The count of all SRs that are critical, reopened and still open on a specific date."
        },
        "serviceRequestsAllReopenCritical":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Reopened Critical",
            "description":"The count of all SRs that were reopened and still open on a specific date."
        },
        "serviceRequestsAllResolved":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Resolved",
            "description":"The count of all resolved SRs but not yet closed."
        },
        "serviceRequestsAllUnassigned":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Unassigned",
            "description":"The count of all SRs not yet assigned to a specific agent, including those in queues."
        },
        "serviceRequestsAllUnclaim":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Unclaimed",
            "description":"The count of SRs across all queues that haven't been claimed."
        },
        "serviceRequestsAllUnresolved":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Unresolved",
            "description":"The count of all unresolved SRs."
        },
        "serviceRequestsAllWaiting":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"All Waiting",
            "description":"The count of all SRs in Waiting status."
        },
        "serviceRequestsClosed":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Closed Today",
            "description":"The count of all SRs closed on a specific date."
        },
        "serviceRequestsCreated":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Created Today",
            "description":"The count of all SRs created on a specific date."
        },
        "serviceRequestsCriticalCreated":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Created Critical Today",
            "description":"The count of critical SRs created on a specific date."
        },
        "serviceRequestsDeleted":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Deleted Today",
            "description":"The count of critical SRs deleted on a specific date."
        },
        "serviceRequestsInitialAgentAssign":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Initial Agent Assignment Today",
            "description":"The count of all SRs assigned to a queue for the first time on a specific date."
        },
        "serviceRequestsInitialQueueAssign":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Initial Queue Assignment Today",
            "description":"The count of all SRs assigned to a named resource for the first time."
        },
        "serviceRequestsOpen":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Opened Today",
            "description":"The count of all SRs opened on a specific date."
        },
        "serviceRequestsOpenCritical":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Opened Critical Today",
            "description":"The count of critical SRs opened on a specific date."
        },
        "serviceRequestsPurged":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Purged Today",
            "description":"The count of critical SRs purged on a specific date."
        },
        "serviceRequestsQueueReassign":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Queue Reassignment Today",
            "description":"The count of all SRs reassigned to a different queue on a specific date."
        },
        "serviceRequestsReopen":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Reopened Today",
            "description":"The count of all SRs reopened on a specific date."
        },
        "serviceRequestsReopenCritical":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Reopened Critical Today",
            "description":"The count of critical SRs reopened on a specific date."
        },
        "serviceRequestsResolved":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Resolved Today",
            "description":"The count of all SRs resolved on a specific date."
        },
        "serviceRequestsSummarizationId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Summarization ID",
            "description":"The unique identifier of the service request summarization."
        },
        "serviceRequestsUpdated":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "readOnly":true,
            "title":"Updated Today",
            "description":"The count of all SRs that were updated on a specific date."
        },
        "stripeCode":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Stripe Code",
                    "description":"The product area associated with the summary."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreAnalytics.StripeCode_enum"
                }
            ]
        },
        "summarizationDate":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Summarization Date",
            "description":"The date on which the summarization data is captured."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Created Date",
            "description":"The date and time at which the record was created."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Updated Date",
            "description":"The date and time at which the record was updated."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Updated By",
            "description":"The resource who has updated the record."
        }
    },
    "x-primaryKey":[
        "serviceRequestsSummarizationId"
    ]
}

Nested Schema : Service Request Summarization

Type: object

Title: Service Request Summarization

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string"
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : stripeCode

Match All

The product area associated with the summary.

Show Source

• string
  Title: Stripe Code

  Read Only: true

  The product area associated with the summary.
• string
  Allowed Values: [ "ORA_SVC_CRM", "ORA_SVC_HRHD", "ORA_SVC_ISR" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Stripe Code",
            "description":"The product area associated with the summary."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreAnalytics.StripeCode_enum"
        }
    ]
}

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        }
    }
}

Links

$self

Parameters:

• serviceRequestSummarizations_id: $request.path.serviceRequestSummarizations_id

Back to Top

Examples

The following example shows how to get a service request summarization by submitting a GET request on the REST resource.

cURL Command

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

Example of Response Body

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

{
    "serviceRequestsSummarizationId": "10029",
    "stripeCode": "ORA_SVC_HRHD",
    "summarizationDate": "2025-03-07T00:00:00Z",
    "serviceRequestsCreated": "404",
    "serviceRequestsCriticalCreated": "14",
    "serviceRequestsReopen": "0",
    "serviceRequestsReopenCritical": "0",
    "serviceRequestsUpdated": "404",
    "serviceRequestsResolved": "11",
    "serviceRequestsClosed": "0",
    "serviceRequestsAllOpen": "5042",
    "serviceRequestsAllOpenCritical": "224",
    "serviceRequestsAllNew": "4911",
    "serviceRequestsAllInProgress": "59",
    "serviceRequestsAllWaiting": "72",
    "serviceRequestsAllUnassigned": "4517",
    "serviceRequestsAllUnclaim": "4230",
    "serviceRequestsAllUnresolved": "5042",
    "serviceRequestsAllResolved": "88",
    "serviceRequestsAllClosed": "44",
    "$id": "10029",
    "$context": {
        "etag": "1",
        "links": {
            "$self": {
                "href": "https:servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/analytics/v1/serviceRequestSummarizations/10029"
            }
        }
    }
}

Back to Top