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

Get all service requests with messages

get

/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/$views/serviceRequestMessages

Request

Query Parameters
  • 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.
  • 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

Successful response of retrieving view serviceRequestMessages for resource Service Requests
Body ()
Root Schema : serviceRequests_view-serviceRequestMessages
Match All
Show Source
Nested Schema : __collection_context
Type: object
Show Source
Nested Schema : serviceRequests_view-serviceRequestMessages-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : items-allOf[1]
Type: object
Show Source
Nested Schema : $context
Type: object
Show Source
Nested Schema : links
Type: object
Read Only: true
Show Source
Nested Schema : $self
Type: object
Show Source
Nested Schema : messages
Match All
Show Source
Nested Schema : messages-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : items-allOf[1]
Type: object
Show Source
Nested Schema : aiLogLevelCode
Match All
Indicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE.
Show Source
  • Title: AI Log Level Code
    Read Only: true
    Indicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE.
  • Allowed Values: [ "ORA_SVC_FINE", "ORA_SVC_INFO", "ORA_SVC_NONE" ]
Nested Schema : channelType
Match All
Show Source
Nested Schema : messageSubType
Match All
Show Source
Nested Schema : messageType
Match All
Show Source
Nested Schema : parentMessage
Match All
Show Source
Nested Schema : postedByParty
Match All
Show Source
Nested Schema : processingStatusCode
Match All
The processing status of the message. The accepted values are Ready, Processing, Error, and Success.
Show Source
  • Title: Processing Status
    Read Only: true
    The processing status of the message. The accepted values are Ready, Processing, Error, and Success.
  • Allowed Values: [ "ORA_SVC_BATCH_READY", "ORA_SVC_ERROR", "ORA_SVC_PENDING_RETRY", "ORA_SVC_PROCESSING", "ORA_SVC_READY", "ORA_SVC_REPROCESSING", "ORA_SVC_SETUP_ERROR", "ORA_SVC_SUCCESS", "ORA_SVC_WAITING" ]
Nested Schema : source
Match All
Show Source
Nested Schema : statusCode
Match All
The status of the message. The accepted values are Draft, Committed, and Corrected.
Show Source
  • Title: Status Code
    Read Only: true
    The status of the message. The accepted values are Draft, Committed, and Corrected.
  • Allowed Values: [ "ORA_SVC_DRAFT", "ORA_SVC_CORRECTED", "ORA_SVC_COMMITTED" ]
Nested Schema : visibilityCode
Match All
The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.
Show Source
  • Title: Visibility Code
    Read Only: true
    The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.
  • Allowed Values: [ "ORA_SVC_EXTERNAL", "ORA_SVC_INTERNAL" ]
Nested Schema : channelType-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : messageSubType-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : messageType-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : parentMessage-allOf[1]
Type: object
Show Source
  • Title: Message ID
    Read Only: true
    The unique identifier associated with the service request message.
  • Title: Message Number
    Read Only: true
    The public unique identifier of the service request message.
Nested Schema : postedByParty-allOf[1]
Type: object
Show Source
Nested Schema : id
Match All
Show Source
Nested Schema : name
Match All
Show Source
  • Read Only: true
  • Title: Party Name
    The name of the party.
Nested Schema : registryId
Match All
Show Source
  • Read Only: true
  • Title: Registry ID
    The public key generated or user-entered for a given party.
Nested Schema : source-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Back to Top

Examples

The following example shows how to get all service requests with messages by submitting a get request on the REST resource using cURL.

cURL Command

curl -X GET --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/$en/serviceRequests/$views/serviceRequestWithMessage\ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>

Example of Response Body

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

{
    "items": [       
        {
            "id": "300100089759739",
            "number": "SR0000000007",
            "title": "Network Connectivity Issue in Room 402",
            "createdBy": "Ram",
            "timeCreated": "2017-02-27T07:33:31Z",
            "updatedBy": "bi_csrep12",
            "timeUpdated": "2017-02-27T07:34:43.103Z",
            "criticalFlag": false,
            "closedDate": null,
            "openDate": "2017-02-27T07:33:09.809Z",
            "lastReopenDate": null,
            "lastResolvedDate": null,
            "problemDescription": "The Wi-Fi connection in Room 402 has been unstable for the past two days. The signal frequently drops, making it difficult to maintain a steady connection. This issue is affecting multiple users in the room. Please investigate and resolve the issue as soon as possible",
            "resolveDescription": null,
            "$id": "SR0000000007",
            "$context": {
                "etag": "3",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/$en-US/serviceRequests/SR0000000007"
                    }
                }
            },
            "messages": {
                "items": [
                    {
                        "id": "300100122471262",
                        "number": "CDRM_11",
                        "createdBy": "bi_csrep12",
                        "timeCreated": "2017-08-23T09:11:06.024Z",
                        "updatedBy": "bi_csrep12",
                        "timeUpdated": "2017-08-23T09:11:15.328Z",
                        "messageContent": "Check for the wifi coverage to the room",
                        "richTextFlag": true,
                        "subject": "Coverage distance",
                        "sentDate": null,
                        "originationDate": "2017-08-23T09:11:06.024Z",
                        "sourceCreatedBy": "bi_csrep12",
                        "sourceTimeUpdated": "2017-08-23T09:11:06.024Z",
                        "sourceUpdatedBy": "bi_csrep12",
                        "originalSystemReference": null,
                        "privateInformationFlag": null,
                        "templateName": null,
                        "$id": "300100122471262",
                        "$context": {
                            "etag": "1",
                            "links": {
                                "$self": {
                                    "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/SR0000011001/messages/300100122471262"
                                }
                            }
                        }
                    },
                    {
                        "id": "300100122471260",
                        "number": "CDRM_10",
                        "createdBy": "bi_csrep12",
                        "timeCreated": "2017-08-23T09:11:03.123Z",
                        "updatedBy": "bi_csrep12",
                        "timeUpdated": "2017-08-23T09:11:15.167Z",
                        "messageContent": "Upgrade the router to increase coverage area",
                        "richTextFlag": true,
                        "subject": "Router Upgrade",
                        "sentDate": null,
                        "originationDate": "2017-08-23T09:11:03.123Z",
                        "sourceCreatedBy": "bi_csrep12",
                        "sourceTimeUpdated": "2017-08-23T09:11:03.123Z",
                        "sourceUpdatedBy": "bi_csrep12",
                        "originalSystemReference": null,
                        "privateInformationFlag": null,
                        "templateName": null,
                        "$id": "300100122471260",
                        "$context": {
                            "etag": "1",
                            "links": {
                                "$self": {
                                    "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/SR0000011001/messages/300100122471260"
                                }
                            }
                        }
                    }
                ],
                "hasMore": false
            }
        },
        {
            "id": "300000092500893",
            "number": "SR0000218491",
            "title": "Request for Software Installation: Adobe Photoshop",
            "createdBy": "Dinesh1",
            "timeCreated": "2017-02-28T10:24:03Z",
            "updatedBy": "Dinesh1",
            "timeUpdated": "2017-02-28T10:25:25.991Z",
            "criticalFlag": false,
            "closedDate": null,
            "openDate": "2017-02-28T10:24:04.849Z",
            "lastReopenDate": null,
            "lastResolvedDate": null,
            "problemDescription": "I need Adobe Photoshop installed on my workstation for upcoming design projects. My computer specifications meet the requirements for the software. Please install the latest version and ensure it is fully operational. Contact me if any additional information is needed.",
            "resolveDescription": null,
            "$id": "SR0000218491",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/$en-US/serviceRequests/SR0000218491"
                    }
                }
            }
        }
    ],
    "hasMore": true
}
Back to Top