解決リクエストの作成
/crmRestApi/resources/11.13.18.05/resolutionRequests
リクエスト
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- application/json
object-
DuplicateParty: array Duplicate Parties
タイトル:
Duplicate Parties重複パーティ・リソースは、解決リクエストで重複パーティを表示および作成するために使用されます。 重複パーティ・リソースには、名前や識別子など、重複パーティの詳細が含まれます。 -
RequestName: string
最大長:
500リクエストの名前。 -
ResolutionDetail: array Resolution Details
タイトル:
Resolution Details解決詳細リソースは、重複レコードの解決後に残存エンティティのマスター・レコードを表示および作成するために使用します。 -
ResolutionType: string
最大長:
30デフォルト値:MERGE解決リクエストのタイプ。
arrayDuplicate PartiesarrayResolution Detailsobject-
MasterFlag: boolean
最大長:
1重複パーティがマスターかどうかを示します。 デフォルト値はfalseです。 -
PartyId(required): integer (int64)
重複パーティの一意の内部識別子。 重複パーティを一意に識別するには、PartyId、PartyNumberまたはSourceSystemキーとSourceSystemReferenceValueキーのいずれかが必要です。
-
PartyNumber(required): string
最大長:
30重複パーティの一意のプライマリ識別子。 -
SourceSystem: string
パーティの元のシステム。
-
SourceSystemReference: array Source System References
タイトル:
Source System Referencesソース・システム参照リソースは、ソース・システム内の重複レコードの一意の識別子を表示するために使用されます。 ソース・システムは、発生した重複レコードのシステムです。 -
SourceSystemReferenceValue: string
このパーティの元のシステム参照。
arraySource System Referencesobjectobject-
EntityId: integer (int64)
レコードに関連付けられた論理ビジネス・エンティティの一意の識別子。
-
EntityNumber: string
エンティティHZ_PARTY_SITESおよびHZ_CUST_ACCOUNTSのレコードの一意の代替識別子。
-
EntityObject: string
最大長:
30レコードに関連付けられた論理ビジネス・エンティティの名前。 -
MasterId: integer
マスター・レコードの一意の識別子。
-
MasterNumber: string
エンティティHZ_PARTY_SITESおよびHZ_CUST_ACCOUNTSのマスター・レコードの一意の代替識別子。
応答
- application/json
デフォルトのレスポンス
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
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重複解決が送信された日付。
arrayDuplicate PartiesarrayResolution Detailsobject-
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
このパーティの元のシステム参照。
arraySource System Referencesobject-
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.
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
object-
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
SourceSystem: string
読取り専用:
true最大長:30外部ソース・システムの名前。 -
SourceSystemReferenceId: integer (int64)
読取り専用:
true外部ソース・システム内の重複パーティの一意の識別子。 -
SourceSystemReferenceValue: string
読取り専用:
true最大長:255重複パーティがインポートされた外部ソース・システムの名前。
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親オブジェクトの名前。
- DuplicateParty
-
パラメータ:
- RequestId:
$request.path.RequestId
重複パーティ・リソースは、解決リクエストで重複パーティを表示および作成するために使用されます。 重複パーティ・リソースには、名前や識別子など、重複パーティの詳細が含まれます。 - RequestId:
- ResolutionDetail
-
パラメータ:
- RequestId:
$request.path.RequestId
解決詳細リソースは、重複レコードの解決後に残存エンティティのマスター・レコードを表示および作成するために使用します。 - RequestId:
例:
- パーティ番号の使用
- パーティIDの使用およびマスター・レコードの指定
- ソース・システム参照の使用
ノート:
解決リクエストを作成すると、Oracle Fusionデータ品質システムによって処理される重複解決作業アイテムも作成されます。次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、解決リクエストを作成する方法を示しています。
パーティ番号の使用
cURLコマンド
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"RequestName": "API Merge Request 001",
"ResolutionType": "MERGE",
"DuplicateParty": [
{"PartyNumber": "CDRM_3102" },
{"PartyNumber": "CDRM_3109" }
]
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"RequestId" : 300100177252448,
"RequestNumber" : "300100177252448",
"RequestName" : "API Merge Request 001",
"ResolutionStatus" : "PENDING",
"ResolutionStatusMessage" : null,
"ResolutionType" : "MERGE",
"CreationDate" : "2019-05-02T09:14:10+00:00",
"CreatedBy" : "MDM_ADMIN_V1",
"LastUpdateDate" : "2019-05-02T09:14:10.321+00:00",
"LastUpdatedBy" : "MDM_ADMIN_V1",
"DuplicateParty" : [ {
"PartyId" : 300100011634984,
"PartyType" : "ORGANIZATION",
"PartyNumber" : "CDRM_3102",
"PartyName" : "QuickCustomer82820121231262637129",
"MasterFlag" : true,
"SourceSystem" : null,
"SourceSystemReferenceValue" : null,
"links" :
}, {
"PartyId" : 300100011635048,
"PartyType" : "ORGANIZATION",
"PartyNumber" : "CDRM_3109",
"PartyName" : "QuickCustomer82820121231262637129_01",
"MasterFlag" : false,
"SourceSystem" : null,
"SourceSystemReferenceValue" : null,
"links" : ...
} ],
"links" : ...
}
パーティIDの使用およびマスター・レコードの指定
cURLコマンド
curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"RequestName": "API Merge Request 002",
"ResolutionType": "MERGE",
"DuplicateParty": [
{"PartyId": "300100011634984", "MasterFlag":true },
{"PartyId": "300100011635048", "MasterFlag":false }
]
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"RequestId" : 300100177252459,
"RequestNumber" : "300100177252459",
"RequestName" : "API Merge Request 002",
"ResolutionStatus" : "PENDING",
"ResolutionStatusMessage" : null,
"ResolutionType" : "MERGE",
"CreationDate" : "2019-05-02T09:19:20+00:00",
"CreatedBy" : "MDM_ADMIN_V1",
"LastUpdateDate" : "2019-05-02T09:19:20.050+00:00",
"LastUpdatedBy" : "MDM_ADMIN_V1",
"DuplicateParty" : [ {
"PartyId" : 300100011634984,
"PartyType" : "ORGANIZATION",
"PartyNumber" : "CDRM_3102",
"PartyName" : "QuickCustomer82820121231262637129",
"MasterFlag" : true,
"SourceSystem" : null,
"SourceSystemReferenceValue" : null,
"links" :
}, {
"PartyId" : 300100011635048,
"PartyType" : "ORGANIZATION",
"PartyNumber" : "CDRM_3109",
"PartyName" : "QuickCustomer82820121231262637129_01",
"MasterFlag" : false,
"SourceSystem" : null,
"SourceSystemReferenceValue" : null,
"links" : ...
} ],
"links" : ...
}
ソース・システム参照の使用
cURLコマンド
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"RequestName": "API Merge Request 003",
"ResolutionType": "MERGE",
"DuplicateParty": [
{"SourceSystem": "Vision", "SourceSystemReferenceValue": "432432" },
{ "SourceSystem": "Vision", "SourceSystemReferenceValue": "321321" }
]
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"RequestId" : 300100177252470,
"RequestNumber" : "300100177252470",
"RequestName" : "API Merge Request 002",
"ResolutionStatus" : "PENDING",
"ResolutionStatusMessage" : null,
"ResolutionType" : "MERGE",
"CreationDate" : "2019-05-02T09:19:20+00:00",
"CreatedBy" : "MDM_ADMIN_V1",
"LastUpdateDate" : "2019-05-02T09:19:20.050+00:00",
"LastUpdatedBy" : "MDM_ADMIN_V1",
"DuplicateParty" : [ {
"PartyId" : 300100011634984,
"PartyType" : "ORGANIZATION",
"PartyNumber" : "CDRM_3102",
"PartyName" : "QuickCustomer82820121231262637129",
"MasterFlag" : true,
"SourceSystem" : "Vision",
"SourceSystemReferenceValue" : "432432",
"links" :
}, {
"PartyId" : 300100011635048,
"PartyType" : "ORGANIZATION",
"PartyNumber" : "CDRM_3109",
"PartyName" : "QuickCustomer82820121231262637129_01",
"MasterFlag" : false,
"SourceSystem" : "Vision",
"SourceSystemReferenceValue" : "321321",
"links" :
} ],
"links" :
}