Get all case messages

get

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a case message with the specified primary key.
      Finder Variables:
      • MessageId; integer; The unique identifier of the message.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CaseId; integer; The unique identifier of the case.
    • CaseNumber; string; The alternate key identifier of the case.
    • CreatedBy; string; The user who created the message for the case.
    • CreationDate; string; The date and time when the case message was created.
    • LastEditedDate; string; The date when the case message was last edited.
    • LastUpdateDate; string; The date and time when the message for the case was last updated.
    • LastUpdatedBy; string; The user who last updated the message for the case.
    • MessageCreatedBy; string; The user who created the case message.
    • MessageCreationDate; string; The date and time when the case message was created.
    • MessageId; integer; The unique identifier of the message.
    • MessageLastUpdateDate; string; The date and time when the case message was last updated.
    • MessageLastUpdateLogin; string; The application login id of the user who last updated the case message.
    • MessageLastUpdatedBy; string; The user who last updated the case message.
    • MessageNumber; string; The alternate key identifier of the message.
    • MessageTypeCd; string; The code indicating the type of the message, such as internal or external.
    • MessageTypeCdMeaning; string; The display value corresponding to the message type lookup code for the case message.
    • OriginationDate; string; The date when the message originated, or was posted.
    • ParentMessageId; integer; The unique identifier of the parent message.
    • PostedByPartyId; integer; The unique identifier of the user party who posted the message.
    • PostedByPartyName; string; The name of the party who posted the message.
    • PostedByPartyNumber; string; The alternate key identifier of the user party who posted the message.
    • RichTextFlag; boolean; Indicates whether the message content is in rich text format The values are Y or N.
    • SourceCd; string; The code indicating how the message was entered into the system. For example, ORA_SVC_API, case message was created through REST API, ORA_SVC_AGENT_UI, case message was created in the UI), or ORA_SVC_MOBILE, case message was created through a mobile device.
    • SourceCdMeaning; string; The display value corresponding to the source lookup code for the case message.
    • StatusCd; string; The code indicating the status of the message. For example, ORA_SVC_COMMITTED, indicates that the message is committed, or NULL.
    • StatusCdMeaning; string; The display value corresponding to the status lookup code for the case message.
    • VisibilityCd; string; The code indicating the visibility level of the case message. For example, ORA_SVC_EXTERNAL, case message is visible to internal and external users, or ORA_SVC_INTERNAL, case message is visible to internal users only.
    • VisibilityCdMeaning; string; The display value corresponding to the visibility lookup code for the case message.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : cases-caseMessages
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : cases-caseMessages-item-response
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, update, and delete an attachment.
  • Title: Case ID
    The unique identifier of the case.
  • Title: Case Number
    Maximum Length: 30
    The alternate key identifier of the case.
  • Title: Content
    The content of the message that is not an attachment.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the message for the case.
  • Title: Creation Date
    Read Only: true
    The date and time when the case message was created.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency Code
    Maximum Length: 15
    The currency code associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Delete
    Read Only: true
    Indicates whether the record can be deleted.
  • Title: Last Update Date
    The date when the case message was last edited.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the message for the case was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the message for the case.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the message for the case.
  • Links
  • Title: Message Created By
    Maximum Length: 64
    The user who created the case message.
  • Title: Message Creation Date
    The date and time when the case message was created.
  • Title: Message ID
    The unique identifier of the message.
  • Title: Message Last Update Date
    The date and time when the case message was last updated.
  • Title: Message Last Updated By
    Maximum Length: 64
    The user who last updated the case message.
  • Title: Message Last Update Login
    Maximum Length: 32
    The application login id of the user who last updated the case message.
  • Title: Message Number
    Maximum Length: 30
    The alternate key identifier of the message.
  • Title: Message Type
    Maximum Length: 30
    Default Value: ORA_SVC_NOTE
    The code indicating the type of the message, such as internal or external.
  • Title: Message Type Value
    Maximum Length: 255
    The display value corresponding to the message type lookup code for the case message.
  • Title: Origination Date
    The date when the message originated, or was posted.
  • Title: Parent Message
    The unique identifier of the parent message.
  • Title: Posting Party ID
    The unique identifier of the user party who posted the message.
  • Title: Posted by Party Name
    Read Only: true
    Maximum Length: 360
    The name of the party who posted the message.
  • Title: Posting Party Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the user party who posted the message.
  • Title: Rich Text Format
    Maximum Length: 1
    Default Value: true
    Indicates whether the message content is in rich text format The values are Y or N.
  • Title: Source
    Maximum Length: 30
    The code indicating how the message was entered into the system. For example, ORA_SVC_API, case message was created through REST API, ORA_SVC_AGENT_UI, case message was created in the UI), or ORA_SVC_MOBILE, case message was created through a mobile device.
  • Title: Source Value
    Maximum Length: 255
    The display value corresponding to the source lookup code for the case message.
  • Title: Status Code
    Maximum Length: 30
    Default Value: ORA_SVC_COMMITTED
    The code indicating the status of the message. For example, ORA_SVC_COMMITTED, indicates that the message is committed, or NULL.
  • Title: Status Value
    Maximum Length: 255
    The display value corresponding to the status lookup code for the case message.
  • Title: Update
    Read Only: true
    Indicates whether the record can be updated.
  • Title: Visibility
    Maximum Length: 30
    Default Value: ORA_SVC_INTERNAL
    The code indicating the visibility level of the case message. For example, ORA_SVC_EXTERNAL, case message is visible to internal and external users, or ORA_SVC_INTERNAL, case message is visible to internal users only.
  • Title: Visibility Value
    Maximum Length: 255
    The display value corresponding to the visibility lookup code for the case message.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, update, and delete an attachment.
Show Source
Nested Schema : cases-caseMessages-Attachments-item-response
Type: object
Show Source
Nested Schema : Attachment Previews
Type: array
Title: Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : cases-caseMessages-Attachments-AttachmentsPreview-item-response
Type: object
Show Source
Back to Top

Examples

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

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages

Example of Response Body

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

  {
    "items": [
        {
            "CaseId": 300100215793299,
            "CorpCurrencyCode": null,
            "CreatedBy": "AUTOUICASE1",
            "CreationDate": "2021-08-23T06:29:12+00:00",
            "CurcyConvRateType": null,
            "CurrencyCode": null,
            "LastEditedDate": "2021-08-23T06:29:12.001+00:00",
            "LastUpdateDate": "2021-08-23T06:29:12.867+00:00",
            "LastUpdateLogin": "C9E4F38A864CEDEEE05323EAF40A0051",
            "LastUpdatedBy": "AUTOUICASE1",
            "MessageCreatedBy": "AUTOUICASE1",
            "MessageCreationDate": "2021-08-23T06:29:12+00:00",
            "MessageId": 300100215798773,
            "MessageLastUpdateDate": "2021-08-23T06:29:12.001+00:00",
            "MessageLastUpdateLogin": "C9E4F38A864CEDEEE05323EAF40A0051",
            "MessageLastUpdatedBy": "AUTOUICASE1",
            "MessageTypeCd": "ORA_SVC_NOTE",
            "OriginationDate": "2021-08-23T06:29:12+00:00",
            "ParentMessageId": null,
            "PostedByPartyId": null,
            "PostedByPartyNumber": null,
            "RichTextFlag": true,
            "SourceCd": null,
            "VisibilityCd": "ORA_SVC_INTERNAL",
            "PostedByPartyName": null,
            "CaseNumber": "CDRM_4003",
            "StatusCd": "ORA_SVC_COMMITTED",
            "UpdateFlag": true,
            "DeleteFlag": true,
            "MessageNumber": "CDRM_4003",
            "MessageTypeCdMeaning": "Note",
            "SourceCdMeaning": null,
            "VisibilityCdMeaning": "Internal",
            "StatusCdMeaning": "Committed",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773",
                    "name": "caseMessages",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773",
                    "name": "caseMessages",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
                    "name": "cases",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgStatusCdLookup",
                    "name": "MsgStatusCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/SourceCdLookup",
                    "name": "SourceCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgVisibilityCdLookup",
                    "name": "MsgVisibilityCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgTypeCdLookup",
                    "name": "MsgTypeCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/YesNoLookup",
                    "name": "YesNoLookup",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/enclosure/Content",
                    "name": "Content",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages",
            "name": "caseMessages",
            "kind": "collection"
        }
    ]
}
Back to Top