Jump to

• Request
• Response
• Examples

Get all conversation messages

get

/crmRestApi/resources/11.13.18.05/conversationMessages

Request

Query Parameters

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

  • AllInquiryMessages Finds conversation messages associated with a channel for inquiry.
    Finder Variables
  • AllUnlinkedSalesMessages Finds conversation messages associated with a sales channel but not associated with any sales objects such as leads or activities.
    Finder Variables
  • ConversationMessageByObject Finds the list of conversation messages associated with given objects such as service, leads, or activities.
    Finder Variables
    • BindObjectId; integer; The unique identifier of the business object, such as help desk request or sales lead.
    • BindObjectTypeCd; string; The type of object record that's stored for OBJECT_ID, such as SVC_SERVICE_REQUESTS.
  • MessageByNumber Finds a conversation message with the specified message number.
    Finder Variables
    • MessageNumber; string; The alternate key identifier of the message.
  • MyInboundMessages Finds inbound conversation messages with the specified finder variable.
    Finder Variables
    • BindRecipientPartyId; string; The party identifier of the recipient to search for.
  • MyInboundMessagesToReply Finds new inbound conversation messages where the logged in user is one of the recipients.
    Finder Variables
    • BindRecipientPartyId; string; The party identifier of the recipient to search for.
  • MyMessages Finds conversation messages where the logged in user is one of the recipients.
    Finder Variables
    • BindRecipientPartyId; string; The party identifier of the recipient to search for.
  • MyMessagesToReply Finds new conversation messages where the logged in user is one of the recipients.
    Finder Variables
    • BindRecipientPartyId; string; The party identifier of the recipient to search for.
  • PastMessages Finds past messages in the conversation thread of a given message.
    Finder Variables
    • BindMessageId; string; The unique identifier of the message for which to find past messages.
  • PrimaryKey Finds a conversation message with the specified primary key.
    Finder Variables
    • MessageId; integer; The unique identifier of the conversation message.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignedToPartyId; integer; 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; 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; The name of the resource assigned to the conversation message. This isn't used currently and reserved for future.
  • ChannelId; integer; The unique identifier of the channel associated with the conversation message.
  • ChannelTypeCd; string; The code indicating the type of channel associated with the conversation message.
  • ChannelTypeCdMeaning; string; The name of the channel type associated with the conversation message, such as Email or Social.
  • ConversationBUOrgId; integer; The unique identifier of the business unit organization associated with the conversation.
  • ConversationId; integer; The unique identifier of the conversation to which the message is associated.
  • ConversationNumber; string; The alternate key identifier of the conversation to which the message is associated.
  • ConversationStripeCd; string; The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.
  • ConversationTypeCd; string; The code indicating the type of the conversation, such as Customer or Collaboration.
  • CreatedBy; string; The user who created the conversation message.
  • CreationDate; string; The date when the conversation message was created.
  • InboundStatusCd; string; The status code of an inbound or internal collaboration message.
  • InboundStatusCdMeaning; string; The display value of the status of an inbound or internal collaboration message
  • LastUpdateDate; string; The date when the conversation message was last updated.
  • LastUpdateLogin; string; The login details of the user who last updated the conversation message.
  • LastUpdatedBy; string; The user who last updated the conversation message.
  • MessageAlternateId; string; The alternate identifier of the message.
  • MessageCount; string; The total number of messages associated with a conversation.
  • MessageId; integer; The unique identifier of the conversation message.
  • MessageNumber; string; The alternate key identifier of the conversation message.
  • MessageSendDate; string; The date when an outbound message should be sent.
  • MessageStatusCd; string; The status code of a message, such as DRAFT or COMMITTED.
  • MessageTemplate; string; The name of the template associated with the conversation message.
  • MessageTemplateObjTypeCd; string; The object type for which the conversation message was created, such as Service Request, Opportunities, Sales Lead.
  • MessageTitle; string; The title of the conversation message.
  • MessageTypeCd; string; The code indicating the type of the conversation message, such as INBOUND or OUTBOUND.
  • MessageTypeCdMeaning; string; The value of conversation message type, such as Inbound, Outbound, Internal Note, System Response, or System Note.
  • MsgTemplateObjectId; integer; The unique identifier of the object associated with the message template.
  • OriginalSystemReference; string; The original application reference of an imported conversation message.
  • ParentMessageId; integer; 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; The alternate key identifier of the parent message.
  • ProcessingAPPCd; string; 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; 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; 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; The code indicating the processing status of the conversation message, such as WAITING, READY, ERROR, or SUCCESS.
  • ProcessingStatusDetail; string; The details of the conversation message processing status.
  • QueueId; integer; The unique identifier of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.
  • QueueName; string; The name of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.
  • QueueNumber; string; The alternate key identifier of the queue that the conversation message is assigned to. This isn't used currently and reserved for future.
  • ReportedDate; string; 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; The alternate identifier of the message sender.
  • SenderFreeFormAddress; string; The free form address of the sender of the message. For example, the email address of the sender.
  • SenderPartyId; integer; The unique identifier of the sender party.
  • SenderPartyName; string; The name of the sender party.
  • SenderPartyNumber; string; The alternate key identifier of the sender party.
  • SenderPartyTypeCd; string; The party type code of the message sender such as ORA_SVC_BUSINESS_CONTACT, ORA_SVC_RESOURCE.
  • SentDate; string; 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.
  • SourceCd; string; The code indicating the source of the conversation message, such as ORA_SVC_AGENT_UI, API, or ORA_SVC_INBOUND_MSG.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : conversationMessages

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object conversationMessages-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/conversationMessages-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 : 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

  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

  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

  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

  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

  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

  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

  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

  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

  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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ConversationStripeCd":{
            "title":"Conversation Stripe",
            "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the conversation message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "InboundStatusCd":{
            "title":"Inbound Message Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of an inbound or internal collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "MessageAlternateId":{
            "title":"Message Alternate ID",
            "maxLength":100,
            "type":"string",
            "description":"The alternate identifier of the message.",
            "nullable":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"
            }
        },
        "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
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the conversation 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
        },
        "MessageStatusCd":{
            "title":"Message Status",
            "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
        },
        "MessageTemplate":{
            "title":"Message Template",
            "maxLength":320,
            "type":"string",
            "description":"The name of the template associated with the conversation message.",
            "nullable":true,
            "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
        },
        "MessageTitle":{
            "title":"Subject",
            "maxLength":1000,
            "type":"string",
            "description":"The title of the conversation message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageTypeCd":{
            "title":"Message Type",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ParentMessageNumber":{
            "title":"Parent Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the parent message.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessingAPPCd":{
            "title":"Processing Application",
            "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
        },
        "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
        },
        "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
        },
        "ProcessingStatusCd":{
            "title":"Processing Status",
            "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
        },
        "ProcessingStatusDetail":{
            "title":"Processing Status Detail",
            "maxLength":1000,
            "type":"string",
            "description":"The details of the conversation message processing status.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "SenderPartyName":{
            "title":"Sender",
            "maxLength":360,
            "type":"string",
            "description":"The name of the sender party.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "SenderPartyTypeCd":{
            "title":"Sender Party Type",
            "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",
            "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
        },
        "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"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "recipients":{
            "title":"Conversation Message Recipients",
            "type":"array",
            "description":"Message recipients.",
            "items":{
                "$ref":"#/components/schemas/conversationMessages-recipients-item-response"
            }
        },
        "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"
            }
        }
    }
}

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":{
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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
        },
        "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"
            }
        },
        "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":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

  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

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the conversation message.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "RecipientNumber":{
            "title":"Recipient Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the conversation message recipient.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "RecipientPartyTypeCd":{
            "title":"Recipient Party Type",
            "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
        },
        "RecipientTypeCd":{
            "title":"Recipient Type",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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: 1024

  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":{
        "ActionContextParameters":{
            "title":"Action Context Parameters",
            "maxLength":1000,
            "type":"string",
            "description":"Determines the context when a smart action is applicable.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is active or inactive.",
            "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
        },
        "Condition":{
            "title":"Filter Condition",
            "maxLength":1000,
            "type":"string",
            "description":"Groovy script used to qualify this action.",
            "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
        },
        "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
        },
        "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
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "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
        },
        "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
        },
        "InternalFlag":{
            "title":"Restricted",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action is internal.",
            "nullable":true,
            "x-queryable":true
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "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
        },
        "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
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "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"
            }
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "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"
            }
        },
        "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"
            }
        },
        "UserPrivilege":{
            "title":"User Security Privilege",
            "maxLength":4000,
            "type":"string",
            "description":"The user security privilege.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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":{
        "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
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application 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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "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
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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: 256

  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: 1000

  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
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "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
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "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
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

copyAttachmentsToConversationMessage

Operation: /crmRestApi/resources/11.13.18.05/conversationMessages/action/copyAttachmentsToConversationMessage

Copies attachments to a specific conversation message.

createConversationMessageForBusinessObject

Operation: /crmRestApi/resources/11.13.18.05/conversationMessages/action/createConversationMessageForBusinessObject

Creates a conversation, conversation message, conversation message recipients, and associates the conversation with one or more business objects.

Back to Top

Examples

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

cURL Command

curl --location 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages/describe' -X GET

Example of Request Body

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

Example of Response Body

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

{
  "items" : [ {
    "MessageId" : 300100571392602,
    "MessageNumber" : "CDRM_0000000002",
    "CreatedBy" : "automsgcenterAdmin2",
    "CreationDate" : "2022-11-11T07:52:29+00:00",
    "LastUpdatedBy" : "automsgcenterAdmin2",
    "LastUpdateDate" : "2022-11-11T07:52:34+00:00",
    "LastUpdateLogin" : "ED2D888E9B61901EE0536F6315AC143A",
    "MessageTypeCd" : "ORA_SVC_OUTBOUND",
    "MessageTitle" : "Title of Internal Collaboration Conversation 1_73359",
    "SourceCd" : null,
    "ChannelTypeCd" : "ORA_SVC_EMAIL",
    "ChannelTypeCdMeaning" : "E-Mail",
    "InboundStatusCd" : null,
    "InboundStatusCdMeaning" : null,
    "MessageStatusCd" : "ORA_SVC_COMMITTED",
    "ProcessingStatusCd" : "ORA_SVC_SUCCESS",
    "ProcessingStatusDetail" : null,
    "SentDate" : "2022-11-11T07:52:34.307+00:00",
    "MessageSendDate" : null,
    "OriginalSystemReference" : null,
    "ConversationId" : 300100571390602,
    "ConversationNumber" : "CDRM_0000000001",
    "ConversationTypeCd" : "ORA_SVC_COLLABORATION",
    "ConversationStripeCd" : "ORA_SVC_CRM",
    "ConversationBUOrgId" : 204,
    "ParentMessageId" : 300100571390601,
    "ParentMessageNumber" : "CDRM_0000000001",
    "ChannelId" : null,
    "QueueId" : null,
    "QueueNumber" : null,
    "QueueName" : null,
    "AssignedToPartyId" : null,
    "AssignedToPartyNumber" : null,
    "AssignedToPersonName" : null,
    "ProcessingAPPCd" : "ENGAGEMENT_CENTER",
    "ProcessingAPPMsgId" : null,
    "ProcessingAPPContentReferenceId" : null,
    "MessageTemplateObjTypeCd" : "ORA_SVC_SERVICE_REQUESTS",
    "MessageTemplate" : null,
    "SenderPartyId" : 300100181732720,
    "SenderPartyNumber" : "CDRM_871796",
    "SenderPartyName" : "automsgcenterAdmin2 svc",
    "SenderPartyTypeCd" : "ORA_SVC_RESOURCE",
    "ReportedDate" : "2022-11-11T07:52:29+00:00",
    "SenderFreeFormAddress" : "[e-mail]",
    "MessageCount" : "2",
    "MsgTemplateObjectId" : 300100571390592,
    "SenderAlternateId" : null,
    "MessageAlternateId" : null,
    "MessageTypeCdMeaning" : "Outbound",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages/CDRM_0000000002",
      "name" : "conversationMessages",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages/CDRM_0000000002",
      "name" : "conversationMessages",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages/CDRM_0000000002/child/attachments",
      "name" : "attachments",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages/CDRM_0000000002/child/recipients",
      "name" : "recipients",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages/CDRM_0000000002/child/smartActions",
      "name" : "smartActions",
      "kind" : "collection"
    }, {
      "rel" : "enclosure",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages/CDRM_0000000002/enclosure/MessageContent",
      "name" : "MessageContent",
      "kind" : "other"
    } ]
  },....
  "count" : 25,
  "hasMore" : true,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages",
    "name" : "conversationMessages",
    "kind" : "collection"
  }, {
    "rel" : "action",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages/action/createConversationMessageForBusinessObject",
    "name" : "createConversationMessageForBusinessObject",
    "kind" : "other"
  } ]
}

Back to Top