Jump to

• Request
• Response

Update a message

patch

/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}

Request

Path Parameters

• MessageId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• SrId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• channelCommunication: array Service Request Communications
  Title: Service Request Communications

  The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
• ChannelId: string
  Title: Channel

  The unique identifier of the channel.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The channel type, such a email, phone, social, and so on.
• CollabResource: string
  Title: Collaboration Resource

  The unique identifier of the collaboration network user that the internal users are communicating with.
• MessageContent: string (byte)
  Title: Message Content

  The content of the service request message.
• MessageCreatedBy: string
  Title: Created By

  Maximum Length: 64

  The user who created the message in the original source system. This is applicable if the service request message was imported from another system.
• MessageExpandingState: integer
  Title: Message Expand State

  The message expanding state.
• MessageId: integer (int64)
  Title: Message ID

  The unique identifier of the service request message.
• MessageLastUpdateDate: string (date-time)
  Title: Last Updated Date

  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.
• MessageLastUpdatedBy: string
  Title: Last Updated By

  Maximum Length: 64

  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.
• MessageLastUpdateLogin: string
  Title: Last Update Login

  Maximum Length: 32

  The login of 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.
• MessageSubTypeCd: string
  Title: Message Subtype

  Maximum Length: 30

  The service request message subtype.
• MessageTypeCd: string
  Title: Message Type Code

  Maximum Length: 30

  The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.
• NotificationProcessingStatusCd: string
  Title: Notification Processing Status Code

  Maximum Length: 30

  The notification processing status code.
• NotificationRetryCount: integer (int32)
  Title: Notification Retry Count

  The notification retry count.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The unique identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system.
• OriginationDate: string (date-time)
  Title: Origination Date

  The date the message was created in the original source system. This is applicable if the service request message was imported from another system.
• ParentMessageId: integer (int64)
  Title: Parent Message ID

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

  The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact.
• PrivateInformationFlag: boolean
  Title: Contains PII Data

  Maximum Length: 1

  Indicates whether the message contains personally identifiable information.
• ProcessingStatusCd: string
  Title: Processing Status

  Maximum Length: 30

  Default Value: ORA_SVC_READY

  The processing status of the message. The accepted values are Ready, Processing, Error, and Success.
• RichTextFlag: boolean
  Title: Rich Text

  Maximum Length: 1

  Default Value: true

  Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N.
• SentDate: string (date-time)
  Title: Sent Date

  The date and time when the message was sent.
• SocialPrivateFlag: boolean
  Title: Private Message

  Maximum Length: 1

  Indicates whether the service request was created from a private social post.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  The source of the message.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request to which the message is associated.
• SrInlineAttachmentIds: string
  Title: Inline Attachment Identifiers

  Maximum Length: 1000

  The list of inline attachment identifiers associated with the service request
• StatusCd: string
  Title: Status Code

  Maximum Length: 30

  The status of the message. The accepted values are Draft, Committed, and Corrected.
• Subject: string
  Title: Subject

  Maximum Length: 1000

  The subject of the service request message.
• TemplateName: string
  Title: Template Name

  Maximum Length: 240

  The name of the template that's used for outbound communication of the message.
• VisibilityCd: string
  Title: Visibility Code

  Maximum Length: 30

  The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.

{
    "type":"object",
    "properties":{
        "MessageContent":{
            "title":"Message Content",
            "type":"string",
            "description":"The content of the service request message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"SrMessageEO.MessageContent",
                "protectionObjectTitle":"Message Content",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Message Content"
            }
        },
        "NotificationProcessingStatusCd":{
            "title":"Notification Processing Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The notification processing status code.",
            "nullable":true
        },
        "PrivateInformationFlag":{
            "title":"Contains PII Data",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the message contains personally identifiable information.",
            "nullable":true
        },
        "VisibilityCd":{
            "title":"Visibility Code",
            "maxLength":"30",
            "type":"string",
            "description":"The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MessageTypeCd":{
            "title":"Message Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date and time when the message was sent.",
            "format":"date-time",
            "nullable":true
        },
        "MessageLastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-item-patch-request"
            }
        },
        "ChannelId":{
            "title":"Channel",
            "type":"string",
            "description":"The unique identifier of the channel.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ChannelTypeCd"
                ]
            }
        },
        "MessageExpandingState":{
            "title":"Message Expand State",
            "type":"integer",
            "description":"The message expanding state.",
            "nullable":true
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The source of the message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CollabResource":{
            "title":"Collaboration Resource",
            "type":"string",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProcessingStatusCd":{
            "title":"Processing Status",
            "maxLength":"30",
            "type":"string",
            "description":"The processing status of the message. The accepted values are Ready, Processing, Error, and Success.",
            "nullable":true,
            "default":"ORA_SVC_READY"
        },
        "MessageLastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdatedBy"
                ]
            }
        },
        "MessageSubTypeCd":{
            "title":"Message Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"The service request message subtype.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "TemplateName":{
            "title":"Template Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the template that's used for outbound communication of the message.",
            "nullable":true
        },
        "channelCommunication":{
            "title":"Service Request Communications",
            "type":"array",
            "description":"The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-messages-channelCommunication-item-patch-request"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request to which the message is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SocialPrivateFlag":{
            "title":"Private Message",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the service request was created from a private social post.",
            "nullable":false
        },
        "PostedByPartyId":{
            "title":"Posted by ID",
            "type":"integer",
            "description":"The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the message. The accepted values are Draft, Committed, and Corrected.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system.",
            "nullable":true
        },
        "ParentMessageId":{
            "title":"Parent Message ID",
            "type":"integer",
            "description":"The unique identifier of the parent message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotificationRetryCount":{
            "title":"Notification Retry Count",
            "type":"integer",
            "description":"The notification retry count.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            }
        },
        "Subject":{
            "title":"Subject",
            "maxLength":"1000",
            "type":"string",
            "description":"The subject of the service request message.",
            "nullable":true
        },
        "MessageCreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the message in the original source system. This is applicable if the service request message was imported from another system.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "MessageLastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of 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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LastUpdateLogin"
                ]
            }
        },
        "OriginationDate":{
            "title":"Origination Date",
            "type":"string",
            "description":"The date the message was created in the original source system. This is applicable if the service request message was imported from another system.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CreationDate"
                ]
            }
        },
        "RichTextFlag":{
            "title":"Rich Text",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N.",
            "nullable":false,
            "default":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The channel type, such a email, phone, social, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the service request message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "SrInlineAttachmentIds":{
            "title":"Inline Attachment Identifiers",
            "maxLength":"1000",
            "type":"string",
            "description":"The list of inline attachment identifiers associated with the service request",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object internalServiceRequests-messages-Attachment-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-item-patch-request"
    }
}

Nested Schema : Service Request Communications

Type: array

Title: Service Request Communications

The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Show Source

• Array of: object schema

{
    "title":"Service Request Communications",
    "type":"array",
    "description":"The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-messages-channelCommunication-item-patch-request"
    }
}

Nested Schema : internalServiceRequests-messages-Attachment-item-patch-request

Type: object

Show Source

• AttachmentsDFFVL: array AttachmentsDFFVL
• AttachmentsPreview: array Attachments Preview
  Title: Attachments Preview

  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
• 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 document ID 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.
• 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 to assign to a new 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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "AttachmentsDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "AttachmentsPreview":{
            "title":"Attachments Preview",
            "type":"array",
            "description":"The attachments preview resource is used to preview the attachment pages.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-AttachmentsPreview-item-patch-request"
            }
        },
        "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"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

Nested Schema : AttachmentsDFFVL

Type: array

Show Source

• Array of: object internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Attachments Preview

Type: array

Title: Attachments Preview

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

Show Source

• Array of: object internalServiceRequests-messages-Attachment-AttachmentsPreview-item-patch-request

{
    "title":"Attachments Preview",
    "type":"array",
    "description":"The attachments preview resource is used to preview the attachment pages.",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-AttachmentsPreview-item-patch-request"
    }
}

Nested Schema : internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• AttachedDocumentId: integer (int64)

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : internalServiceRequests-messages-Attachment-AttachmentsPreview-item-patch-request

Type: object

Show Source

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

Nested Schema : schema

Type: object

Show Source

• ChannelDisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the channel.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel.
• CollabResourceId: integer (int64)
  Title: Collaboration Resource Identifier

  The unique identifier of the collaboration network user that the internal users are communicating with.
• ContactPointId: integer (int64)
  Title: Contact Point ID

  The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address while the contact point of a person for twitter would be the twitter handle.
• InboundObjectId: integer (int64)
  Title: Inbound Message Object Identifier

  The unique identifier of the inbound object that resulted in the creation of the service request.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the person who's being communicated with.
• PartyViaEndPoint: string
  Title: Party Endpoint

  Maximum Length: 1000

  The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.
• PersonId: integer (int64)
  Title: Person ID

  The unique person ID of the contact.
• PostIdentifier: string
  Title: Post Identifier

  Maximum Length: 1000

  The unique identifier of the social media post record that was used to create the service request or the service request message.
• RoutingCd: string
  Title: Routing Code

  Maximum Length: 30

  The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.

{
    "type":"object",
    "properties":{
        "RoutingCd":{
            "title":"Routing Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the person who's being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CollabResourceId":{
            "title":"Collaboration Resource Identifier",
            "type":"integer",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address while the contact point of a person for twitter would be the twitter handle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PostIdentifier":{
            "title":"Post Identifier",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the social media post record that was used to create the service request or the service request message.",
            "nullable":true
        },
        "PartyViaEndPoint":{
            "title":"Party Endpoint",
            "maxLength":"1000",
            "type":"string",
            "description":"The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ChannelViaEO.PartyViaEndPoint",
                "protectionObjectTitle":"Party Endpoint",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Party Endpoint"
            }
        },
        "InboundObjectId":{
            "title":"Inbound Message Object Identifier",
            "type":"integer",
            "description":"The unique identifier of the inbound object that resulted in the creation of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : internalServiceRequests-messages-item-response

Type: object

Show Source

• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• channelCommunication: array Service Request Communications
  Title: Service Request Communications

  The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
• ChannelId: string
  Title: Channel

  The unique identifier of the channel.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The channel type, such a email, phone, social, and so on.
• CollabResource: string
  Title: Collaboration Resource

  The unique identifier of the collaboration network user that the internal users are communicating with.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the message.
• CreatedByEmailAddress: string
  Title: Created by Email ID

  Read Only: true

  Maximum Length: 320

  The email Id of the person who created the service request message.
• CreatedByPartyId: string
  Title: Created by Party ID

  Read Only: true

  Maximum Length: 80

  The unique party identifier of the person who created the service request message.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the message was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the user has access to delete the record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MessageContent: string (byte)
  Title: Message Content

  The content of the service request message.
• MessageCreatedBy: string
  Title: Created By

  Maximum Length: 64

  The user who created the message in the original source system. This is applicable if the service request message was imported from another system.
• MessageExpandingState: integer
  Title: Message Expand State

  The message expanding state.
• MessageId: integer (int64)
  Title: Message ID

  The unique identifier of the service request message.
• MessageLastUpdateDate: string (date-time)
  Title: Last Updated Date

  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.
• MessageLastUpdatedBy: string
  Title: Last Updated By

  Maximum Length: 64

  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.
• MessageLastUpdateLogin: string
  Title: Last Update Login

  Maximum Length: 32

  The login of 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.
• MessageNumber: string
  Title: Message Number

  Maximum Length: 30

  The public unique identifier of the service request message.
• MessageSubTypeCd: string
  Title: Message Subtype

  Maximum Length: 30

  The service request message subtype.
• MessageTypeCd: string
  Title: Message Type Code

  Maximum Length: 30

  The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.
• NetworkTypeCd: string
  Title: Network

  Read Only: true

  Maximum Length: 30

  The type of social network.
• NotificationProcessingStatusCd: string
  Title: Notification Processing Status Code

  Maximum Length: 30

  The notification processing status code.
• NotificationRetryCount: integer (int32)
  Title: Notification Retry Count

  The notification retry count.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object.
• ObjectTypeCd: string
  Title: Object Type Code

  Maximum Length: 30

  Default Value: SVC_SR_MESSAGES

  The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The unique identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system.
• OriginationDate: string (date-time)
  Title: Origination Date

  The date the message was created in the original source system. This is applicable if the service request message was imported from another system.
• ParentMessageId: integer (int64)
  Title: Parent Message ID

  The unique identifier of the parent message.
• PartyName: string
  Title: Posted By

  Read Only: true

  Maximum Length: 360

  The party name of the user who posted the message. The user can be an internal resource or a customer contact.
• PostedByPartyId: integer (int64)
  Title: Posted by ID

  The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact.
• PostedByPartyNumber: string
  Title: Posted by Party Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the party identifier of the person posting the service request message.
• PrivateInformationFlag: boolean
  Title: Contains PII Data

  Maximum Length: 1

  Indicates whether the message contains personally identifiable information.
• ProcessingId: integer (int64)
  Title: Processing ID

  Read Only: true

  The unique identifier of the processing.
• ProcessingStatusCd: string
  Title: Processing Status

  Maximum Length: 30

  Default Value: ORA_SVC_READY

  The processing status of the message. The accepted values are Ready, Processing, Error, and Success.
• ReplyToMessageId: integer (int64)
  Title: Reply to Message ID

  Read Only: true

  The unique identifier of the customer message to which the agent is replying to.
• RichTextFlag: boolean
  Title: Rich Text

  Maximum Length: 1

  Default Value: true

  Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N.
• RootMessageId: integer (int64)
  Title: Root Message Identifier

  Read Only: true

  The identifier of the root message in the message hierarchy.
• RootThreadCount: integer
  Title: Root Message Thread Count

  Read Only: true

  The number of messages under a root message in a service request.
• RootThreadLastUpdateDate: string (date-time)
  Title: Root Message Thread Last Updated Date

  Read Only: true

  The last updated date for all messages under the root message in a service request.
• RootThreadMessageLastUpdateDate: string (date-time)
  Title: Root Thread Message Last Updated Date

  Read Only: true

  The date when all messages under the root message in a service request were last updated.
• SentDate: string (date-time)
  Title: Sent Date

  The date and time when the message was sent.
• SocialPrivateFlag: boolean
  Title: Private Message

  Maximum Length: 1

  Indicates whether the service request was created from a private social post.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  The source of the message.
• SrBUOrgId: integer (int64)
  Title: Service Request Business Unit

  Read Only: true

  The identifier of the business unit associated with the service request.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request to which the message is associated.
• SrInlineAttachmentIds: string
  Title: Inline Attachment Identifiers

  Maximum Length: 1000

  The list of inline attachment identifiers associated with the service request
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The alternative key for the service request number.
• SrStripeCd: string
  Title: Service Request Application Stripe

  Read Only: true

  Maximum Length: 30

  The application stripe of the service request.
• StatusCd: string
  Title: Status Code

  Maximum Length: 30

  The status of the message. The accepted values are Draft, Committed, and Corrected.
• Subject: string
  Title: Subject

  Maximum Length: 1000

  The subject of the service request message.
• TemplateName: string
  Title: Template Name

  Maximum Length: 240

  The name of the template that's used for outbound communication of the message.
• ThreadCount: integer
  Title: Thread Count

  Read Only: true

  The number of threads in a service request message.
• ThreadHierarchyLevel: integer
  Title: Thread Hierarchy Level

  Read Only: true

  The thread hierarchy level.
• ThreadId: integer
  Title: Thread Identifier

  Read Only: true

  The unique identifier of the service request message thread.
• ThreadLastUpdateDate: string (date-time)
  Title: Thread Last Updated Date

  Read Only: true

  The date when the thread was last updated.
• ThreadMessageLastUpdateDate: string (date-time)
  Title: Thread Message Last Updated Date

  Read Only: true

  The date when the thread message was last updated.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record.
• VisibilityCd: string
  Title: Visibility Code

  Maximum Length: 30

  The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageContent":{
            "title":"Message Content",
            "type":"string",
            "description":"The content of the service request message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"SrMessageEO.MessageContent",
                "protectionObjectTitle":"Message Content",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Message Content"
            }
        },
        "ThreadMessageLastUpdateDate":{
            "title":"Thread Message Last Updated Date",
            "type":"string",
            "description":"The date when the thread message was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NotificationProcessingStatusCd":{
            "title":"Notification Processing Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The notification processing status code.",
            "nullable":true,
            "x-queryable":true
        },
        "PrivateInformationFlag":{
            "title":"Contains PII Data",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the message contains personally identifiable information.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingId":{
            "title":"Processing ID",
            "type":"integer",
            "description":"The unique identifier of the processing.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date and time when the message was sent.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Posted By",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the user who posted the message. The user can be an internal resource or a customer contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageLastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-item-response"
            }
        },
        "MessageExpandingState":{
            "title":"Message Expand State",
            "type":"integer",
            "description":"The message expanding state.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplyToMessageId":{
            "title":"Reply to Message ID",
            "type":"integer",
            "description":"The unique identifier of the customer message to which the agent is replying to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The source of the message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CollabResource":{
            "title":"Collaboration Resource",
            "type":"string",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ThreadHierarchyLevel":{
            "title":"Thread Hierarchy Level",
            "type":"integer",
            "description":"The thread hierarchy level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrStripeCd":{
            "title":"Service Request Application Stripe",
            "maxLength":"30",
            "type":"string",
            "description":"The application stripe of the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatusCd":{
            "title":"Processing Status",
            "maxLength":"30",
            "type":"string",
            "description":"The processing status of the message. The accepted values are Ready, Processing, Error, and Success.",
            "nullable":true,
            "default":"ORA_SVC_READY",
            "x-queryable":true
        },
        "MessageLastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdatedBy"
                ]
            },
            "x-queryable":true
        },
        "CreatedByPartyId":{
            "title":"Created by Party ID",
            "maxLength":"80",
            "type":"string",
            "description":"The unique party identifier of the person who created the service request message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.",
            "nullable":false,
            "default":"SVC_SR_MESSAGES",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RootThreadMessageLastUpdateDate":{
            "title":"Root Thread Message Last Updated Date",
            "type":"string",
            "description":"The date when all messages under the root message in a service request were last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostedByPartyId":{
            "title":"Posted by ID",
            "type":"integer",
            "description":"The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact.",
            "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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RootMessageId":{
            "title":"Root Message Identifier",
            "type":"integer",
            "description":"The identifier of the root message in the message hierarchy.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NotificationRetryCount":{
            "title":"Notification Retry Count",
            "type":"integer",
            "description":"The notification retry count.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "OriginationDate":{
            "title":"Origination Date",
            "type":"string",
            "description":"The date the message was created in the original source system. This is applicable if the service request message was imported from another system.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CreationDate"
                ]
            },
            "x-queryable":true
        },
        "RichTextFlag":{
            "title":"Rich Text",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The channel type, such a email, phone, social, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootThreadLastUpdateDate":{
            "title":"Root Message Thread Last Updated Date",
            "type":"string",
            "description":"The last updated date for all messages under the root message in a service request.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":"30",
            "type":"string",
            "description":"The type of social network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the service request message.",
            "nullable":false,
            "x-queryable":true
        },
        "SrBUOrgId":{
            "title":"Service Request Business Unit",
            "type":"integer",
            "description":"The identifier of the business unit associated with the service request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VisibilityCd":{
            "title":"Visibility Code",
            "maxLength":"30",
            "type":"string",
            "description":"The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageTypeCd":{
            "title":"Message Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel",
            "type":"string",
            "description":"The unique identifier of the channel.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ChannelTypeCd"
                ]
            }
        },
        "ThreadLastUpdateDate":{
            "title":"Thread Last Updated Date",
            "type":"string",
            "description":"The date when the thread was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ThreadId":{
            "title":"Thread Identifier",
            "type":"integer",
            "description":"The unique identifier of the service request message thread.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageSubTypeCd":{
            "title":"Message Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"The service request message subtype.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Template Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the template that's used for outbound communication of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "channelCommunication":{
            "title":"Service Request Communications",
            "type":"array",
            "description":"The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-messages-channelCommunication-item-response"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request to which the message is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SocialPrivateFlag":{
            "title":"Private Message",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the service request was created from a private social post.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the message. The accepted values are Draft, Committed, and Corrected.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentMessageId":{
            "title":"Parent Message ID",
            "type":"integer",
            "description":"The unique identifier of the parent message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":"1000",
            "type":"string",
            "description":"The subject of the service request message.",
            "nullable":true,
            "x-queryable":true
        },
        "PostedByPartyNumber":{
            "title":"Posted by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the party identifier of the person posting the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the message in the original source system. This is applicable if the service request message was imported from another system.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            },
            "x-queryable":true
        },
        "CreatedByEmailAddress":{
            "title":"Created by Email ID",
            "maxLength":"320",
            "type":"string",
            "description":"The email Id of the person who created the service request message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThreadCount":{
            "title":"Thread Count",
            "type":"integer",
            "description":"The number of threads in a service request message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageLastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of 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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LastUpdateLogin"
                ]
            },
            "x-queryable":true
        },
        "RootThreadCount":{
            "title":"Root Message Thread Count",
            "type":"integer",
            "description":"The number of messages under a root message in a service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the service request message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrInlineAttachmentIds":{
            "title":"Inline Attachment Identifiers",
            "maxLength":"1000",
            "type":"string",
            "description":"The list of inline attachment identifiers associated with the service request",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object internalServiceRequests-messages-Attachment-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-item-response"
    }
}

Nested Schema : Service Request Communications

Type: array

Title: Service Request Communications

The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Show Source

• Array of: object internalServiceRequests-messages-channelCommunication-item-response

{
    "title":"Service Request Communications",
    "type":"array",
    "description":"The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-messages-channelCommunication-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 : internalServiceRequests-messages-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  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.
• AttachmentsDFFVL: array AttachmentsDFFVL
• AttachmentsPreview: array Attachments Preview
  Title: Attachments Preview

  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 document ID 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 to assign to a new 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
        },
        "AttachmentsDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-response"
            },
            "x-cardinality":"1"
        },
        "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":"Attachments Preview",
            "type":"array",
            "description":"The attachments preview resource is used to preview the attachment pages.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-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 document ID 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 to assign to a new 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":"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 : AttachmentsDFFVL

Type: array

Show Source

• Array of: object internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Attachments Preview

Type: array

Title: Attachments Preview

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

Show Source

• Array of: object internalServiceRequests-messages-Attachment-AttachmentsPreview-item-response

{
    "title":"Attachments Preview",
    "type":"array",
    "description":"The attachments preview resource is used to preview the attachment pages.",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-messages-Attachment-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 : internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• AttachedDocumentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Nested Schema : internalServiceRequests-messages-Attachment-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 : internalServiceRequests-messages-channelCommunication-item-response

Type: object

Show Source

• ChannelAccountName: string
  Title: Account Name

  Read Only: true

  Maximum Length: 400

  The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.
• ChannelDisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the channel.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel.
• ChannelShortName: string
  Title: Channel Short Name

  Maximum Length: 450

  The public unique identifier of the channel.
• ChannelTypeCd: string
  Title: Channel Type

  Read Only: true

  Maximum Length: 30

  The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
• CollabId: string
  Title: Collaboration ID

  Read Only: true

  Maximum Length: 255

  The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id of a user.
• CollabName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 400

  The user name of the external user on the collaboration network.
• CollabResourceId: integer (int64)
  Title: Collaboration Resource Identifier

  The unique identifier of the collaboration network user that the internal users are communicating with.
• ContactPointId: integer (int64)
  Title: Contact Point ID

  The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address while the contact point of a person for twitter would be the twitter handle.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the communication channel was created.
• InboundObjectId: integer (int64)
  Title: Inbound Message Object Identifier

  The unique identifier of the inbound object that resulted in the creation of the service request.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication channel was last updated.
• LastUpdatedBy: string
  Title: Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication channel.
• LastUpdateLogin: string
  Title: Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the communication channel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageNumber: string
  Title: Message Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the service request message.
• NetworkTypeCd: string
  Title: Network

  Read Only: true

  Maximum Length: 30

  The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.
• ObjectTypeCd: string
  Title: Object Type

  Read Only: true

  Maximum Length: 30

  Default Value: SVC_SR_MESSAGES

  The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the person who's being communicated with.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The party name of the person who's being communicated with.
• PartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the contact associated with the service request message.
• PartyViaEndPoint: string
  Title: Party Endpoint

  Maximum Length: 1000

  The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.
• PersonId: integer (int64)
  Title: Person ID

  The unique person ID of the contact.
• PostIdentifier: string
  Title: Post Identifier

  Maximum Length: 1000

  The unique identifier of the social media post record that was used to create the service request or the service request message.
• ResourceId: integer (int64)
  Title: Resource ID

  Read Only: true

  The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.
• ResourceTypeCd: string
  Title: Resource Type

  Read Only: true

  Maximum Length: 30

  The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.
• RoutingCd: string
  Title: Routing Code

  Maximum Length: 30

  The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.
• ViaId: integer (int64)
  Title: ID

  Read Only: true

  The unique identifier of the service request channel communication record.

{
    "type":"object",
    "properties":{
        "ChannelAccountName":{
            "title":"Account Name",
            "maxLength":"400",
            "type":"string",
            "description":"The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the communication channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViaId":{
            "title":"ID",
            "type":"integer",
            "description":"The unique identifier of the service request channel communication record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id of a user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the person who's being communicated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollabName":{
            "title":"Resource Name",
            "maxLength":"400",
            "type":"string",
            "description":"The user name of the external user on the collaboration network.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoutingCd":{
            "title":"Routing Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address while the contact point of a person for twitter would be the twitter handle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "default":"SVC_SR_MESSAGES",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PostIdentifier":{
            "title":"Post Identifier",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the social media post record that was used to create the service request or the service request message.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyViaEndPoint":{
            "title":"Party Endpoint",
            "maxLength":"1000",
            "type":"string",
            "description":"The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ChannelViaEO.PartyViaEndPoint",
                "protectionObjectTitle":"Party Endpoint",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Party Endpoint"
            },
            "x-queryable":true
        },
        "InboundObjectId":{
            "title":"Inbound Message Object Identifier",
            "type":"integer",
            "description":"The unique identifier of the inbound object that resulted in the creation of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the person who's being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollabResourceId":{
            "title":"Collaboration Resource Identifier",
            "type":"integer",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelShortName":{
            "title":"Channel Short Name",
            "maxLength":"450",
            "type":"string",
            "description":"The public unique identifier of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the communication channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

Links

Attachment

Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment

Parameters:

• MessageId: $request.path.MessageId
• SrId: $request.path.SrId

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

ChannelLOV

Operation: /crmRestApi/resources/11.13.18.05/channels

Parameters:

• finder: EnabledChannelByBUAndStripeAndTypeFinder%3BChannelTypeCd%3D{ChannelTypeCd}%2CStripeCd%3D{SrStripeCd}%2CBUOrgId%3D{SrBUOrgId}

The following properties are defined on the LOV link relation:

• Source Attribute: ChannelId; Target Attribute: ChannelId
• Display Attribute: DisplayName

ChannelTypeCdLookup

Operation: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV

Parameters:

• finder: IsActiveIsEnabledFinder

The following properties are defined on the LOV link relation:

• Source Attribute: ChannelTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

CollabResourceLOV

Operation: /crmRestApi/resources/11.13.18.05/collaborationRecipientLookups

The following properties are defined on the LOV link relation:

• Source Attribute: CollabResource; Target Attribute: DisplayName
• Display Attribute: DisplayName, Name, ResourceType

MessageSubTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_SUB_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: MessageSubTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

MessageTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: MessageTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

NetworkTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: NetworkTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

SourceCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: SourceCd; Target Attribute: LookupCode
• Display Attribute: Meaning

StatusCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_STATUS_CD

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCd; Target Attribute: LookupCode
• Display Attribute: Meaning

VisibilityCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_VISIBILITY_CD

The following properties are defined on the LOV link relation:

• Source Attribute: VisibilityCd; Target Attribute: LookupCode
• Display Attribute: Meaning

channelCommunication

Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication

Parameters:

• MessageId: $request.path.MessageId
• SrId: $request.path.SrId

The channel communications resource is used to view, create, update, and delete a channel communication. It's information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Back to Top