すべての解決リクエストの取得
get
/crmRestApi/resources/11.13.18.05/resolutionRequests
リクエスト
問合せパラメータ
- 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 : 指定されたRequestIdの解決リクエストを検索します。
ファインダ変数:- RequestId; integer; 解決リクエストの一意の識別子。
- RequestByNumber : 指定されたリクエスト番号の解決リクエストを検索します。
ファインダ変数:
- PrimaryKey : 指定されたRequestIdの解決リクエストを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AssignedTo; string; リクエストが割り当てられるユーザーの名前。
- AssignedToId; string; リクエストが割り当てられるユーザーの一意の識別子。
- CreatedBy; string; リクエストを作成したユーザー。
- CreationDate; string; リクエストが作成された日付。
- HasBeenReviewedFlag; boolean;リクエストがデータ・ワードによってレビューされたかどうかを示します。
- LastUpdateDate; string; リクエストが最後に更新された日付。
- LastUpdatedBy; string; リクエストを最後に更新したユーザー。
- RequestId; integer; 解決リクエストの一意の識別子。
- RequestName; string;リクエストの名前。
- RequestNumber; string;解決要求の代替キー識別子。
- RequestedBy; string;重複解決を要求したユーザーの名前。
- RequestedById; string; 重複解決を要求したユーザーの一意の識別子。
- ResolutionStatus; string;リクエストのステータス。
- ResolutionStatusMessage; string; 解決ステータスがERRORまたはREJECTの場合の解決ステータスの理由。
- ResolutionType; string;解決リクエストのタイプ。
- ReviewRequiredFlag; boolean;リクエストをデータ・ワードでレビューする必要があるかどうかを示します。
- RuleBasedMasterFlag; boolean;マスター・レコードがルールで設定されたかどうかを示します。
- SubmittedBy; string; 完了のためにリクエストを送信したユーザーの名前。
- SubmittedById; string; 完了のためにリクエストを送信したユーザーの一意の識別子。
- SubmittedDate; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : resolutionRequests
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : resolutionRequests-item-response
タイプ:
ソースを表示
object
-
AssignedTo: string
読取り専用:
true
最大長:255
リクエストの割当先ユーザーの名前。 -
AssignedToId: string
読取り専用:
true
最大長:64
リクエストが割り当てられているユーザーの一意の識別子。 -
CreatedBy: string
読取り専用:
true
最大長:64
リクエストを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
リクエストが作成された日付。 -
DuplicateParty: array Duplicate Parties
タイトル:
Duplicate Parties
重複パーティ・リソースは、解決リクエストで重複パーティを表示および作成するために使用されます。 重複パーティ・リソースには、名前や識別子など、重複パーティの詳細が含まれます。 -
HasBeenReviewedFlag: boolean
読取り専用:
true
最大長:1
リクエストがデータ・ワードによってレビューされたかどうかを示します。 -
LastUpdateDate: string (date-time)
読取り専用:
true
リクエストが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
リクエストを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
RequestedBy: string
読取り専用:
true
最大長:255
重複解決をリクエストしたユーザーの名前。 -
RequestedById: string
読取り専用:
true
最大長:255
重複解決をリクエストしたユーザーの一意の識別子。 -
RequestId: integer (int64)
読取り専用:
true
解決リクエストの一意の識別子。 -
RequestName: string
最大長:
500
リクエストの名前。 -
RequestNumber: string
読取り専用:
true
最大長:64
解決リクエストの代替キー識別子。 -
ResolutionDetail: array Resolution Details
タイトル:
Resolution Details
解決詳細リソースは、重複レコードの解決後に残存エンティティのマスター・レコードを表示および作成するために使用します。 -
ResolutionStatus: string
読取り専用:
true
最大長:30
リクエストのステータス。 -
ResolutionStatusMessage: string
読取り専用:
true
最大長:255
解決ステータスがERRORまたはREJECTの場合の解決ステータスの事由。 -
ResolutionType: string
最大長:
30
デフォルト値:MERGE
解決リクエストのタイプ。 -
ReviewRequiredFlag: boolean
読取り専用:
true
最大長:1
データ・ワードによるリクエストのレビューが必要かどうかを示します。 -
RuleBasedMasterFlag: boolean
読取り専用:
true
最大長:1
マスター・レコードがルールで設定されたかどうかを示します。 -
SubmittedBy: string
読取り専用:
true
最大長:255
完了のためにリクエストを送信したユーザーの名前。 -
SubmittedById: string
読取り専用:
true
最大長:255
完了のリクエストを送信したユーザーの一意の識別子。 -
SubmittedDate: string (date-time)
読取り専用:
true
重複解決が送信された日付。
ネストされたスキーマ : 重複パーティ
タイプ:
array
タイトル:
Duplicate Parties
重複パーティ・リソースは、解決リクエストで重複パーティを表示および作成するために使用されます。 重複パーティ・リソースには、名前や識別子など、重複パーティの詳細が含まれます。
ソースを表示
ネストされたスキーマ : 解決詳細
タイプ:
array
タイトル:
Resolution Details
解決詳細リソースは、重複レコードの解決後に残存エンティティのマスター・レコードを表示および作成するために使用します。
ソースを表示
ネストされたスキーマ : resolutionRequests-DuplicateParty-item-response
タイプ:
ソースを表示
object
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MasterFlag: boolean
最大長:
1
重複パーティがマスターかどうかを示します。 デフォルト値はfalseです。 -
PartyId: integer (int64)
重複パーティの一意の内部識別子。 重複パーティを一意に識別するには、PartyId、PartyNumberまたはSourceSystemキーとSourceSystemReferenceValueキーのいずれかが必要です。
-
PartyName: string
読取り専用:
true
重複パーティの名前。 -
PartyNumber: string
最大長:
30
重複パーティの一意のプライマリ識別子。 -
PartyType: string
読取り専用:
true
重複パーティのタイプ(ORGANIZATIONやPERSONなど)。 -
SourceSystem: string
パーティの元のシステム。
-
SourceSystemReference: array Source System References
タイトル:
Source System References
ソース・システム参照リソースは、ソース・システム内の重複レコードの一意の識別子を表示するために使用されます。 ソース・システムは、発生した重複レコードのシステムです。 -
SourceSystemReferenceValue: string
このパーティの元のシステム参照。
ネストされたスキーマ : ソース・システム参照
タイプ:
array
タイトル:
Source System References
ソース・システム参照リソースは、ソース・システム内の重複レコードの一意の識別子を表示するために使用されます。 ソース・システムは、発生した重複レコードのシステムです。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : resolutionRequests-DuplicateParty-SourceSystemReference-item-response
タイプ:
ソースを表示
object
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SourceSystem: string
読取り専用:
true
最大長:30
外部ソース・システムの名前。 -
SourceSystemReferenceId: integer (int64)
読取り専用:
true
外部ソース・システム内の重複パーティの一意の識別子。 -
SourceSystemReferenceValue: string
読取り専用:
true
最大長:255
重複パーティがインポートされた外部ソース・システムの名前。
ネストされたスキーマ : resolutionRequests-ResolutionDetail-item-response
タイプ:
ソースを表示
object
-
Action: string
読取り専用:
true
最大長:30
レコードに対して実行される処理(MERGEやRETAINなど)。 -
EntityId: integer (int64)
レコードに関連付けられた論理ビジネス・エンティティの一意の識別子。
-
EntityNumber: string
エンティティHZ_PARTY_SITESおよびHZ_CUST_ACCOUNTSのレコードの一意の代替識別子。
-
EntityObject: string
最大長:
30
レコードに関連付けられた論理ビジネス・エンティティの名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MasterFlag: boolean
読取り専用:
true
最大長:1
重複エンティティがマスターかどうかを示します。 デフォルト値はfalseです。 -
MasterId: integer
マスター・レコードの一意の識別子。
-
MasterNumber: string
エンティティHZ_PARTY_SITESおよびHZ_CUST_ACCOUNTSのマスター・レコードの一意の代替識別子。
-
ParentId: integer (int64)
読取り専用:
true
親レコードの一意の識別子。 -
ParentMasterId: integer (int64)
読取り専用:
true
親レコードに関連付けられているマスター・レコードの一意の識別子。 -
ParentObject: string
読取り専用:
true
最大長:255
親オブジェクトの名前。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべての解決リクエストを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "RequestId": 300100007080506, "RequestNumber": "300100007080506", "RequestName": "Merge_32478846201244841417465", "ResolutionStatus": "COMPLETED", "ResolutionStatusMessage": null, "ResolutionType": "MERGE", "CreationDate": "2012-04-06T04:48:51+00:00", "CreatedBy": "DATA_STEWARD_MGR", "LastUpdateDate": "2012-04-06T05:26:18.606+00:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "links": }, { "RequestId": 300100007012081, "RequestNumber": "300100007012081", "RequestName": "M_32486546201253856562715", "ResolutionStatus": "NEW", "ResolutionStatusMessage": null, "ResolutionType": "MERGE", "CreationDate": "2012-04-06T05:39:04+00:00", "CreatedBy": "DATA_STEWARD_MGR", "LastUpdateDate": "2012-04-06T05:45:55.869+00:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "links": }, ...