通話を更新
patch
/crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}
リクエスト
パス・パラメータ
- ConversationNumber(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
BUOrgId: integer (int64)
タイトル:
Business Unit ID会話に関連付けられているビジネス・ユニット組織の一意の識別子。 -
ConversationAlternateId: string
タイトル:
Conversation Alternate ID最大長:255会話の代替一意識別子。 -
conversationReferences: array Conversation References
タイトル:
Conversation References会話参照。 -
ConversationStatusCd: string
タイトル:
Conversation Status Code最大長:30OPENやCLOSEDなど、会話のステータスを示すコード。 -
OriginalSystemReference: string
タイトル:
Original Application Reference最大長:1000元のアプリケーションからの会話メッセージの一意の参照キー。 -
OriginatedConversationId: integer (int64)
タイトル:
Originated Conversation ID現在の会話が作成された元の会話の一意の識別子。
ネストされたスキーマ : conversations-conversationReferences-item-patch-request
タイプ:
ソースを表示
object-
ConversationId: integer (int64)
タイトル:
Conversation IDビジネス・オブジェクトが関連付けられている会話の一意の識別子。 -
ObjectId: integer (int64)
タイトル:
Object ID会話に関連付けられたビジネス・オブジェクトの一意の識別子。 -
ObjectNumber: string
タイトル:
Object Number最大長:255会話に関連付けられたビジネス・オブジェクトの代替キー識別子。 -
ObjectTypeCd: string
タイトル:
Object Type最大長:30会話に関連付けられているビジネス・オブジェクトのタイプを示すコード(SVC_SERVICE_REQUESTSなど)。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : conversations-item-response
タイプ:
ソースを表示
object-
BUOrgId: integer (int64)
タイトル:
Business Unit ID会話に関連付けられているビジネス・ユニット組織の一意の識別子。 -
ConversationAlternateId: string
タイトル:
Conversation Alternate ID最大長:255会話の代替一意識別子。 -
ConversationId: integer (int64)
タイトル:
Conversation ID読取り専用:true会話の一意の識別子。 -
ConversationNumber: string
タイトル:
Conversation Number最大長:30会話の代替キー識別子。 -
conversationReferences: array Conversation References
タイトル:
Conversation References会話参照。 -
ConversationSortDate: string (date-time)
タイトル:
Conversation Sort Date読取り専用:true会話をソートするために使用できる日付フィールド。 現在は、会話のメッセージが更新された最新の日付です。 -
ConversationStatusCd: string
タイトル:
Conversation Status Code最大長:30OPENやCLOSEDなど、会話のステータスを示すコード。 -
ConversationStatusCdMeaning: string
タイトル:
Conversation Status読取り専用:true最大長:255会話のステータス(オープンやクローズ済など)。 -
ConversationTypeCd: string
タイトル:
Conversation Type Code最大長:30顧客やコラボレーションなど、会話のタイプを示すコード。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64会話を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:true会話が作成された日付。 -
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リソース・インスタンスに関連付けられたリンク関係。 -
OriginalSystemReference: string
タイトル:
Original Application Reference最大長:1000元のアプリケーションからの会話メッセージの一意の参照キー。 -
OriginatedConversationId: integer (int64)
タイトル:
Originated Conversation ID現在の会話が作成された元の会話の一意の識別子。 -
OriginatedConversationNumber: string
タイトル:
Originating Conversation Number最大長:30現在の会話が作成された元の会話の代替キー識別子。 -
PrimaryMessageId: integer (int64)
タイトル:
Primary Message ID会話のプライマリ・メッセージの一意の識別子。 -
PrimaryMessageNumber: string
タイトル:
Primary Message Number最大長:30会話のプライマリ・メッセージの代替キー識別子。 -
PrimaryMessageTitle: string
タイトル:
Subject読取り専用:true最大長:1000会話に関連付けられているプライマリ・メッセージのタイトル。 -
StripeCd: string
タイトル:
Stripe Code最大長:30CRM、HRHD、ISRなど、会話のアプリケーション・ストライプを示すコード。
ネストされたスキーマ : conversations-conversationReferences-item-response
タイプ:
ソースを表示
object-
ConversationId: integer (int64)
タイトル:
Conversation IDビジネス・オブジェクトが関連付けられている会話の一意の識別子。 -
ConversationNumber: string
タイトル:
Conversation Number最大長:30ビジネス・オブジェクトが関連付けられている会話の代替キー識別子。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64会話参照を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:true会話参照が作成された日付。 -
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リソース・インスタンスに関連付けられたリンク関係。 -
ObjectId: integer (int64)
タイトル:
Object ID会話に関連付けられたビジネス・オブジェクトの一意の識別子。 -
ObjectNumber: string
タイトル:
Object Number最大長:255会話に関連付けられたビジネス・オブジェクトの代替キー識別子。 -
ObjectTypeCd: string
タイトル:
Object Type最大長:30会話に関連付けられているビジネス・オブジェクトのタイプを示すコード(SVC_SERVICE_REQUESTSなど)。 -
ObjectTypeCdMeaning: string
タイトル:
Object Type読取り専用:true最大長:255商談、サービス・リクエスト、アクティビティ、営業リードまたはアカウントなどのオブジェクト・タイプ。 -
ReferenceId: integer (int64)
タイトル:
Reference ID読取り専用:true会話参照の一意の識別子。 -
ReferenceNumber: string
タイトル:
Reference Number最大長:30会話参照の公開一意識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- ConversationStatusCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MC_CONV_STATUS_TYPE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ConversationStatusCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ConversationTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MC_CONV_TYPE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ConversationTypeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- StripeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: StripeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- conversationReferences
-
操作: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferencesパラメータ:
- ConversationNumber:
$request.path.ConversationNumber
会話参照。 - ConversationNumber:
例:
次の例は、cURLを使用してRESTリソースでPATCHリクエストを発行して、会話を更新する方法を示しています。
cURLコマンド
curl --location --request PATCH 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversations/CDRM_0000000005' \
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"ConversationStatusCd":"ORA_SVC_CLOSED"
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"ConversationId": 300100547289438,
"ConversationNumber": "CDRM_0000000005",
"ConversationStatusCd": "ORA_SVC_CLOSED",
"ConversationStatusCdMeaning": "Open",
"ConversationTypeCd": "ORA_SVC_COLLABORATION",
"ConversationSortDate": "2021-11-03T05:57:28.743+00:00",
"CreatedBy": "MHoope",
"CreationDate": "2021-09-22T07:02:29.215+00:00",
"LastUpdateDate": "2021-11-03T05:59:58+00:00",
"LastUpdateLogin": "CEFAD71A19DF5671E0532048F70AE6AE",
"LastUpdatedBy": "SALES_ADMIN",
"OriginatedConversationId": null,
"OriginatedConversationNumber": null,
"PrimaryMessageId": 300100547289437,
"PrimaryMessageNumber": "CDRM_0000000005",
"PrimaryMessageTitle": "Slack conversation started by Matt Hooper with #general",
"StripeCd": "ORA_SVC_CRM",
"BUOrgId": 204,
"ConversationAlternateId": null,
"links": [
...
}