SRのチャネル通信レコードの作成
post
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication
リクエスト
パス・パラメータ
- SrId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
ChannelDisplayName: string
タイトル:
Display Name
最大長:400
チャネルの表示名。 -
ChannelId: integer (int64)
タイトル:
Channel ID
チャネルの一意の識別子。 -
ChannelShortName: string
タイトル:
Channel Short Name
最大長:450
チャネルのパブリック一意識別子。 -
CollabResourceId: integer (int64)
タイトル:
Collaboration Resource Identifier
内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。 -
ContactPointId: integer (int64)
タイトル:
Contact Point ID
連絡中の担当者の担当者レコードの一意の識別子。 担当者は、特定の通信チャネルに対する担当者の識別子です。 たとえば、Eメール・チャネルの担当者はEメール・アドレスになります。 -
InboundObjectId: integer (int64)
タイトル:
Inbound Message Object Identifier
サービス・リクエストを作成したインバウンド・オブジェクトの一意の識別子。 -
ObjectId: integer (int64)
タイトル:
Object ID
オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。 -
PartyId: integer (int64)
タイトル:
Party ID
連絡中の個人の一意のパーティ識別子。 -
PartyViaEndPoint: string
タイトル:
Party Endpoint
最大長:1000
顧客コンタクトとの通信に使用されるエンドポイント。 たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはパーティに属します。 -
PersonId: integer (int64)
タイトル:
Person ID
担当者の一意のPerson ID。 -
PostIdentifier: string
タイトル:
Post Identifier
最大長:1000
サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア・ポスト・レコードの一意の識別子。 -
RoutingCd: string
タイトル:
Routing Code
最大長:30
エンドポイントを介したメッセージのルーティング方法を示すコード。 たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : internalServiceRequests-channelCommunication-item-response
タイプ:
ソースを表示
object
-
ChannelAccountName: string
タイトル:
Account Name
読取り専用:true
最大長:400
チャネルに関連付けられたアカウント名。 たとえば、Eメールの場合、アカウント名はサポート用のインバウンド・メールボックスになります。 -
ChannelDisplayName: string
タイトル:
Display Name
最大長:400
チャネルの表示名。 -
ChannelId: integer (int64)
タイトル:
Channel ID
チャネルの一意の識別子。 -
ChannelShortName: string
タイトル:
Channel Short Name
最大長:450
チャネルのパブリック一意識別子。 -
ChannelTypeCd: string
タイトル:
Channel Type
読取り専用:true
最大長:30
チャネル・タイプを示すコード。 たとえば、電子メールや電話などです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。 -
CollabId: string
タイトル:
Collaboration ID
読取り専用:true
最大長:255
対応するネットワークのコラボレーション・ネットワーク・ユーザーの一意の識別子(Slack IDなど)。 -
CollabName: string
タイトル:
Resource Name
読取り専用:true
最大長:400
コラボレーション・ネットワーク上の外部ユーザーのユーザー名です。 -
CollabResourceId: integer (int64)
タイトル:
Collaboration Resource Identifier
内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。 -
ContactPointId: integer (int64)
タイトル:
Contact Point ID
連絡中の担当者の担当者レコードの一意の識別子。 担当者は、特定の通信チャネルに対する担当者の識別子です。 たとえば、Eメール・チャネルの担当者はEメール・アドレスになります。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
通信チャネルを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
通信チャネルが作成された日時。 -
DeleteFlag: boolean
タイトル:
Can Delete
読取り専用:true
チャネル通信が削除されたかどうかを示します。 -
InboundObjectId: integer (int64)
タイトル:
Inbound Message Object Identifier
サービス・リクエストを作成したインバウンド・オブジェクトの一意の識別子。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
通信チャネルが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Updated By
読取り専用:true
最大長:64
通信チャネルを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Update Login
読取り専用:true
最大長:32
通信チャネルを最後に更新したユーザーに関連付けられたセッション・ログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NetworkTypeCd: string
タイトル:
Network
読取り専用:true
最大長:30
ポストのソーシャル・ネットワークを示すコード。 たとえば、Facebook、Twitterです。 受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。 -
ObjectId: integer (int64)
タイトル:
Object ID
オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。 -
ObjectTypeCd: string
タイトル:
Object Type
読取り専用:true
最大長:30
デフォルト値:SVC_SERVICE_REQUESTS
チャネル通信レコードがサービス・リクエストに関連付けられているか、サービス・リクエスト・メッセージに関連付けられているかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_OBJECT_TYPE_CDで定義されます。 -
PartyId: integer (int64)
タイトル:
Party ID
連絡中の個人の一意のパーティ識別子。 -
PartyName: string
タイトル:
Party Name
読取り専用:true
最大長:360
連絡中の個人のパーティ名。 -
PartyNumber: string
タイトル:
Party Number
読取り専用:true
最大長:30
サービス・リクエスト通信に関連付けられている担当者の公開一意識別子。 -
PartyViaEndPoint: string
タイトル:
Party Endpoint
最大長:1000
顧客コンタクトとの通信に使用されるエンドポイント。 たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはパーティに属します。 -
PersonId: integer (int64)
タイトル:
Person ID
担当者の一意のPerson ID。 -
PostIdentifier: string
タイトル:
Post Identifier
最大長:1000
サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア・ポスト・レコードの一意の識別子。 -
ResourceId: integer (int64)
タイトル:
Resource ID
読取り専用:true
サービス・リクエストに関連付けられたリソースの一意の識別子。 これは、内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーを識別できる外部キーです。 -
ResourceTypeCd: string
タイトル:
Resource Type
読取り専用:true
最大長:30
USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレイティブ・ネットワーク・ユーザーのタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_COLLAB_RES_TYPE_CDで定義されます。 -
RoutingCd: string
タイトル:
Routing Code
最大長:30
エンドポイントを介したメッセージのルーティング方法を示すコード。 たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。 -
UpdateFlag: boolean
タイトル:
Can Update
読取り専用:true
チャネル通信が更新されたかどうかを示します。 -
ViaId: integer (int64)
タイトル:
ID
読取り専用:true
サービス・リクエスト・チャネル通信レコードの一意の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- ChannelLOV
-
パラメータ:
- ファインダ:
ChannelEnabledFinder
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ChannelDisplayName;ターゲット属性: DisplayName
- 表示属性: DisplayName, ChannelTypeCd, AccountName, ChannelId
- ファインダ:
- RoutingCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_ROUTING_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: RoutingCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ: