Jump to

• Request
• Response

Create a communication record

post

/fscmRestApi/resources/11.13.18.05/communicationHistories

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConsumerResourceId: integer (int64)
  Title: Consumer Resource ID

  The unique identifier for the communication recipient whose action needs to be recorded.
• EmailResendFlag: boolean
  Title: Resend Indicator

  Maximum Length: 1

  Indicates whether the communication is to be resent. The acceptable values are Y, N, true, or false.
• MessageResponseCode: string
  Title: Message Response

  Maximum Length: 30

  The action taken by the user to respond to an actionable communication. Examples of values are ORA_HEY_COMM_ACTION_ACCEPT and ORA_HEY_COMM_ACTION_DENY. A list of accepted values is defined in the lookup type ORA_HEY_COMM_ACTION_TYPE.
• MessageResponseDate: string (date-time)
  Title: Message Response Date

  The date on which the recipient responded to the actionable email.
• ResponseToken: string
  Title: Response Token

  Maximum Length: 64

  The response token which would be provided by consumer to identify a specific user.
• TrackingMessageText: string (byte)
  Title: Tracking Message Text

  The tracking message of the messaging server about delivery of the communication.

{
    "type":"object",
    "properties":{
        "MessageResponseCode":{
            "title":"Message Response",
            "maxLength":30,
            "type":"string",
            "description":"The action taken by the user to respond to an actionable communication. Examples of values are ORA_HEY_COMM_ACTION_ACCEPT and ORA_HEY_COMM_ACTION_DENY. A list of accepted values is defined in the lookup type ORA_HEY_COMM_ACTION_TYPE.",
            "nullable":true
        },
        "MessageResponseDate":{
            "title":"Message Response Date",
            "type":"string",
            "description":"The date on which the recipient responded to the actionable email.",
            "format":"date-time",
            "nullable":true
        },
        "EmailResendFlag":{
            "title":"Resend Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the communication is to be resent. The acceptable values are Y, N, true, or false.",
            "nullable":true
        },
        "TrackingMessageText":{
            "title":"Tracking Message Text",
            "type":"string",
            "description":"The tracking message of the messaging server about delivery of the communication.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConsumerResourceId":{
            "title":"Consumer Resource ID",
            "type":"integer",
            "description":"The unique identifier for the communication recipient whose action needs to be recorded.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ResponseToken":{
            "title":"Response Token",
            "maxLength":64,
            "type":"string",
            "description":"The response token which would be provided by consumer to identify a specific user.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : communicationHistories-item-response

Type: object

Show Source

• CategoryName: string
  Title: Category Name

  Read Only: true

  Maximum Length: 50

  The name of a category, such as Enrollment or Billing.
• CommHistoryId: integer (int64)
  Title: Communication History ID

  Read Only: true

  Identifies the instance in which an individual communication was sent to a recipient.
• CommSetupId: integer (int64)
  Title: Communication Setup ID

  Read Only: true

  The unique identifier for a communication setup.
• CommunicationChannelCode: string
  Title: Channel Code

  Read Only: true

  Maximum Length: 30

  The code identifier for the channel through which a communication was sent, such as the code for email channel. A list of accepted values is defined in the lookup type ORA_HEY_COMM_CHANNEL.
• CommunicationChannelMeaning: string
  Title: Channel

  Read Only: true

  Maximum Length: 80

  The channel through which a communication was sent to a recipient, such as email. A list of accepted values is defined in the lookup type ORA_HEY_COMM_CHANNEL.
• CommunicationCode: string
  Title: Communication Code

  Read Only: true

  Maximum Length: 30

  The unique code for a communication.
• CommunicationDate: string (date-time)
  Title: Communication Date

  Read Only: true

  The date on which a communication was sent to a recipient.
• CommunicationMessageText: string
  Title: Communication Message Text

  Read Only: true

  The text of the message sent to the communication recipient.
• CommunicationName: string
  Title: Communication Name

  Read Only: true

  Maximum Length: 50

  The name of the communication that was sent to a recipient.
• CommunicationStatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  The code identifier for the status of a sent communication, such as the code for delivered or undelivered status. A list of accepted values is defined in the lookup type ORA_HEY_COMM_STATUS.
• CommunicationStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The status of a sent communication, such as opened or undelivered. A list of accepted values is defined in the lookup type ORA_HEY_COMM_STATUS.
• CommunicationSubjectText: string
  Title: Communication Subject Text

  Read Only: true

  Maximum Length: 240

  The text of the subject line of a communication sent to a recipient.
• CommunicationType: string
  Title: Communication Type

  Read Only: true

  Maximum Length: 80

  The lookup meaning of the communication type code. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE.
• CommunicationTypeCode: string
  Title: Communication Type Code

  Read Only: true

  Maximum Length: 30

  The code for the type of communication, such as an event-based communication. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE.
• ConsumerResourceId: integer (int64)
  Title: Consumer Resource ID

  The unique identifier for the communication recipient whose action needs to be recorded.
• EmailBcc: string
  Title: Bcc

  Read Only: true

  The email addresses of those who were blind carbon copied on an email communication.
• EmailCc: string
  Title: Cc

  Read Only: true

  The email addresses of those who were carbon copied on an email communication.
• EmailFrom: string
  Title: Email From

  Read Only: true

  Maximum Length: 255

  The sender email address of the email communication.
• EmailReplyTo: string
  Title: Reply To

  Read Only: true

  Maximum Length: 320

  Email address of the reply to entered in the communication.
• EmailResendFlag: boolean
  Title: Resend Indicator

  Maximum Length: 1

  Indicates whether the communication is to be resent. The acceptable values are Y, N, true, or false.
• EmailTo: string
  Title: To

  Read Only: true

  Maximum Length: 320

  The email address of the communication recipient.
• EventName: string
  Title: Event Name

  Read Only: true

  Maximum Length: 50

  The name of an event that triggers a communication.
• EventType: string
  Title: Event Type

  Read Only: true

  Maximum Length: 80

  The lookup meaning of the event type code. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.
• EventTypeCode: string
  Title: Event Type Code

  Read Only: true

  Maximum Length: 30

  The code that indicates the type of the event, such as ORA_HEY_TRANSACTIONAL and ORA_HEY_DATE_BASED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageResponseCode: string
  Title: Message Response

  Maximum Length: 30

  The action taken by the user to respond to an actionable communication. Examples of values are ORA_HEY_COMM_ACTION_ACCEPT and ORA_HEY_COMM_ACTION_DENY. A list of accepted values is defined in the lookup type ORA_HEY_COMM_ACTION_TYPE.
• MessageResponseDate: string (date-time)
  Title: Message Response Date

  The date on which the recipient responded to the actionable email.
• ParentCommHistoryId: integer (int64)
  Title: Parent History ID

  Read Only: true

  The unique identifier of the initial communication instance that was sent to the recipient.
• RecipientId: integer (int64)
  Title: Recipient ID

  Read Only: true

  The unique identifier for the communication recipient.
• RecipientName: string
  Title: Recipient Name

  Read Only: true

  The preferred name of a communication recipient.
• ResendCount: integer (int32)
  Title: Resend Count

  Read Only: true

  The number of times the communication was resent.
• ResendDate: string (date-time)
  Title: Resend Date

  Read Only: true

  The date on which a communication was last resent to a recipient.
• ResponseToken: string
  Title: Response Token

  Maximum Length: 64

  The response token which would be provided by consumer to identify a specific user.
• TrackingMessageText: string (byte)
  Title: Tracking Message Text

  The tracking message of the messaging server about delivery of the communication.

{
    "type":"object",
    "properties":{
        "EmailTo":{
            "title":"To",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the communication recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommHistoryId":{
            "title":"Communication History ID",
            "type":"integer",
            "description":"Identifies the instance in which an individual communication was sent to a recipient.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecipientId":{
            "title":"Recipient ID",
            "type":"integer",
            "description":"The unique identifier for the communication recipient.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":80,
            "type":"string",
            "description":"The lookup meaning of the event type code. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCommHistoryId":{
            "title":"Parent History ID",
            "type":"integer",
            "description":"The unique identifier of the initial communication instance that was sent to the recipient.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailFrom":{
            "title":"Email From",
            "maxLength":255,
            "type":"string",
            "description":"The sender email address of the email communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailResendFlag":{
            "title":"Resend Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the communication is to be resent. The acceptable values are Y, N, true, or false.",
            "nullable":true,
            "x-queryable":true
        },
        "TrackingMessageText":{
            "title":"Tracking Message Text",
            "type":"string",
            "description":"The tracking message of the messaging server about delivery of the communication.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CommunicationChannelCode":{
            "title":"Channel Code",
            "maxLength":30,
            "type":"string",
            "description":"The code identifier for the channel through which a communication was sent, such as the code for email channel. A list of accepted values is defined in the lookup type ORA_HEY_COMM_CHANNEL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationSubjectText":{
            "title":"Communication Subject Text",
            "maxLength":240,
            "type":"string",
            "description":"The text of the subject line of a communication sent to a recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageResponseCode":{
            "title":"Message Response",
            "maxLength":30,
            "type":"string",
            "description":"The action taken by the user to respond to an actionable communication. Examples of values are ORA_HEY_COMM_ACTION_ACCEPT and ORA_HEY_COMM_ACTION_DENY. A list of accepted values is defined in the lookup type ORA_HEY_COMM_ACTION_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageResponseDate":{
            "title":"Message Response Date",
            "type":"string",
            "description":"The date on which the recipient responded to the actionable email.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecipientName":{
            "title":"Recipient Name",
            "type":"string",
            "description":"The preferred name of a communication recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationChannelMeaning":{
            "title":"Channel",
            "maxLength":80,
            "type":"string",
            "description":"The channel through which a communication was sent to a recipient, such as email. A list of accepted values is defined in the lookup type ORA_HEY_COMM_CHANNEL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CommunicationName":{
            "title":"Communication Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the communication that was sent to a recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailBcc":{
            "title":"Bcc",
            "type":"string",
            "description":"The email addresses of those who were blind carbon copied on an email communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventTypeCode":{
            "title":"Event Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of the event, such as ORA_HEY_TRANSACTIONAL and ORA_HEY_DATE_BASED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationStatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of a sent communication, such as opened or undelivered. A list of accepted values is defined in the lookup type ORA_HEY_COMM_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommSetupId":{
            "title":"Communication Setup ID",
            "type":"integer",
            "description":"The unique identifier for a communication setup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CommunicationMessageText":{
            "title":"Communication Message Text",
            "type":"string",
            "description":"The text of the message sent to the communication recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailCc":{
            "title":"Cc",
            "type":"string",
            "description":"The email addresses of those who were carbon copied on an email communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an event that triggers a communication.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseToken":{
            "title":"Response Token",
            "maxLength":64,
            "type":"string",
            "description":"The response token which would be provided by consumer to identify a specific user.",
            "nullable":true,
            "x-queryable":true
        },
        "CommunicationType":{
            "title":"Communication Type",
            "maxLength":80,
            "type":"string",
            "description":"The lookup meaning of the communication type code. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResendDate":{
            "title":"Resend Date",
            "type":"string",
            "description":"The date on which a communication was last resent to a recipient.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResendCount":{
            "title":"Resend Count",
            "type":"integer",
            "description":"The number of times the communication was resent.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "EmailReplyTo":{
            "title":"Reply To",
            "maxLength":320,
            "type":"string",
            "description":"Email address of the reply to entered in the communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationDate":{
            "title":"Communication Date",
            "type":"string",
            "description":"The date on which a communication was sent to a recipient.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationCode":{
            "title":"Communication Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for a communication.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code identifier for the status of a sent communication, such as the code for delivered or undelivered status. A list of accepted values is defined in the lookup type ORA_HEY_COMM_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a category, such as Enrollment or Billing.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationTypeCode":{
            "title":"Communication Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of communication, such as an event-based communication. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumerResourceId":{
            "title":"Consumer Resource ID",
            "type":"integer",
            "description":"The unique identifier for the communication recipient whose action needs to be recorded.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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."
        }
    }
}

Back to Top