すべてのサービス・リクエスト・インタラクションの取得
get
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences
リクエスト
パス・パラメータ
- SrId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey :指定した主キーとサービス・リクエストの相互作用を検索します。
ファインダ変数:- ReferenceId :顧客対応参照の一意の識別子。
- PrimaryKey :指定した主キーとサービス・リクエストの相互作用を検索します。
- 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; 顧客対応に関連付けられているアカウントの一意の識別子。
- AccountPartyUniqueName; string;顧客対応に関連付けられているアカウント名。
- ChannelDisplayName; string;インタラクションで移入されるチャネルの表示名。
- ChannelId; integer;インタラクション・チャネルの一意の識別子。
- ChannelTypeCd; string; インタラクションのチャネル・タイプ。
- ContactPartyId; integer; エージェントが対話している担当者の一意の識別子。
- ContactPartyUniqueName; string;顧客対応の顧客担当者の名前。
- CreatedBy; string;顧客対応を作成したユーザー。
- CreationDate; string;顧客対応が作成された日時。
- 説明;文字列;顧客対応の説明。
- DirectionCd; string;対話の方向。
- EndTime; string; 相互作用が終了した時間。
- InteractionId; integer;相互作用の一意の識別子。
- LastUpdateDate; string;顧客対応が最後に更新された日時。
- LastUpdateLogin; string;顧客対応を最後に更新したユーザーのログイン。
- LastUpdatedBy; string;顧客対応を最後に更新したユーザー。
- OriginalSystemReference; string;顧客対応の元のシステム参照。
- OwnerResourceId; integer; インタラクションを所有するエージェントの一意の識別子。
- OwnerResourcePartyUniqueName; string; サービス・エージェントなどの内部顧客対応所有者であるリソース。顧客対応に関連付けられます。
- ParentInteractionId; integer;親顧客対応の一意の識別子。
- QueueId; integer;相互作用キューの一意の識別子。
- QueueName; string;インタラクション内のキューの名前。
- ReferenceId; integer;参照関係の一意の識別子。
- StartTime; string;インタラクションの開始時間。
- StatusCd; string;顧客対応ステータス。
- StripeCd; string;インタラクションのアプリケーション・ストライプ。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : internalServiceRequests-srInteractionReferences
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : internalServiceRequests-srInteractionReferences-item-response
タイプ:
ソースを表示
object
-
AccountPartyId: integer (int64)
タイトル:
Account ID
読取り専用:true
顧客対応に関連付けられたアカウントの一意の識別子。 -
AccountPartyUniqueName: string
タイトル:
Account
読取り専用:true
最大長:900
顧客対応に関連付けられているアカウント名。 -
ChannelDisplayName: string
タイトル:
Display Name
読取り専用:true
最大長:400
顧客対応に移入されたチャネルの表示名。 -
ChannelId: integer (int64)
タイトル:
Channel ID
読取り専用:true
インタラクション・チャネルの一意の識別子。 -
ChannelTypeCd: string
タイトル:
Channel Type
読取り専用:true
最大長:30
顧客対応のチャネル・タイプ。 -
ContactPartyId: integer (int64)
タイトル:
Contact ID
読取り専用:true
エージェントがやりとりしている担当者の一意の識別子。 -
ContactPartyUniqueName: string
タイトル:
Contact
読取り専用:true
最大長:900
顧客対応の顧客担当者の名前。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
顧客対応を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
顧客対応が作成された日時。 -
DeleteFlag: boolean
タイトル:
Can Delete
読取り専用:true
レコードを削除できるかどうかを示します。 -
Description: string
タイトル:
Description
読取り専用:true
最大長:1000
顧客対応の摘要。 -
DirectionCd: string
タイトル:
Direction
読取り専用:true
最大長:30
デフォルト値:ORA_SVC_INBOUND
顧客対応の方向。 -
EndTime: string (date-time)
タイトル:
End Time
読取り専用:true
顧客対応が終了した時間。 -
InteractionId: integer (int64)
タイトル:
Interaction ID
読取り専用: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 System
読取り専用:true
最大長:255
顧客対応の元のシステム参照。 -
OwnerResourceId: integer (int64)
タイトル:
Owner Resource ID
読取り専用:true
顧客対応を所有するエージェントの一意の識別子。 -
OwnerResourcePartyUniqueName: string
タイトル:
Resource Name
読取り専用:true
最大長:900
顧客対応に関連付けられたサービス・エージェントなどの内部顧客対応所有者であるリソース。 -
ParentInteractionId: integer (int64)
タイトル:
Parent Interaction ID
読取り専用:true
親顧客対応の一意の識別子。 -
ペイロード: 文字列(バイト)
タイトル:
Payload
読取り専用:true
顧客対応のペイロード。 -
QueueId: integer (int64)
タイトル:
Queue ID
読取り専用:true
インタラクション・キューの一意の識別子。 -
QueueName: string
タイトル:
Name
読取り専用:true
最大長:400
インタラクション内のキューの名前。 -
ReferenceId: integer (int64)
タイトル:
Reference ID
読取り専用:true
参照関係の一意の識別子。 -
StartTime: string (date-time)
タイトル:
Start Time
読取り専用:true
顧客対応の開始時間。 -
StatusCd: string
タイトル:
Status
読取り専用:true
最大長:30
デフォルト値:ORA_SVC_OPEN
顧客対応ステータス。 -
StripeCd: string
タイトル:
Stripe Code
読取り専用:true
最大長:30
インタラクションのアプリケーション・ストライプ。 -
TopLevelFlag: boolean
タイトル:
Top Level
読取り専用:true
顧客対応が最上位レベルの顧客対応かどうかを示します。 -
UpdateFlag: boolean
タイトル:
Can Update
読取り専用: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値を変更します。