Jump to

• Request
• Response

Update a conversation message

patch

/crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}

Request

Path Parameters

• MessageNumber(required): string
  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

• AssignedToPartyId: integer (int64)
  Title: Assigned To

  The unique identifier of the resource party to whom the conversation message is assigned. This isn't used currently and reserved for future.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel associated with the conversation message.
• ChannelTypeCd: string
  Title: Channel Type Code

  Maximum Length: 30

  The code indicating the type of channel associated with the conversation message.
• ConversationBUOrgId: integer (int64)
  Title: Conversation Business Unit

  The unique identifier of the business unit organization associated with the conversation.
• ConversationStripeCd: string
  Title: Conversation Stripe Code

  Maximum Length: 255

  The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.
• ConversationTypeCd: string
  Title: Conversation Type

  Maximum Length: 255

  The code indicating the type of the conversation, such as Customer or Collaboration.
• InboundStatusCd: string
  Title: Inbound Message Status Code

  Maximum Length: 30

  The status code of an inbound or internal collaboration message.
• MessageAlternateId: string
  Title: Message Alternate ID

  Maximum Length: 100

  The alternate identifier of the message.
• MessageContent: string (byte)
  Title: Message Content

  The content of the conversation message, such as the contents of an email.
• MessageSendDate: string (date-time)
  Title: Message Send Date

  The date when an outbound message should be sent.
• MessageStatusCd: string
  Title: Message Status Code

  Maximum Length: 30

  The status code of a message, such as DRAFT or COMMITTED.
• MessageTemplate: string
  Title: Message Template

  Maximum Length: 320

  The name of the template associated with the conversation message.
• MessageTemplateObjTypeCd: string
  Title: Message Template Object Type

  Maximum Length: 30

  The object type for which the conversation message was created, such as Service Request, Opportunities, Sales Lead.
• MessageTitle: string
  Title: Subject

  Maximum Length: 1000

  The title of the conversation message.
• MessageTypeCd: string
  Title: Message Type Code

  Maximum Length: 30

  The code indicating the type of the conversation message, such as INBOUND or OUTBOUND.
• MsgTemplateObjectId: integer (int64)
  Title: Message Template Object ID

  The unique identifier of the object associated with the message template.
• OriginalSystemReference: string
  Title: Original Application Reference

  Maximum Length: 1000

  The original application reference of an imported conversation message.
• ProcessingAPPCd: string
  Title: Processing Application Code

  Maximum Length: 30

  The code indicating the application that will be processing the message such as Oracle Marketing Cloud or CX Sales. Typically, this is used for outbound messages.
• ProcessingAPPContentReferenceId: string
  Title: Processing Application Content Reference ID

  Maximum Length: 30

  The reference ID of the message's content in the application processing the message. This is used when an application other than CX Sales processes the outbound message such as Oracle Marketing Cloud.
• ProcessingAPPMsgId: string
  Title: Processing Application Message ID

  Maximum Length: 30

  The processing application's message identifier. This is used when an application other than CX Sales processes the outbound message such as Oracle Marketing Cloud.
• ProcessingStatusCd: string
  Title: Processing Status Code

  Maximum Length: 30

  The code indicating the processing status of the conversation message, such as WAITING, READY, ERROR, or SUCCESS.
• ProcessingStatusDetail: string
  Title: Processing Status Detail

  Maximum Length: 1000

  The details of the conversation message processing status.
• QueueId: integer (int64)
  Title: Queue ID

  The unique identifier of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.
• recipients: array Conversation Message Recipients
  Title: Conversation Message Recipients

  Message recipients.
• ReportedDate: string (date-time)
  Title: Reported Date

  The date when the conversation message was reported. Typically this date would be the same as the created date unless the message was imported.
• SenderAlternateId: integer (int64)
  Title: Sender Alternate ID

  The alternate identifier of the message sender.
• SenderFreeFormAddress: string
  Title: Sender Free Form Address

  Maximum Length: 320

  The free form address of the sender of the message. For example, the email address of the sender.
• SenderPartyId: integer (int64)
  Title: Sender Party ID

  The unique identifier of the sender party.
• SenderPartyTypeCd: string
  Title: Sender Party Type Code

  Maximum Length: 30

  The party type code of the message sender such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.
• SentDate: string (date-time)
  Title: Sent Date

  The date when the message was sent by the sender. This field isn't populated when a message is automatically created via channels like email, social, and so on.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  The code indicating the source of the conversation message, such as ORA_SVC_AGENT_UI, API, or ORA_SVC_INBOUND_MSG.

{
    "type":"object",
    "properties":{
        "MessageContent":{
            "title":"Message Content",
            "type":"string",
            "description":"The content of the conversation message, such as the contents of an email.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"MessageEO.MessageContent",
                "protectionObjectTitle":"Message Content",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Message Content"
            }
        },
        "ReportedDate":{
            "title":"Reported Date",
            "type":"string",
            "description":"The date when the conversation message was reported. Typically this date would be the same as the created date unless the message was imported.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CreationDate"
                ]
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-attachments-item-patch-request"
            }
        },
        "SenderPartyTypeCd":{
            "title":"Sender Party Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The party type code of the message sender such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MessageTypeCd":{
            "title":"Message Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the conversation message, such as INBOUND or OUTBOUND.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date when the message was sent by the sender. This field isn't populated when a message is automatically created via channels like email, social, and so on.",
            "format":"date-time",
            "nullable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated with the conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "MessageAlternateId":{
            "title":"Message Alternate ID",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate identifier of the message.",
            "nullable":true
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the source of the conversation message, such as ORA_SVC_AGENT_UI, API, or ORA_SVC_INBOUND_MSG.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SenderPartyId":{
            "title":"Sender Party ID",
            "type":"integer",
            "description":"The unique identifier of the sender party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-smartActions-item-patch-request"
            }
        },
        "ProcessingStatusCd":{
            "title":"Processing Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the processing status of the conversation message, such as WAITING, READY, ERROR, or SUCCESS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcessingAPPMsgId":{
            "title":"Processing Application Message ID",
            "maxLength":"30",
            "type":"string",
            "description":"The processing application's message identifier. This is used when an application other than CX Sales processes the outbound message such as Oracle Marketing Cloud.",
            "nullable":true
        },
        "MessageSendDate":{
            "title":"Message Send Date",
            "type":"string",
            "description":"The date when an outbound message should be sent.",
            "format":"date-time",
            "nullable":true
        },
        "MessageTemplateObjTypeCd":{
            "title":"Message Template Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The object type for which the conversation message was created, such as Service Request, Opportunities, Sales Lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcessingAPPContentReferenceId":{
            "title":"Processing Application Content Reference ID",
            "maxLength":"30",
            "type":"string",
            "description":"The reference ID of the message's content in the application processing the message. This is used when an application other than CX Sales processes the outbound message such as Oracle Marketing Cloud.",
            "nullable":true
        },
        "SenderFreeFormAddress":{
            "title":"Sender Free Form Address",
            "maxLength":"320",
            "type":"string",
            "description":"The free form address of the sender of the message. For example, the email address of the sender.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"MessageEO.SenderFreeFormAddress",
                "protectionObjectTitle":"Sender Free Form Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Sender Free Form Address"
            }
        },
        "ProcessingStatusDetail":{
            "title":"Processing Status Detail",
            "maxLength":"1000",
            "type":"string",
            "description":"The details of the conversation message processing status.",
            "nullable":true
        },
        "SenderAlternateId":{
            "title":"Sender Alternate ID",
            "type":"integer",
            "description":"The alternate identifier of the message sender.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OriginalSystemReference":{
            "title":"Original Application Reference",
            "maxLength":"1000",
            "type":"string",
            "description":"The original application reference of an imported conversation message.",
            "nullable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "MessageStatusCd":{
            "title":"Message Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of a message, such as DRAFT or COMMITTED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignedToPartyId":{
            "title":"Assigned To",
            "type":"integer",
            "description":"The unique identifier of the resource party to whom the conversation message is assigned. This isn't used currently and reserved for future.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConversationTypeCd":{
            "title":"Conversation Type",
            "maxLength":"255",
            "type":"string",
            "description":"The code indicating the type of the conversation, such as Customer or Collaboration.",
            "nullable":true
        },
        "MessageTemplate":{
            "title":"Message Template",
            "maxLength":"320",
            "type":"string",
            "description":"The name of the template associated with the conversation message.",
            "nullable":true
        },
        "MessageTitle":{
            "title":"Subject",
            "maxLength":"1000",
            "type":"string",
            "description":"The title of the conversation message.",
            "nullable":true
        },
        "ConversationStripeCd":{
            "title":"Conversation Stripe Code",
            "maxLength":"255",
            "type":"string",
            "description":"The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.",
            "nullable":true
        },
        "recipients":{
            "title":"Conversation Message Recipients",
            "type":"array",
            "description":"Message recipients.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-recipients-item-patch-request"
            }
        },
        "MsgTemplateObjectId":{
            "title":"Message Template Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the message template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "InboundStatusCd":{
            "title":"Inbound Message Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of an inbound or internal collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcessingAPPCd":{
            "title":"Processing Application Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the application that will be processing the message such as Oracle Marketing Cloud or CX Sales. Typically, this is used for outbound messages.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChannelTypeCd":{
            "title":"Channel Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of channel associated with the conversation message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConversationBUOrgId":{
            "title":"Conversation Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organization associated with the conversation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object schema

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

Nested Schema : Conversation Message Recipients

Type: array

Title: Conversation Message Recipients

Message recipients.

Show Source

• Array of: object conversationMessages-recipients-item-patch-request

{
    "title":"Conversation Message Recipients",
    "type":"array",
    "description":"Message recipients.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-recipients-item-patch-request"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object conversationMessages-smartActions-item-patch-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-smartActions-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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"
            }
        },
        "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"
            }
        },
        "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 : conversationMessages-recipients-item-patch-request

Type: object

Show Source

• FreeFormAddress: string
  Title: Free Form Address

  Maximum Length: 320

  The free form address of the conversation message recipient. E.g. the email address of the sender.
• MessageId: integer (int64)
  Title: Message ID

  The unique identifier of the conversation message.
• PersonId: integer (int64)
  Title: Person ID

  The unique identifier of the recipient. This is populated if the recipient is an internal person such as an employee and contingent worker.
• RecipientAlternateId: integer (int64)
  Title: Recipient Alternate ID

  The alternate identifier of the recipient such as the identifier of the recipient in an external system.
• RecipientAlternateMessageId: string
  Title: Message Alternate ID

  Maximum Length: 1000

  The alternate identifier of the message in an external system.
• RecipientPartyId: integer (int64)
  Title: Recipient Party ID

  The unique identifier of the party of the conversation message recipient.
• RecipientPartyTypeCd: string
  Title: Recipient Party Type Code

  Maximum Length: 30

  The party type code of the message recipient such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.
• RecipientTypeCd: string
  Title: Recipient Type Code

  Maximum Length: 30

  The code indicating the type of the recipient in the conversation message, such as TO, CC, or BCC.

{
    "type":"object",
    "properties":{
        "FreeFormAddress":{
            "title":"Free Form Address",
            "maxLength":"320",
            "type":"string",
            "description":"The free form address of the conversation message recipient. E.g. the email address of the sender.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"MessageRecipientEO.FreeFormAddress",
                "protectionObjectTitle":"Free Form Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Free Form Address"
            }
        },
        "RecipientAlternateMessageId":{
            "title":"Message Alternate ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The alternate identifier of the message in an external system.",
            "nullable":true
        },
        "RecipientTypeCd":{
            "title":"Recipient Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the recipient in the conversation message, such as TO, CC, or BCC.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the recipient. This is populated if the recipient is an internal person such as an employee and contingent worker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecipientPartyId":{
            "title":"Recipient Party ID",
            "type":"integer",
            "description":"The unique identifier of the party of the conversation message recipient.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecipientAlternateId":{
            "title":"Recipient Alternate ID",
            "type":"integer",
            "description":"The alternate identifier of the recipient such as the identifier of the recipient in an external system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecipientPartyTypeCd":{
            "title":"Recipient Party Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The party type code of the message recipient such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the conversation message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : conversationMessages-smartActions-item-patch-request

Type: object

Show Source

• ActionContextParameters: string
  Title: Action Context Parameters

  Maximum Length: 1000

  Determines the context when a smart action is applicable.
• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Boolean value indicating if the action is active or inactive.
• ApplicationRoles: string
  Title: Application Roles

  Maximum Length: 2000

  The application roles associated with the smart action.
• Condition: string
  Title: Filter Condition

  Maximum Length: 1000

  Groovy script used to qualify this action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• ContextualFlag: boolean
  Title: Contextual

  Maximum Length: 1

  Indicates if the smart action is contextual.
• DataPrivilege: string
  Title: Data Security Privilege

  Maximum Length: 250

  JSON string containing the Privilege name, the object name, and the object key.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The REST endpoint to perform the action.
• IncludedIn: string
  Title: Included In

  Maximum Length: 150

  The view object this action is part of. Could contain more than one comma-separated value.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• InternalFlag: boolean
  Title: Restricted

  Maximum Length: 1

  Boolean type indicating if this action is internal.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.
• UserPrivilege: string
  Title: User Security Privilege

  Maximum Length: 4000

  The user security privilege.

{
    "type":"object",
    "properties":{
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true
        },
        "IncludedIn":{
            "title":"Included In",
            "maxLength":"150",
            "type":"string",
            "description":"The view object this action is part of. Could contain more than one comma-separated value.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true
        },
        "ContextualFlag":{
            "title":"Contextual",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the smart action is contextual.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true
        },
        "ActionContextParameters":{
            "title":"Action Context Parameters",
            "maxLength":"1000",
            "type":"string",
            "description":"Determines the context when a smart action is applicable.",
            "nullable":true,
            "x-queryable":false
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionNavigation-item-patch-request"
            }
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionRequestPayload-item-patch-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        },
        "Condition":{
            "title":"Filter Condition",
            "maxLength":"1000",
            "type":"string",
            "description":"Groovy script used to qualify this action.",
            "nullable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionURLBinding-item-patch-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true
        },
        "InternalFlag":{
            "title":"Restricted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action is internal.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true
        },
        "UserPrivilege":{
            "title":"User Security Privilege",
            "maxLength":"4000",
            "type":"string",
            "description":"The user security privilege.",
            "nullable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is active or inactive.",
            "nullable":true
        },
        "DataPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":"250",
            "type":"string",
            "description":"JSON string containing the Privilege name, the object name, and the object key.",
            "nullable":true
        },
        "ApplicationRoles":{
            "title":"Application Roles",
            "maxLength":"2000",
            "type":"string",
            "description":"The application roles associated with the smart action.",
            "nullable":true
        }
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object conversationMessages-smartActions-UserActionNavigation-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionNavigation-item-patch-request"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object conversationMessages-smartActions-UserActionRequestPayload-item-patch-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionRequestPayload-item-patch-request"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object conversationMessages-smartActions-UserActionURLBinding-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionURLBinding-item-patch-request"
    }
}

Nested Schema : conversationMessages-smartActions-UserActionNavigation-item-patch-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"Application usage.",
            "nullable":false
        }
    }
}

Nested Schema : conversationMessages-smartActions-UserActionRequestPayload-item-patch-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true
        }
    }
}

Nested Schema : conversationMessages-smartActions-UserActionURLBinding-item-patch-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false
        }
    }
}

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 : conversationMessages-item-response

Type: object

Show Source

• AssignedToPartyId: integer (int64)
  Title: Assigned To

  The unique identifier of the resource party to whom the conversation message is assigned. This isn't used currently and reserved for future.
• AssignedToPartyNumber: string
  Title: Assigned to Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the resource party to whom the conversation message is assigned. This isn't used currently and reserved for future.
• AssignedToPersonName: string
  Title: Assigned to Party Name

  Read Only: true

  Maximum Length: 360

  The name of the resource assigned to the conversation message. This isn't used currently and reserved for future.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel associated with the conversation message.
• ChannelTypeCd: string
  Title: Channel Type Code

  Maximum Length: 30

  The code indicating the type of channel associated with the conversation message.
• ChannelTypeCdMeaning: string
  Title: Channel Type Value

  Read Only: true

  Maximum Length: 255

  The name of the channel type associated with the conversation message, such as Email or Social.
• ConversationBUOrgId: integer (int64)
  Title: Conversation Business Unit

  The unique identifier of the business unit organization associated with the conversation.
• ConversationId: integer (int64)
  Title: Conversation ID

  The unique identifier of the conversation to which the message is associated.
• ConversationNumber: string
  Title: Conversation Number

  Maximum Length: 30

  The alternate key identifier of the conversation to which the message is associated.
• ConversationStripeCd: string
  Title: Conversation Stripe Code

  Maximum Length: 255

  The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.
• ConversationTypeCd: string
  Title: Conversation Type

  Maximum Length: 255

  The code indicating the type of the conversation, such as Customer or Collaboration.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the conversation message was created.
• InboundStatusCd: string
  Title: Inbound Message Status Code

  Maximum Length: 30

  The status code of an inbound or internal collaboration message.
• InboundStatusCdMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 255

  The display value of the status of an inbound or internal collaboration message
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MessageAlternateId: string
  Title: Message Alternate ID

  Maximum Length: 100

  The alternate identifier of the message.
• MessageContent: string (byte)
  Title: Message Content

  The content of the conversation message, such as the contents of an email.
• MessageCount: string
  Title: Message Count

  Read Only: true

  Maximum Length: 80

  The total number of messages associated with a conversation.
• MessageId: integer (int64)
  Title: Message ID

  Read Only: true

  The unique identifier of the conversation message.
• MessageNumber: string
  Title: Message Number

  Maximum Length: 30

  The alternate key identifier of the conversation message.
• MessageSendDate: string (date-time)
  Title: Message Send Date

  The date when an outbound message should be sent.
• MessageStatusCd: string
  Title: Message Status Code

  Maximum Length: 30

  The status code of a message, such as DRAFT or COMMITTED.
• MessageTemplate: string
  Title: Message Template

  Maximum Length: 320

  The name of the template associated with the conversation message.
• MessageTemplateObjTypeCd: string
  Title: Message Template Object Type

  Maximum Length: 30

  The object type for which the conversation message was created, such as Service Request, Opportunities, Sales Lead.
• MessageTitle: string
  Title: Subject

  Maximum Length: 1000

  The title of the conversation message.
• MessageTypeCd: string
  Title: Message Type Code

  Maximum Length: 30

  The code indicating the type of the conversation message, such as INBOUND or OUTBOUND.
• MessageTypeCdMeaning: string
  Title: Message Type

  Read Only: true

  Maximum Length: 255

  The value of conversation message type, such as Inbound, Outbound, Internal Note, System Response, or System Note.
• MsgTemplateObjectId: integer (int64)
  Title: Message Template Object ID

  The unique identifier of the object associated with the message template.
• OriginalSystemReference: string
  Title: Original Application Reference

  Maximum Length: 1000

  The original application reference of an imported conversation message.
• ParentMessageId: integer (int64)
  Title: Parent Message ID

  The unique identifier of the parent message of the current conversation message. When a user replies to a message the original message becomes the parent message of the reply.
• ParentMessageNumber: string
  Title: Parent Message Number

  Maximum Length: 30

  The alternate key identifier of the parent message.
• ProcessingAPPCd: string
  Title: Processing Application Code

  Maximum Length: 30

  The code indicating the application that will be processing the message such as Oracle Marketing Cloud or CX Sales. Typically, this is used for outbound messages.
• ProcessingAPPContentReferenceId: string
  Title: Processing Application Content Reference ID

  Maximum Length: 30

  The reference ID of the message's content in the application processing the message. This is used when an application other than CX Sales processes the outbound message such as Oracle Marketing Cloud.
• ProcessingAPPMsgId: string
  Title: Processing Application Message ID

  Maximum Length: 30

  The processing application's message identifier. This is used when an application other than CX Sales processes the outbound message such as Oracle Marketing Cloud.
• ProcessingStatusCd: string
  Title: Processing Status Code

  Maximum Length: 30

  The code indicating the processing status of the conversation message, such as WAITING, READY, ERROR, or SUCCESS.
• ProcessingStatusDetail: string
  Title: Processing Status Detail

  Maximum Length: 1000

  The details of the conversation message processing status.
• QueueId: integer (int64)
  Title: Queue ID

  The unique identifier of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.
• QueueName: string
  Title: Queue Name

  Read Only: true

  Maximum Length: 400

  The name of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.
• QueueNumber: string
  Title: Queue Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.
• recipients: array Conversation Message Recipients
  Title: Conversation Message Recipients

  Message recipients.
• ReportedDate: string (date-time)
  Title: Reported Date

  The date when the conversation message was reported. Typically this date would be the same as the created date unless the message was imported.
• SenderAlternateId: integer (int64)
  Title: Sender Alternate ID

  The alternate identifier of the message sender.
• SenderFreeFormAddress: string
  Title: Sender Free Form Address

  Maximum Length: 320

  The free form address of the sender of the message. For example, the email address of the sender.
• SenderPartyId: integer (int64)
  Title: Sender Party ID

  The unique identifier of the sender party.
• SenderPartyName: string
  Title: Sender

  Read Only: true

  Maximum Length: 360

  The name of the sender party.
• SenderPartyNumber: string
  Title: Sender Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the sender party.
• SenderPartyTypeCd: string
  Title: Sender Party Type Code

  Maximum Length: 30

  The party type code of the message sender such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.
• SentDate: string (date-time)
  Title: Sent Date

  The date when the message was sent by the sender. This field isn't populated when a message is automatically created via channels like email, social, and so on.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  The code indicating the source of the conversation message, such as ORA_SVC_AGENT_UI, API, or ORA_SVC_INBOUND_MSG.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the conversation message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageContent":{
            "title":"Message Content",
            "type":"string",
            "description":"The content of the conversation message, such as the contents of an email.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"MessageEO.MessageContent",
                "protectionObjectTitle":"Message Content",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Message Content"
            }
        },
        "AssignedToPartyNumber":{
            "title":"Assigned to Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the resource party to whom the conversation message is assigned. This isn't used currently and reserved for future.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderPartyName":{
            "title":"Sender",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the sender party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderPartyTypeCd":{
            "title":"Sender Party Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The party type code of the message sender such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date when the message was sent by the sender. This field isn't populated when a message is automatically created via channels like email, social, and so on.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the source of the conversation message, such as ORA_SVC_AGENT_UI, API, or ORA_SVC_INBOUND_MSG.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SenderPartyNumber":{
            "title":"Sender Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the sender party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-smartActions-item-response"
            }
        },
        "ProcessingStatusCd":{
            "title":"Processing Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the processing status of the conversation message, such as WAITING, READY, ERROR, or SUCCESS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageTemplateObjTypeCd":{
            "title":"Message Template Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The object type for which the conversation message was created, such as Service Request, Opportunities, Sales Lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcessingAPPContentReferenceId":{
            "title":"Processing Application Content Reference ID",
            "maxLength":"30",
            "type":"string",
            "description":"The reference ID of the message's content in the application processing the message. This is used when an application other than CX Sales processes the outbound message such as Oracle Marketing Cloud.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the conversation message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the conversation message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatusDetail":{
            "title":"Processing Status Detail",
            "maxLength":"1000",
            "type":"string",
            "description":"The details of the conversation message processing status.",
            "nullable":true,
            "x-queryable":true
        },
        "SenderAlternateId":{
            "title":"Sender Alternate ID",
            "type":"integer",
            "description":"The alternate identifier of the message sender.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageStatusCd":{
            "title":"Message Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of a message, such as DRAFT or COMMITTED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConversationTypeCd":{
            "title":"Conversation Type",
            "maxLength":"255",
            "type":"string",
            "description":"The code indicating the type of the conversation, such as Customer or Collaboration.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageTitle":{
            "title":"Subject",
            "maxLength":"1000",
            "type":"string",
            "description":"The title of the conversation message.",
            "nullable":true,
            "x-queryable":true
        },
        "recipients":{
            "title":"Conversation Message Recipients",
            "type":"array",
            "description":"Message recipients.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-recipients-item-response"
            }
        },
        "ChannelTypeCdMeaning":{
            "title":"Channel Type Value",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the channel type associated with the conversation message, such as Email or Social.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ChannelTypeCd"
                ]
            },
            "x-queryable":true
        },
        "MsgTemplateObjectId":{
            "title":"Message Template Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the message template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InboundStatusCd":{
            "title":"Inbound Message Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of an inbound or internal collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of channel associated with the conversation message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the conversation message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversationBUOrgId":{
            "title":"Conversation Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organization associated with the conversation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of the conversation to which the message is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the conversation message.",
            "nullable":false,
            "x-queryable":true
        },
        "ReportedDate":{
            "title":"Reported Date",
            "type":"string",
            "description":"The date when the conversation message was reported. Typically this date would be the same as the created date unless the message was imported.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CreationDate"
                ]
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-attachments-item-response"
            }
        },
        "MessageTypeCd":{
            "title":"Message Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the conversation message, such as INBOUND or OUTBOUND.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated with the conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageAlternateId":{
            "title":"Message Alternate ID",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate identifier of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "SenderPartyId":{
            "title":"Sender Party ID",
            "type":"integer",
            "description":"The unique identifier of the sender party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InboundStatusCdMeaning":{
            "title":"Status",
            "maxLength":"255",
            "type":"string",
            "description":"The display value of the status of an inbound or internal collaboration message",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InboundStatusCd"
                ]
            },
            "x-queryable":true
        },
        "MessageTypeCdMeaning":{
            "title":"Message Type",
            "maxLength":"255",
            "type":"string",
            "description":"The value of conversation message type, such as Inbound, Outbound, Internal Note, System Response, or System Note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "MessageTypeCd"
                ]
            },
            "x-queryable":true
        },
        "ConversationNumber":{
            "title":"Conversation Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the conversation to which the message is associated.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessingAPPMsgId":{
            "title":"Processing Application Message ID",
            "maxLength":"30",
            "type":"string",
            "description":"The processing application's message identifier. This is used when an application other than CX Sales processes the outbound message such as Oracle Marketing Cloud.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentMessageNumber":{
            "title":"Parent Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the parent message.",
            "nullable":false,
            "x-queryable":true
        },
        "MessageSendDate":{
            "title":"Message Send Date",
            "type":"string",
            "description":"The date when an outbound message should be sent.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedToPersonName":{
            "title":"Assigned to Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource assigned to the conversation message. This isn't used currently and reserved for future.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderFreeFormAddress":{
            "title":"Sender Free Form Address",
            "maxLength":"320",
            "type":"string",
            "description":"The free form address of the sender of the message. For example, the email address of the sender.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"MessageEO.SenderFreeFormAddress",
                "protectionObjectTitle":"Sender Free Form Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Sender Free Form Address"
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original Application Reference",
            "maxLength":"1000",
            "type":"string",
            "description":"The original application reference of an imported conversation message.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentMessageId":{
            "title":"Parent Message ID",
            "type":"integer",
            "description":"The unique identifier of the parent message of the current conversation message. When a user replies to a message the original message becomes the parent message of the reply.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedToPartyId":{
            "title":"Assigned To",
            "type":"integer",
            "description":"The unique identifier of the resource party to whom the conversation message is assigned. This isn't used currently and reserved for future.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageTemplate":{
            "title":"Message Template",
            "maxLength":"320",
            "type":"string",
            "description":"The name of the template associated with the conversation message.",
            "nullable":true,
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversationStripeCd":{
            "title":"Conversation Stripe Code",
            "maxLength":"255",
            "type":"string",
            "description":"The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingAPPCd":{
            "title":"Processing Application Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the application that will be processing the message such as Oracle Marketing Cloud or CX Sales. Typically, this is used for outbound messages.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageCount":{
            "title":"Message Count",
            "maxLength":"80",
            "type":"string",
            "description":"The total number of messages associated with a conversation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the conversation message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the conversation message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 conversationMessages-attachments-item-response

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Conversation Message Recipients

Type: array

Title: Conversation Message Recipients

Message recipients.

Show Source

• Array of: object conversationMessages-recipients-item-response

{
    "title":"Conversation Message Recipients",
    "type":"array",
    "description":"Message recipients.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-recipients-item-response"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object conversationMessages-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-smartActions-item-response"
    }
}

Nested Schema : conversationMessages-attachments-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.
• 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
        },
        "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
        },
        "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 : 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 : conversationMessages-recipients-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the conversation message recipient was created.
• FreeFormAddress: string
  Title: Free Form Address

  Maximum Length: 320

  The free form address of the conversation message recipient. E.g. the email address of the sender.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MessageId: integer (int64)
  Title: Message ID

  The unique identifier of the conversation message.
• MessageNumber: string
  Title: Message Number

  Maximum Length: 30

  The alternate key identifier of the conversation message.
• PersonId: integer (int64)
  Title: Person ID

  The unique identifier of the recipient. This is populated if the recipient is an internal person such as an employee and contingent worker.
• RecipientAlternateId: integer (int64)
  Title: Recipient Alternate ID

  The alternate identifier of the recipient such as the identifier of the recipient in an external system.
• RecipientAlternateMessageId: string
  Title: Message Alternate ID

  Maximum Length: 1000

  The alternate identifier of the message in an external system.
• RecipientId: integer (int64)
  Title: Recipient ID

  Read Only: true

  The unique identifier of the conversation message recipient.
• RecipientNumber: string
  Title: Recipient Number

  Maximum Length: 30

  The public unique identifier of the conversation message recipient.
• RecipientPartyId: integer (int64)
  Title: Recipient Party ID

  The unique identifier of the party of the conversation message recipient.
• RecipientPartyName: string
  Title: Recipient Name

  Read Only: true

  Maximum Length: 360

  The name of the party of the conversation message recipient.
• RecipientPartyNumber: string
  Title: Recipient Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the party of the conversation message recipient.
• RecipientPartyTypeCd: string
  Title: Recipient Party Type Code

  Maximum Length: 30

  The party type code of the message recipient such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.
• RecipientTypeCd: string
  Title: Recipient Type Code

  Maximum Length: 30

  The code indicating the type of the recipient in the conversation message, such as TO, CC, or BCC.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the conversation message recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the conversation message recipient was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientAlternateMessageId":{
            "title":"Message Alternate ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The alternate identifier of the message in an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "RecipientId":{
            "title":"Recipient ID",
            "type":"integer",
            "description":"The unique identifier of the conversation message recipient.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the conversation message recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the conversation message.",
            "nullable":false,
            "x-queryable":true
        },
        "RecipientPartyNumber":{
            "title":"Recipient Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the party of the conversation message recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientAlternateId":{
            "title":"Recipient Alternate ID",
            "type":"integer",
            "description":"The alternate identifier of the recipient such as the identifier of the recipient in an external system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecipientPartyName":{
            "title":"Recipient Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party of the conversation message recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FreeFormAddress":{
            "title":"Free Form Address",
            "maxLength":"320",
            "type":"string",
            "description":"The free form address of the conversation message recipient. E.g. the email address of the sender.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"MessageRecipientEO.FreeFormAddress",
                "protectionObjectTitle":"Free Form Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Free Form Address"
            },
            "x-queryable":true
        },
        "RecipientNumber":{
            "title":"Recipient Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the conversation message recipient.",
            "nullable":false,
            "x-queryable":true
        },
        "RecipientTypeCd":{
            "title":"Recipient Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the recipient in the conversation message, such as TO, CC, or BCC.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the recipient. This is populated if the recipient is an internal person such as an employee and contingent worker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecipientPartyId":{
            "title":"Recipient Party ID",
            "type":"integer",
            "description":"The unique identifier of the party of the conversation message recipient.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecipientPartyTypeCd":{
            "title":"Recipient Party Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The party type code of the message recipient such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the conversation message recipient was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the conversation message recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the conversation message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 : conversationMessages-smartActions-item-response

Type: object

Show Source

• ActionContextParameters: string
  Title: Action Context Parameters

  Maximum Length: 1000

  Determines the context when a smart action is applicable.
• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ActionSource: string
  Title: Action Source

  Maximum Length: 512

  Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Boolean value indicating if the action is active or inactive.
• ApplicationRoles: string
  Title: Application Roles

  Maximum Length: 2000

  The application roles associated with the smart action.
• Condition: string
  Title: Filter Condition

  Maximum Length: 1000

  Groovy script used to qualify this action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• ContextualFlag: boolean
  Title: Contextual

  Maximum Length: 1

  Indicates if the smart action is contextual.
• DataPrivilege: string
  Title: Data Security Privilege

  Maximum Length: 250

  JSON string containing the Privilege name, the object name, and the object key.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The REST endpoint to perform the action.
• IncludedIn: string
  Title: Included In

  Maximum Length: 150

  The view object this action is part of. Could contain more than one comma-separated value.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• InternalFlag: boolean
  Title: Restricted

  Maximum Length: 1

  Boolean type indicating if this action is internal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.
• UserPrivilege: string
  Title: User Security Privilege

  Maximum Length: 4000

  The user security privilege.

{
    "type":"object",
    "properties":{
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedIn":{
            "title":"Included In",
            "maxLength":"150",
            "type":"string",
            "description":"The view object this action is part of. Could contain more than one comma-separated value.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextualFlag":{
            "title":"Contextual",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the smart action is contextual.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionContextParameters":{
            "title":"Action Context Parameters",
            "maxLength":"1000",
            "type":"string",
            "description":"Determines the context when a smart action is applicable.",
            "nullable":true,
            "x-queryable":false
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionNavigation-item-response"
            }
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "Condition":{
            "title":"Filter Condition",
            "maxLength":"1000",
            "type":"string",
            "description":"Groovy script used to qualify this action.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalFlag":{
            "title":"Restricted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action is internal.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "UserPrivilege":{
            "title":"User Security Privilege",
            "maxLength":"4000",
            "type":"string",
            "description":"The user security privilege.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is active or inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DataPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":"250",
            "type":"string",
            "description":"JSON string containing the Privilege name, the object name, and the object key.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionSource":{
            "title":"Action Source",
            "maxLength":"512",
            "type":"string",
            "description":"Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationRoles":{
            "title":"Application Roles",
            "maxLength":"2000",
            "type":"string",
            "description":"The application roles associated with the smart action.",
            "nullable":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"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object conversationMessages-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object conversationMessages-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object conversationMessages-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : conversationMessages-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "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 : conversationMessages-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":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"
    }
}

Nested Schema : conversationMessages-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "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

ChannelTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_TYPE_CD

The following properties are defined on the LOV link relation:

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

InboundStatusCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MC_INBOUND_MSG_STAT_CD

The following properties are defined on the LOV link relation:

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

MessageStatusCdLookup

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: MessageStatusCd; Target Attribute: LookupCode
• Display Attribute: Meaning

MessageTemplateObjTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MC_OBJECT_TYPE_CD

The following properties are defined on the LOV link relation:

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

MessageTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MC_MESSAGE_TYPE_CD

The following properties are defined on the LOV link relation:

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

ProcessingAPPCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MSG_PROC_APP

The following properties are defined on the LOV link relation:

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

ProcessingStatusCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_PROCESS_CD

The following properties are defined on the LOV link relation:

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

SenderPartyTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SENDER_RECIPIENT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: SenderPartyTypeCd; 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

attachments

Operation: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments

Parameters:

• MessageNumber: $request.path.MessageNumber

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

recipients

Operation: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/recipients

Parameters:

• MessageNumber: $request.path.MessageNumber

Message recipients.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions

Parameters:

• MessageNumber: $request.path.MessageNumber

This VO stores the endpoint and security details for every user action.

Back to Top