すべてのインタラクションを取得
get
/crmRestApi/resources/11.13.18.05/interactions
リクエスト
問合せパラメータ
- expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- InteractionRowFinderById : 顧客対応識別子との顧客対応を検索します。
ファインダ変数:- BindInteractionId; integer;一意の相互作用識別子。
- BindStripeCd; string; 相互作用ストライプ・コード。
- InteractionRowFinderByMediaItemId : メディア・アイテム識別子による顧客対応の検索
ファインダ変数:- BindMediaItemId; string;インタラクションのメディア・アイテム識別子。
- InteractionRowFinderByObject : オブジェクトに関連付けられた顧客対応を検索します。
ファインダ変数:- ObjectId; integer;オブジェクトの一意の識別子。
- ObjectTypeCd; string; オブジェクトのタイプを示すコード。
- InteractionRowFinderByOwnerCustomerTime : 所有者識別子、顧客識別子および時間別の顧客対応を検索します。
ファインダ変数:- BindAccountPartyId; integer.
- BindContactPartyId; integer.
- BindCreationDate; string.
- BindInteractionId; integer.
- BindLastUpdateDate; string.
- BindOwnerResourceId; integer.
- BindStatusCd; string.
- InteractionRowFinderByOwnerCustomerTimeObject : 所有者識別子、顧客識別子、時間およびオブジェクトなど、指定された主キーとの子顧客対応を検索
ファインダ変数:- BindAccountPartyId; integer.
- BindContactPartyId; integer.
- BindCreationDate; string.
- BindInteractionId; integer.
- BindLastUpdateDate; string.
- BindOwnerResourceId; integer.
- BindStatusCd; string.
- ObjectId; integer.
- ObjectTypeCd; string.
- OpenChildInteractionRowFinderByChannelCustomerOwner : チャネルおよび顧客別の顧客対応を検索します。
ファインダ変数:- BindAccountPartyId; integer; 顧客対応に関連付けられているアカウントの一意の識別子。
- BindChannelId; integer;インタラクション・チャネルの一意の識別子。
- BindContactPartyId; integer; 顧客対応に関連付けられている担当者の一意の識別子。
- BindOwnerResourceId; integer; インタラクションの所有者の一意の識別子。
- BindParentInteractionId; integer;親顧客対応の一意の識別子。
- PrimaryKey : 指定された主キーとの相互作用を検索します。
ファインダ変数:- InteractionId; integer;相互作用の一意の識別子。
- InteractionRowFinderById : 顧客対応識別子との顧客対応を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AccountPartyId; integer; 顧客対応に関連付けられているアカウントの一意の識別子。
- AccountPartyNumber; string; アカウント識別子の代替キー。
- AccountPartyUniqueName; string;顧客対応に関連付けられているアカウントの一意のアカウント名。
- AgentHTTPSessionId; string; httpセッションの一意の識別子。
- ChannelDisplayName; string;対話チャネルの名前。
- ChannelId; integer;インタラクション・チャネルの一意の識別子。
- ChannelShortName; string;インタラクション・チャネルの短縮名。
- ChannelTypeCd; string; インタラクション・チャネルのタイプを示すコード。
- ContactPartyId; integer; 顧客対応に関連付けられている担当者の一意の識別子。
- ContactPartyNumber; string; 担当者パーティの代替キー識別子。
- ContactPartyUniqueName; string;顧客対応に関連付けられている担当者の一意の担当者名。
- CreatedBy; string;顧客対応を作成したユーザー。
- CreationDate; string;顧客対応が作成された日時。
- 説明;文字列;子インタラクションの説明。
- DirectionCd; string; 相互作用がインバウンドかアウトバウンドかを示すコード。 デフォルト値はORA_SVC_INBOUNDで、インバウンド相互作用を示します。 値は、アウトバウンド・インタラクションのORA_SVC_OUTBOUNDです。
- EndTime; string; 相互作用が終了した時間。
- InteractionId; integer;相互作用の一意の識別子。
- InteractionNumber; string;相互作用の代替キー識別子。
- LastUpdateDate; string;顧客対応が最後に更新された日付。
- LastUpdateLogin; string;顧客対応を最後に更新したユーザーのセッション・ログイン。
- LastUpdatedBy; string;顧客対応を最後に更新したユーザー。
- ManuallyLoggedFlag; boolean;顧客対応が手動で作成されたかどうかを示します。 手動で作成された値はY、それ以外の場合はNです。
- MarketingReferenceId; integer; マーケティング・システム・デプロイメント番号への参照を格納するために使用される一意の識別子。
- MediaItemId; string;メディア・アイテムの一意の識別子。
- OriginalSystemReference; string;顧客対応で使用されるシステム参照。
- OwnerResourceId; integer; インタラクションの所有者の一意の識別子。
- OwnerResourcePartyNumber; string;顧客対応の所有者の代替キー識別子。
- OwnerResourcePartyUniqueName; string;インタラクションの所有者の一意の名前。
- ParentInteractionId; integer;親顧客対応の一意の識別子。
- ParentInteractionNumber; string;親相互作用を表す代替キー識別子。
- QueueId; integer;相互作用キューの一意の識別子。
- QueueName; string;相互作用キューの名前。
- QueueNumber; string;キューの代替キー識別子。
- SourceCd; string; 子相互作用オブジェクト内にソース・コード参照を格納するために使用される一意の識別子。
- StartTime; string;インタラクションが開始された時間。
- StatusCd; string;顧客対応の現在のステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。
- StripeCd; string; インタラクションのストライプを示すコード。 有効な値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。
- SubstatusCd; string;顧客対応のサブステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_CLOSED_SUBSTATUS_CDで定義されます。
- TopLevelFlag; boolean;インタラクションがトップ・レベルかどうかを示します。 親顧客対応識別子が顧客対応識別子と同じ場合、顧客対応は最上位レベルです。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : インタラクション
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : interactions-item-response
タイプ:
ソースを表示
object
-
AccountPartyId: integer (int64)
タイトル:
Account ID
顧客対応に関連付けられたアカウントの一意の識別子。 -
AccountPartyNumber: string
タイトル:
Account Number
読取り専用:true
最大長:30
勘定科目識別子の代替キー。 -
AccountPartyUniqueName: string
タイトル:
Account
読取り専用:true
最大長:900
顧客対応に関連付けられているアカウントの一意のアカウント名。 -
AgentHTTPSessionId: string
タイトル:
Session ID
最大長:100
HTTPセッションの一意の識別子。 -
ChannelDisplayName: string
タイトル:
Channel Display Name
読取り専用:true
最大長:400
相互作用チャネルの名前。 -
ChannelId: integer (int64)
タイトル:
Channel ID
インタラクション・チャネルの一意の識別子。 -
ChannelShortName: string
タイトル:
Channel Code
読取り専用:true
最大長:450
インタラクション・チャネルの短縮名。 -
ChannelTypeCd: string
タイトル:
Channel Type
最大長:30
相互作用チャネルのタイプを示すコード。 -
childInteractions: array Child Interactions
タイトル:
Child Interactions
子顧客対応リソースは、現在の顧客対応に関連付けられているすべての子顧客対応を表示、作成および更新するために使用されます。 -
ContactPartyId: integer (int64)
タイトル:
Contact ID
顧客対応に関連付けられている担当者の一意の識別子。 -
ContactPartyNumber: string
タイトル:
Contact Number
読取り専用:true
最大長:30
担当者パーティの代替キー識別子。 -
ContactPartyUniqueName: string
タイトル:
Contact
読取り専用:true
最大長:900
顧客対応に関連付けられている担当者の一意の担当者名。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
顧客対応を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
顧客対応が作成された日時。 -
DeleteFlag: boolean
読取り専用:
true
顧客対応を現在のユーザーが削除できるかどうかを示します。 デフォルト値はfalseです。 -
Description: string
タイトル:
Description
最大長:1000
子顧客対応の摘要。 -
DirectionCd: string
タイトル:
Direction
最大長:30
デフォルト値:ORA_SVC_INBOUND
顧客対応がインバウンドかアウトバウンドかを示すコード。 デフォルト値はORA_SVC_INBOUNDで、インバウンド相互作用を示します。 値は、アウトバウンド・インタラクションのORA_SVC_OUTBOUNDです。 -
EndInteractionFlag: boolean
タイトル:
End Interaction
これにより、顧客対応ステータスをクローズ済に変更せずに、終了時間属性(現在の時間)が設定されます。 デフォルト値はfalseです。 -
EndTime: string (date-time)
タイトル:
End Time
顧客対応が終了した時間。 -
InteractionId: integer (int64)
タイトル:
Interaction ID
読取り専用:true
顧客対応の一意の識別子。 -
InteractionNumber: string
タイトル:
Interaction Number
最大長:30
顧客対応の代替キー識別子。 -
InteractionParticipants: array Interaction Participants
タイトル:
Interaction Participants
顧客対応関係者リソースは、顧客対応(通常はweb会議)の関係者を表示、作成および更新するために使用されます。 -
interactionReferences: array Interaction References
タイトル:
Interaction References
顧客対応参照リソースは、顧客対応と別のビジネス・オブジェクト(サービス・リクエストなど)間の関連を表示、作成および更新するために使用されます。 サポートされるビジネス・オブジェクトとそのコードは、アクティビティ(ZMM_ACTIVITIES)、商談(MOO_OPTY)、作業オーダー(SVC_WORK_ORDERS)、サービス・リクエスト(SVC_SERVICE_REQUESTS)およびリード(MKL_LM_LEADS)です。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
ManuallyLoggedFlag: boolean
最大長:
1
顧客対応が手動で作成されたかどうかを示します。 手動で作成された値はY、それ以外の場合はNです。 -
MarketingReferenceId: integer (int64)
タイトル:
Marketing Reference ID
マーケティング・システム・デプロイメント番号への参照を格納するために使用される一意の識別子。 -
MediaItemId: string
タイトル:
Media Item ID
最大長:80
メディア・アイテムの一意の識別子。 -
OriginalSystemReference: string
タイトル:
Original System
最大長:255
顧客対応で使用されるシステム参照。 -
OwnerResourceId: integer (int64)
タイトル:
Owner Resource ID
顧客対応の所有者の一意の識別子。 -
OwnerResourcePartyNumber: string
タイトル:
Resource Number
読取り専用:true
最大長:30
顧客対応の所有者の代替キー識別子。 -
OwnerResourcePartyUniqueName: string
タイトル:
Resource Name
読取り専用:true
最大長:900
顧客対応の所有者の一意の名前。 -
ParentInteractionId: integer (int64)
タイトル:
Parent Interaction ID
親顧客対応の一意の識別子。 -
ParentInteractionNumber: string
タイトル:
Interaction Number
読取り専用:true
最大長:30
親顧客対応の代替キー識別子。 -
ペイロード: 文字列(バイト)
タイトル:
Payload
顧客対応に関連付けられたペイロード。 -
QueueId: integer (int64)
タイトル:
Queue ID
インタラクション・キューの一意の識別子。 -
QueueName: string
タイトル:
Queue Name
読取り専用:true
最大長:400
インタラクション・キューの名前。 -
QueueNumber: string
タイトル:
Queue Number
最大長:30
キューの代替キー識別子。 -
SourceCd: string
タイトル:
Source CD
最大長:30
子顧客対応オブジェクト内にソース・コード参照を格納するために使用される一意の識別子。 -
StartInteractionFlag: boolean
タイトル:
Start Interaction
デフォルト値:true
顧客対応がすでに開始されている場合に開始する必要があるかどうかを示します。 デフォルト値はTrueです。 -
StartTime: string (date-time)
タイトル:
Start Time
顧客対応が開始した時間。 -
StatusCd: string
タイトル:
Status
最大長:30
デフォルト値:ORA_SVC_OPEN
顧客対応の現在のステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。 -
StripeCd: string
タイトル:
Stripe Code
最大長:30
顧客対応のストライプを示すコード。 有効な値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。 -
SubstatusCd: string
タイトル:
Substatus Code
最大長:30
顧客対応のサブステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_CLOSED_SUBSTATUS_CDで定義されます。 -
TopLevelFlag: boolean
タイトル:
Top Level
読取り専用:true
顧客対応がトップ・レベルかどうかを示します。 親顧客対応識別子が顧客対応識別子と同じ場合、顧客対応は最上位レベルです。 -
UpdateFlag: boolean
読取り専用:
true
顧客対応を現在のユーザーが更新できるかどうかを示します。 ユーザーが顧客対応を更新するためのアクセス権を持っている場合、デフォルト値はtrueです。
ネストされたスキーマ : 子顧客対応
タイプ:
array
タイトル:
Child Interactions
子顧客対応リソースは、現在の顧客対応に関連付けられているすべての子顧客対応を表示、作成および更新するために使用されます。
ソースを表示
ネストされたスキーマ : 顧客対応関係者
タイプ:
array
タイトル:
Interaction Participants
顧客対応関係者リソースは、顧客対応(通常はweb会議)の関係者を表示、作成および更新するために使用されます。
ソースを表示
ネストされたスキーマ : 顧客対応参照
タイプ:
array
タイトル:
Interaction References
顧客対応参照リソースは、顧客対応と別のビジネス・オブジェクト(サービス・リクエストなど)間の関連を表示、作成および更新するために使用されます。 サポートされるビジネス・オブジェクトとそのコードは、アクティビティ(ZMM_ACTIVITIES)、商談(MOO_OPTY)、作業オーダー(SVC_WORK_ORDERS)、サービス・リクエスト(SVC_SERVICE_REQUESTS)およびリード(MKL_LM_LEADS)です。
ソースを表示
ネストされたスキーマ : interactions-childInteractions-item-response
タイプ:
ソースを表示
object
-
AccountPartyId: integer (int64)
タイトル:
Account ID
顧客対応に関連付けられたアカウントの一意の識別子。 -
AccountPartyNumber: string
タイトル:
Account Number
読取り専用:true
最大長:30
勘定科目識別子の代替キー。 -
AccountPartyUniqueName: string
タイトル:
Account
読取り専用:true
最大長:900
顧客対応に関連付けられているアカウントの一意のアカウント名。 -
AgentHTTPSessionId: string
タイトル:
Session ID
最大長:100
HTTPセッションの一意の識別子。 -
ChannelDisplayName: string
タイトル:
Channel Display Name
読取り専用:true
最大長:400
相互作用チャネルの名前。 -
ChannelId: integer (int64)
タイトル:
Channel ID
インタラクション・チャネルの一意の識別子。 -
ChannelShortName: string
タイトル:
Channel Code
読取り専用:true
最大長:450
インタラクション・チャネルの短縮名。 -
ChannelTypeCd: string
タイトル:
Channel Type
最大長:30
相互作用チャネルのタイプを示すコード。 -
ContactPartyId: integer (int64)
タイトル:
Contact ID
顧客対応に関連付けられている担当者の一意の識別子。 -
ContactPartyNumber: string
タイトル:
Contact Number
読取り専用:true
最大長:30
担当者パーティの代替キー識別子。 -
ContactPartyUniqueName: string
タイトル:
Contact
読取り専用:true
最大長:900
顧客対応に関連付けられている担当者の一意の担当者名。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
顧客対応を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
顧客対応が作成された日時。 -
DeleteFlag: boolean
読取り専用:
true
顧客対応を現在のユーザーが削除できるかどうかを示します。 デフォルト値はfalseです。 -
Description: string
タイトル:
Description
最大長:1000
子顧客対応の摘要。 -
DirectionCd: string
タイトル:
Direction
最大長:30
デフォルト値:ORA_SVC_INBOUND
顧客対応がインバウンドかアウトバウンドかを示すコード。 デフォルト値はORA_SVC_INBOUNDで、インバウンド相互作用を示します。 値は、アウトバウンド・インタラクションのORA_SVC_OUTBOUNDです。 -
EndInteractionFlag: boolean
タイトル:
End Interaction
これにより、顧客対応ステータスをクローズ済に変更せずに、終了時間属性(現在の時間)が設定されます。 デフォルト値はfalseです。 -
EndTime: string (date-time)
タイトル:
End Time
顧客対応が終了した時間。 -
InteractionId: integer (int64)
タイトル:
Interaction ID
読取り専用:true
顧客対応の一意の識別子。 -
InteractionNumber: string
タイトル:
Interaction Number
最大長:30
顧客対応の代替キー識別子。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
ManuallyLoggedFlag: boolean
最大長:
1
顧客対応が手動で作成されたかどうかを示します。 手動で作成された値はY、それ以外の場合はNです。 -
MarketingReferenceId: integer (int64)
タイトル:
Marketing Reference ID
マーケティング・システム・デプロイメント番号への参照を格納するために使用される一意の識別子。 -
MediaItemId: string
タイトル:
Media Item ID
最大長:80
メディア・アイテムの一意の識別子。 -
OriginalSystemReference: string
タイトル:
Original System
最大長:255
顧客対応で使用されるシステム参照。 -
OwnerResourceId: integer (int64)
タイトル:
Owner Resource ID
顧客対応の所有者の一意の識別子。 -
OwnerResourcePartyNumber: string
タイトル:
Resource Number
読取り専用:true
最大長:30
顧客対応の所有者の代替キー識別子。 -
OwnerResourcePartyUniqueName: string
タイトル:
Resource Name
読取り専用:true
最大長:900
顧客対応の所有者の一意の名前。 -
ParentInteractionId: integer (int64)
タイトル:
Parent Interaction ID
親顧客対応の一意の識別子。 -
ParentInteractionNumber: string
タイトル:
Interaction Number
読取り専用:true
最大長:30
親顧客対応の代替キー識別子。 -
ペイロード: 文字列(バイト)
タイトル:
Payload
顧客対応に関連付けられたペイロード。 -
QueueId: integer (int64)
タイトル:
Queue ID
インタラクション・キューの一意の識別子。 -
QueueName: string
タイトル:
Queue Name
読取り専用:true
最大長:400
インタラクション・キューの名前。 -
QueueNumber: string
タイトル:
Queue Number
最大長:30
キューの代替キー識別子。 -
SourceCd: string
タイトル:
Source CD
最大長:30
子顧客対応オブジェクト内にソース・コード参照を格納するために使用される一意の識別子。 -
StartInteractionFlag: boolean
タイトル:
Start Interaction
デフォルト値:true
顧客対応がすでに開始されている場合に開始する必要があるかどうかを示します。 デフォルト値はTrueです。 -
StartTime: string (date-time)
タイトル:
Start Time
顧客対応が開始した時間。 -
StatusCd: string
タイトル:
Status
最大長:30
デフォルト値:ORA_SVC_OPEN
顧客対応の現在のステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_STATUS_CDで定義されます。 -
StripeCd: string
タイトル:
Stripe Code
最大長:30
顧客対応のストライプを示すコード。 有効な値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。 -
SubstatusCd: string
タイトル:
Substatus Code
最大長:30
顧客対応のサブステータスを示すコード。 有効な値のリストは、参照ORA_SVC_IM_CLOSED_SUBSTATUS_CDで定義されます。 -
TopLevelFlag: boolean
タイトル:
Top Level
読取り専用:true
顧客対応がトップ・レベルかどうかを示します。 親顧客対応識別子が顧客対応識別子と同じ場合、顧客対応は最上位レベルです。 -
UpdateFlag: boolean
読取り専用:
true
顧客対応を現在のユーザーが更新できるかどうかを示します。 ユーザーが顧客対応を更新するためのアクセス権を持っている場合、デフォルト値は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値を変更します。
ネストされたスキーマ : interactions-InteractionParticipants-item-response
タイプ:
ソースを表示
object
-
ContactPartyId: integer (int64)
タイトル:
Contact Party ID
参加者が担当者の場合は、担当者のPartyId。 -
ContactPartyNumber: string
タイトル:
Contact Party Number
読取り専用:true
最大長:30
参加者が担当者の場合は、担当者のパーティ番号。 -
ContactPartyUniqueName: string
タイトル:
Contact Unique Name
読取り専用:true
最大長:900
参加者が担当者の場合は、担当者の一意の名前。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
関係者を追加したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
参加者が追加された日付。 -
DurationMinutes: 整数(int32)
タイトル:
Minutes
参加者が会議に参加していた分数。 会議に参加、削除および参加できます。 -
Email: string
タイトル:
Email
最大長:128
参加者のEメール。 -
EndTime: string (date-time)
タイトル:
End Time
参加者が顧客対応を終了した時間。 -
InteractionId: integer (int64)
タイトル:
Interaction ID
参加者が属するインタラクションの顧客対応ID。 -
InteractionParticipantId: integer (int64)
タイトル:
Participant ID
読取り専用:true
この参加者の自動生成された番号と主キー。 -
InteractionParticipantNumber: string
タイトル:
Participant Number
最大長:30
顧客対応関係者の公開一意識別子。 -
Json: 文字列(バイト)
タイトル:
JSON
カスタマイズに使用されるJSON文字列。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
参加者レコードのバージョン。 -
OriginalSystemReference: string
タイトル:
Original System Reference
最大長:255
レコードがインポートされた場合の元のシステム参照を指定します。 -
ParticipantName: string
タイトル:
Name
最大長:128
web会議からの名前。 Fusionデータと必ずしも結び付けられるわけではありません。 -
ParticipantTypeCd: string
タイトル:
Participant Type Code
最大長:30
参加者のタイプ。 値は参照ORA_SVC_PARTICIPANT_TYPE_CDから取得されます。 -
Phone: string
タイトル:
Phone
最大長:128
参加者の電話番号。 -
ResourcePartyId: integer (int64)
タイトル:
Resource Party ID
参加者がリソースの場合のリソースのパーティID。 -
ResourcePartyNumber: string
タイトル:
Resource Party Number
読取り専用:true
最大長:30
参加者がリソースであった場合のリソースのパーティ番号。 -
ResourcePartyUniqueName: string
タイトル:
Resource Unique Name
読取り専用:true
最大長:900
参加者がリソースであった場合のリソースの一意の名前。 -
StartTime: string (date-time)
タイトル:
Start Time
参加者が顧客対応に参加した時間。
ネストされたスキーマ : interactions-interactionReferences-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
参照を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
参照が作成された日時。 -
DeleteFlag: boolean
読取り専用:
true
顧客対応参照を現在のユーザーが削除できるかどうかを示します。 デフォルト値はfalseです。 -
InteractionId: integer (int64)
タイトル:
Interaction ID
顧客対応参照の一意の識別子。 -
InteractionNumber: string
タイトル:
Interaction Number
最大長:30
顧客対応の代替キー識別子。 -
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
タイトル:
Reference Number
読取り専用:true
最大長:255
顧客対応参照に関連付けられたオブジェクトの代替キー識別子。 -
ObjectTypeCd: string
タイトル:
Object Type
最大長:30
顧客対応参照に存在するオブジェクトのタイプを示すコード。 有効な値のリストは、参照ORA_SVC_IM_REF_OBJECT_TYPE_CDで定義されます。 -
ReferenceId: integer (int64)
タイトル:
Reference ID
読取り専用:true
外部システムとの統合に使用される一意の識別子。 -
UpdateFlag: boolean
読取り専用:
true
顧客対応参照を現在のユーザーが更新できるかどうかを示します。 ユーザーが顧客対応参照を更新するアクセス権を持っている場合、デフォルト値はtrueです。
例:
次の例は、RESTリソースに対してGETリクエストを発行して、すべての相互作用を取得する方法を示しています。
リクエスト・ヘッダーの例
次に、リクエスト・ヘッダーの例を示します。
GET /crmRestApi/resources/11.13.18.05/interactions
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 200: OK Date: Fri, 03 Mar 2017 07:54:53 GMT Server : Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourcecollection+json Content-Language: en
応答本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ "items": [ { "InteractionId": 300100096307925, "ParentInteractionId": 300100096307925, "TopLevelFlag": "true", "Description": "Sent SrMessage 300100096307628", "ChannelId": 300100092273686, "ChannelDisplayName": "ditdevacisvcfib_qa.extservice.incoming", "ChannelTypeCd": "ORA_SVC_EMAIL", "AccountPartyId": null, "AccountPartyUniqueName": null, "ContactPartyId": null, "ContactPartyUniqueName": null, "QueueId": null, "QueueName": null, "OwnerResourceId": null, "OwnerResourcePartyUniqueName": null, "StartTime": "2017-02-20T04:09:17-08:00", "EndTime": "2017-02-20T04:09:17-08:00", "StatusCd": "ORA_SVC_CLOSED", "OriginalSystemReference": null, "CreatedBy": "FUSION_APPS_CRM_ESS_APPID", "CreationDate": "2017-02-20T04:09:17-08:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "LastUpdateDate": "2017-02-20T04:09:17-08:00", "LastUpdateLogin": "48F584F941357435E05307B3F20AB8E8", "DirectionCd": "ORA_SVC_OUTBOUND", "StripeCd": "ORA_SVC_CRM", "MediaItemId": null, "SubstatusCd": null, "NotifyFlag": null, "UpdateFlag": "true", "DeleteFlag": "true", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925", "name": "interactions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925", "name": "interactions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/DirectionCdLookup", "name": "DirectionCdLookup", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/StatusCdLookup", "name": "StatusCdLookup", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/ChannelIdByChannelType", "name": "ChannelIdByChannelType", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions", "name": "childInteractions", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences", "name": "interactionReferences", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/enclosure/Payload", "name": "Payload", "kind": "other" } ] } ... }