Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

会話メッセージ受信者の作成

post

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

リクエスト

パス・パラメータ

MessageNumber(required): string

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

FreeFormAddress: string

タイトル: Free Form Address

最大長: 320

会話メッセージ受信者の自由形式アドレス。例:送信者の電子メール・アドレス。
MessageId: integer (int64)

タイトル: Message ID

会話メッセージの一意の識別子。
MessageNumber: string

タイトル: Message Number

最大長: 30

会話メッセージの代替キー識別子。
PersonId: integer (int64)

タイトル: Person ID

受信者の一意の識別子。受信者が従業員や非従業員などの内部個人の場合は、この値がロードされます。
RecipientAlternateId: integer (int64)

タイトル: Recipient Alternate ID

外部システム内の受信者の識別子など、受信者の代替識別子。
RecipientAlternateMessageId: string

タイトル: Message Alternate ID

最大長: 1000

外部システム内のメッセージの代替識別子。
RecipientNumber: string

タイトル: Recipient Number

最大長: 30

会話メッセージ受信者の公開一意識別子。
RecipientPartyId: integer (int64)

タイトル: Recipient Party ID

会話メッセージ受信者のパーティの一意の識別子。
RecipientPartyTypeCd: string

タイトル: Recipient Party Type Code

最大長: 30

ORA_SVC_BUSINESS_CONTACT、ORA_SVC_RESOURCEなど、メッセージ受信者のパーティ・タイプ・コード。
RecipientTypeCd: string

タイトル: Recipient Type Code

最大長: 30

TO、CC、BCCなど、会話メッセージの受信者のタイプを示すコード。

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

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : conversationMessages-recipients-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

会話メッセージ受信者を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

会話メッセージ受信者が作成された日付。
FreeFormAddress: string

タイトル: Free Form Address

最大長: 320

会話メッセージ受信者の自由形式アドレス。例:送信者の電子メール・アドレス。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

会話メッセージ受信者が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

会話メッセージ受信者を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

会話メッセージ受信者を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MessageId: integer (int64)

タイトル: Message ID

会話メッセージの一意の識別子。
MessageNumber: string

タイトル: Message Number

最大長: 30

会話メッセージの代替キー識別子。
PersonId: integer (int64)

タイトル: Person ID

受信者の一意の識別子。受信者が従業員や非従業員などの内部個人の場合は、この値がロードされます。
RecipientAlternateId: integer (int64)

タイトル: Recipient Alternate ID

外部システム内の受信者の識別子など、受信者の代替識別子。
RecipientAlternateMessageId: string

タイトル: Message Alternate ID

最大長: 1000

外部システム内のメッセージの代替識別子。
RecipientId: integer (int64)

タイトル: Recipient ID

読取り専用: true

会話メッセージ受信者の一意の識別子。
RecipientNumber: string

タイトル: Recipient Number

最大長: 30

会話メッセージ受信者の公開一意識別子。
RecipientPartyId: integer (int64)

タイトル: Recipient Party ID

会話メッセージ受信者のパーティの一意の識別子。
RecipientPartyName: string

タイトル: Recipient Name

読取り専用: true

最大長: 360

会話メッセージ受信者のパーティの名前。
RecipientPartyNumber: string

タイトル: Recipient Party Number

読取り専用: true

最大長: 30

会話メッセージ受信者のパーティの代替キー識別子。
RecipientPartyTypeCd: string

タイトル: Recipient Party Type Code

最大長: 30

ORA_SVC_BUSINESS_CONTACT、ORA_SVC_RESOURCEなど、メッセージ受信者のパーティ・タイプ・コード。
RecipientTypeCd: string

タイトル: Recipient Type Code

最大長: 30

TO、CC、BCCなど、会話メッセージの受信者のタイプを示すコード。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

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

リンク

RecipientPartyTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_SENDER_RECIPIENT_TYPE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: RecipientPartyTypeCd;ターゲット属性: LookupCode
表示属性: 意味

RecipientTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_ROUTING_CD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: RecipientTypeCd;ターゲット属性: LookupCode
表示属性: 意味

「トップに戻る」