Jump to

• Request
• Response

Create a conversation message recipient

post

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

Request

Path Parameters

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

Header Parameters

• Metadata-Context: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• FreeFormAddress: string
  Title: Free Form Address

  Maximum Length: 320

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

  The unique identifier of the conversation message.
• 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.
• 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.
• 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":{
        "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"
            }
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the conversation message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the conversation message.",
            "nullable":false
        },
        "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
            }
        },
        "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
            }
        },
        "RecipientAlternateMessageId":{
            "title":"Message Alternate ID",
            "maxLength":1000,
            "type":"string",
            "description":"The alternate identifier of the message in an external system.",
            "nullable":true
        },
        "RecipientNumber":{
            "title":"Recipient Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the conversation message recipient.",
            "nullable":false
        },
        "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
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

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

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

RecipientPartyTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SENDER_RECIPIENT_TYPE

The following properties are defined on the LOV link relation:

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

RecipientTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_ROUTING_CD

The following properties are defined on the LOV link relation:

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

Back to Top