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 : closedDate
Match All
Show Source
Nested Schema : createdBy
Match All
Show Source
  • Read Only: true
  • Title: Created By
    The user who created the record.
Nested Schema : criticalFlag
Match All
Show Source
  • Read Only: true
  • Title: Critical
    Indicates whether the service request is critical. If critical, the value is Y, else the value is N.
Nested Schema : id
Match All
Show Source
Nested Schema : lastReopenDate
Match All
Show Source
  • Read Only: true
  • Title: Date Reopened
    The date and time when the service request was last reopened.
Nested Schema : lastResolvedDate
Match All
Show Source
Nested Schema : messages
Match All
Show Source
Nested Schema : number
Match All
Show Source
  • Read Only: true
  • Title: Reference Number
    The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements.
Nested Schema : openDate
Match All
Show Source
  • Read Only: true
  • Title: Date Reported
    The date when the service request was reported by the customer.
Nested Schema : problemDescription
Match All
Show Source
  • Read Only: true
  • Title: Problem Description
    The service request's problem description or statement and the steps to reproduce the issue.
Nested Schema : resolveDescription
Match All
Show Source
  • Read Only: true
  • Title: Solution Description
    The description of how the service request has been resolved.
Nested Schema : timeCreated
Match All
Show Source
Nested Schema : timeUpdated
Match All
Show Source
Nested Schema : title
Match All
Show Source
  • Read Only: true
  • Title: Title
    The brief title of the service request.
Nested Schema : updatedBy
Match All
Show Source
  • Read Only: true
  • Title: Last Updated By
    The user who last updated the record.
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
  • Title: Created By
    Read Only: true
    The user who created the record.
  • Title: Message ID
    Read Only: true
    The unique identifier associated with the service request message.
  • Title: Message Content
    Read Only: true
    Indicates the content of the service request message.
  • Title: Message Number
    Read Only: true
    The public unique identifier of the service request message.
  • Title: Original System
    Read Only: true
    The reference to the service request record in the original system from which service request was imported (if imported).
  • Title: Origination Date
    Read Only: true
    The date the message was created in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Contains PII Data
    Read Only: true
    Indicates whether the message contains personally identifiable information.
  • Title: Rich Text
    Read Only: true
    Default Value: true
    Indicates whether the message content is in rich text format.
  • Title: Sent Date
    Read Only: true
    The date and time when the message was sent.
  • Title: Source System Record Created-By
    Read Only: true
    The user who created the message in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Last Update Date in Source System
    Read Only: true
    The date when the message was last updated in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Source System Record Last-Updated-By
    Read Only: true
    The user who last updated the message in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Subject
    Read Only: true
    Indicates the subject of the service request message.
  • Title: Template Name
    Read Only: true
    The name of the template that's used for outbound communication of the message.
  • Title: Created On
    Read Only: true
    The date and time when the record was created.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    The user who last updated the record.
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