機械翻訳について

チャネル通信の作成

post

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication

リクエスト

パス・パラメータ
  • サービス・リクエスト・メッセージの一意の識別子。
  • サービス・リクエストの識別に使用される一意の番号。 サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。 たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
  • 次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Display Name
    最大長: 400
    チャネルの表示名。
  • タイトル: Channel ID
    チャネルの一意の識別子。
  • タイトル: Channel Short Name
    最大長: 450
    チャネルのパブリック一意識別子。
  • タイトル: Collaboration Resource Identifier
    内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。
  • タイトル: Contact Point ID
    連絡中の担当者の担当者レコードの一意の識別子。 担当者は、特定の通信チャネルに対する担当者の識別子です。 たとえば、Eメール・チャネルの担当者はEメール・アドレスで、Twitterの個人の担当者はTwitterハンドルです。
  • タイトル: Inbound Message Object Identifier
    サービス・リクエスト・メッセージを作成したインバウンド・オブジェクトの一意の識別子。
  • タイトル: Object ID
    オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。
  • タイトル: Party ID
    連絡中の個人の一意のパーティ識別子。
  • タイトル: Party Endpoint
    最大長: 1000
    Party_ID所有者との通信に使用されるエンドポイント。 たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはアドホック・パーティに属します。
  • タイトル: Person ID
    サービス・リクエストの担当者である個人の一意の識別子。
  • タイトル: Post Identifier
    最大長: 1000
    サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア・ポスト・レコードの一意の識別子。
  • タイトル: Routing Code
    最大長: 30
    エンドポイントを介したメッセージのルーティング方法を示すコード。 たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_ROUTING_CDで定義されます。
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : serviceRequests-messages-channelCommunication-item-response
タイプ: object
ソースを表示
  • タイトル: Account Name
    読取り専用: true
    最大長: 400
    チャネルに関連付けられたアカウント名。 たとえば、電子メールの場合、アカウント名は、support@abc.comなどのサポート用のインバウンド・メールボックスになります。
  • タイトル: Display Name
    最大長: 400
    チャネルの表示名。
  • タイトル: Channel ID
    チャネルの一意の識別子。
  • タイトル: Channel Short Name
    最大長: 450
    チャネルのパブリック一意識別子。
  • タイトル: Channel Type
    読取り専用: true
    最大長: 30
    チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
  • タイトル: Collaboration ID
    読取り専用: true
    最大長: 255
    対応するネットワークのコラボレーション・ネットワーク・ユーザーの一意の識別子。 この例として、ユーザーのユーザーIDが不足しています。
  • タイトル: Resource Name
    読取り専用: true
    最大長: 400
    コラボレーション・ネットワーク上の外部ユーザーのユーザー名です。
  • タイトル: Collaboration Resource Identifier
    内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。
  • タイトル: Contact Point ID
    連絡中の担当者の担当者レコードの一意の識別子。 担当者は、特定の通信チャネルに対する担当者の識別子です。 たとえば、Eメール・チャネルの担当者はEメール・アドレスで、Twitterの個人の担当者はTwitterハンドルです。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    通信チャネルを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    通信チャネルが作成された日時。
  • タイトル: Inbound Message Object Identifier
    サービス・リクエスト・メッセージを作成したインバウンド・オブジェクトの一意の識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    通信チャネルが最後に更新された日時。
  • タイトル: Updated By
    読取り専用: true
    最大長: 64
    通信チャネルを最後に更新したユーザー。
  • タイトル: Update Login
    読取り専用: true
    最大長: 32
    通信チャネルを最後に更新したユーザーに関連付けられたセッション・ログイン。
  • Links
  • タイトル: Message Number
    読取り専用: true
    最大長: 30
    サービス・リクエスト・メッセージの公開一意識別子。
  • タイトル: Network
    読取り専用: true
    最大長: 30
    ポストのソーシャル・ネットワークを示すコード。 たとえば、Facebook、Twitterです。 受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。
  • タイトル: Object ID
    オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。
  • タイトル: Object Type
    読取り専用: true
    最大長: 30
    デフォルト値: SVC_SR_MESSAGES
    チャネル通信レコードがサービス・リクエストに関連付けられているか、サービス・リクエスト・メッセージに関連付けられているかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_OBJECT_TYPE_CDで定義されます。
  • タイトル: Party ID
    連絡中の個人の一意のパーティ識別子。
  • タイトル: Party Name
    読取り専用: true
    最大長: 360
    連絡中の個人のパーティ名。 ユーザーには、内部リソースまたは顧客担当者を指定できます。
  • タイトル: Party Number
    読取り専用: true
    最大長: 30
    サービス・リクエスト・メッセージに関連付けられている担当者の公開一意識別子。
  • タイトル: Party Endpoint
    最大長: 1000
    Party_ID所有者との通信に使用されるエンドポイント。 たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはアドホック・パーティに属します。
  • タイトル: Person ID
    サービス・リクエストの担当者である個人の一意の識別子。
  • タイトル: Post Identifier
    最大長: 1000
    サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア・ポスト・レコードの一意の識別子。
  • タイトル: Resource ID
    読取り専用: true
    サービス・リクエストに関連付けられたリソースの一意の識別子。 これは、内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーを識別できる外部キーです。
  • タイトル: Resource Type
    読取り専用: true
    最大長: 30
    USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレイティブ・ネットワーク・ユーザーのタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_COLLAB_RES_TYPE_CDで定義されます。
  • タイトル: Routing Code
    最大長: 30
    エンドポイントを介したメッセージのルーティング方法を示すコード。 たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_ROUTING_CDで定義されます。
  • タイトル: ID
    読取り専用: true
    チャネル通信の一意の識別子。
トップに戻る

例:

次の例は、RESTリソースでPOSTリクエストを発行してチャネル通信を作成する方法を示しています。

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

POST /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
"ChannelId":"1"
}

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 201: Created
Date: Wed, 16 Nov 2016 14:05:27 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"ViaId": 300100093739406,
"ObjectTypeCd": "SVC_SR_MESSAGES",
"ObjectId": 300100092588985,
"ChannelId": 1,
"ChannelTypeCd": "ORA_SVC_WEB",
"ChannelAccountName": "Web",
"ChannelDisplayName": "Web-Updated",
"PartyViaEndPoint": null,
"PostIdentifier": null,
"RoutingCd": null,
"PartyId": null,
"PartyName": null,
"ContactPointId": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-11-16T06:05:27-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateDate": "2016-11-16T06:05:27-08:00",
"LastUpdateLogin": "416A6650DC4C12CCE05307B3F20A5EFF",
"links": [
  
{
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406",
"name": "channelCommunication",
"kind": "item",
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
}
,
  
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406",
"name": "channelCommunication",
"kind": "item"
}
,
  
{
"rel": "parent",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985",
"name": "messages",
"kind": "item"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406/lov/RoutingCdLookup",
"name": "RoutingCdLookup",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406/lov/ChannelLOV",
"name": "ChannelLOV",
"kind": "collection"
}
],
}
「トップに戻る」