Jump to

• Request
• Response
• Examples

Get a case message

get

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

Request

Path Parameters

• CaseNumber(required): string
  The alternate key identifier of the case.
• MessageId(required): integer(int64)
  The unique identifier of the message.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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-item-response

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, update, and delete an attachment.
• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case.
• CaseNumber: string
  Title: Case Number

  Maximum Length: 30

  The alternate key identifier of the case.
• Content: string (byte)
  Title: Content

  The content of the message that is not an attachment.
• CorpCurrencyCode: string
  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the message for the case.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the case message was created.
• CurcyConvRateType: string
  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.
• CurrencyCode: string
  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.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the record can be deleted.
• LastEditedDate: string (date-time)
  Title: Last Update Date

  The date when the case message was last edited.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the message for the case was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the message for the case.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the message for the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageCreatedBy: string
  Title: Message Created By

  Maximum Length: 64

  The user who created the case message.
• MessageCreationDate: string (date-time)
  Title: Message Creation Date

  The date and time when the case message was created.
• MessageId: integer (int64)
  Title: Message ID

  The unique identifier of the message.
• MessageLastUpdateDate: string (date-time)
  Title: Message Last Update Date

  The date and time when the case message was last updated.
• MessageLastUpdatedBy: string
  Title: Message Last Updated By

  Maximum Length: 64

  The user who last updated the case message.
• MessageLastUpdateLogin: string
  Title: Message Last Update Login

  Maximum Length: 32

  The application login id of the user who last updated the case message.
• MessageNumber: string
  Title: Message Number

  Maximum Length: 30

  The alternate key identifier of the message.
• MessageTypeCd: string
  Title: Message Type

  Maximum Length: 30

  Default Value: ORA_SVC_NOTE

  The code indicating the type of the message, such as internal or external.
• MessageTypeCdMeaning: string
  Title: Message Type Value

  Maximum Length: 255

  The display value corresponding to the message type lookup code for the case message.
• OriginationDate: string (date-time)
  Title: Origination Date

  The date when the message originated, or was posted.
• ParentMessageId: integer (int64)
  Title: Parent Message

  The unique identifier of the parent message.
• PostedByPartyId: integer (int64)
  Title: Posting Party ID

  The unique identifier of the user party who posted the message.
• PostedByPartyName: string
  Title: Posted by Party Name

  Read Only: true

  Maximum Length: 360

  The name of the party who posted the message.
• PostedByPartyNumber: string
  Title: Posting Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the user party who posted the message.
• RichTextFlag: boolean
  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.
• SourceCd: string
  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.
• SourceCdMeaning: string
  Title: Source Value

  Maximum Length: 255

  The display value corresponding to the source lookup code for the case message.
• StatusCd: string
  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.
• StatusCdMeaning: string
  Title: Status Value

  Maximum Length: 255

  The display value corresponding to the status lookup code for the case message.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the record can be updated.
• VisibilityCd: string
  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.
• VisibilityCdMeaning: string
  Title: Visibility Value

  Maximum Length: 255

  The display value corresponding to the visibility lookup code for the case message.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the message.",
            "nullable":false,
            "x-queryable":true
        },
        "VisibilityCd":{
            "title":"Visibility",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_SVC_INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageTypeCd":{
            "title":"Message Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the message, such as internal or external.",
            "nullable":false,
            "default":"ORA_SVC_NOTE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageLastUpdateDate":{
            "title":"Message Last Update Date",
            "type":"string",
            "description":"The date and time when the case message was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCd":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete an attachment.",
            "items":{
                "$ref":"#/components/schemas/cases-caseMessages-Attachments-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "MessageTypeCdMeaning":{
            "title":"Message Type Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the message type lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MessageTypeCd"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageLastUpdatedBy":{
            "title":"Message Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "LastEditedDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the case message was last edited.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceCdMeaning":{
            "title":"Source Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the source lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceCd"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the message for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostedByPartyId":{
            "title":"Posting Party ID",
            "type":"integer",
            "description":"The unique identifier of the user party who posted the message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the message for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the message. For example,  ORA_SVC_COMMITTED, indicates that the message is committed, or NULL.",
            "nullable":false,
            "default":"ORA_SVC_COMMITTED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentMessageId":{
            "title":"Parent Message",
            "type":"integer",
            "description":"The unique identifier of the parent message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PostedByPartyNumber":{
            "title":"Posting Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the user party who posted the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCreatedBy":{
            "title":"Message Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageLastUpdateLogin":{
            "title":"Message Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The application login id of the user who last updated the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationDate":{
            "title":"Origination Date",
            "type":"string",
            "description":"The date when the message originated, or was posted.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "MessageCreationDate":{
            "title":"Message Creation Date",
            "type":"string",
            "description":"The date and time when the case message was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"The content of the message that is not an attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PostedByPartyName":{
            "title":"Posted by Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party who posted the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RichTextFlag":{
            "title":"Rich Text Format",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the message content is in rich text format The values are Y or N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the message for the case was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the message for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, update, and delete an attachment.

Show Source

• Array of: object cases-caseMessages-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete an attachment.",
    "items":{
        "$ref":"#/components/schemas/cases-caseMessages-Attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : cases-caseMessages-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The attribute provided for the exclusive use by the attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• AttachmentsPreview: array Attachment Previews
  Title: Attachment Previews

  The attachments preview resource is used to preview the attachment pages.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the document from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a topology manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a topology manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "AttachmentsPreview":{
            "title":"Attachment Previews",
            "type":"array",
            "description":"The attachments preview resource is used to preview the attachment pages.",
            "items":{
                "$ref":"#/components/schemas/cases-caseMessages-Attachments-AttachmentsPreview-item-response"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the document from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The attribute provided for the exclusive use by the attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Attachment Previews

Type: array

Title: Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Show Source

• Array of: object cases-caseMessages-Attachments-AttachmentsPreview-item-response

{
    "title":"Attachment Previews",
    "type":"array",
    "description":"The attachments preview resource is used to preview the attachment pages.",
    "items":{
        "$ref":"#/components/schemas/cases-caseMessages-Attachments-AttachmentsPreview-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : cases-caseMessages-Attachments-AttachmentsPreview-item-response

Type: object

Show Source

• ImageHeight: integer
  Title: Image Height

  Read Only: true

  The height of the previewed image.
• ImageSource: string
  Title: Image Source

  Read Only: true

  The preview of the image in base64 encoded PNG format.
• ImageWidth: integer
  Title: Image Width

  Read Only: true

  The width of the previewed image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageNum: integer
  Title: Page Number

  Read Only: true

  The number of the page in the preview.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageSource":{
            "title":"Image Source",
            "type":"string",
            "description":"The preview of the image in base64 encoded PNG format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "PageNum":{
            "title":"Page Number",
            "type":"integer",
            "description":"The number of the page in the preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImageHeight":{
            "title":"Image Height",
            "type":"integer",
            "description":"The height of the previewed image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImageWidth":{
            "title":"Image Width",
            "type":"integer",
            "description":"The width of the previewed image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

Attachments

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments

Parameters:

• CaseNumber: $request.path.CaseNumber
• MessageId: $request.path.MessageId

The attachments resource is used to view, create, update, and delete an attachment.

MsgStatusCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_STATUS_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

MsgTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_TYPE_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

MsgVisibilityCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_VISIBILITY_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

SourceCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_SOURCE_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

YesNoLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Back to Top

Examples

The following example shows how to get a case message 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/{MessageId}

Example of Response Body

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

{
    "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"
        }
    ]
}

Back to Top