機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

重複パーティの作成

post

/crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty

リクエスト

パス・パラメータ

• RequestId(required): integer(int64)
  解決リクエストの一意の識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• 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
  このパーティの元のシステム参照。

{
    "required":[
        "PartyId",
        "PartyNumber"
    ],
    "type":"object",
    "properties":{
        "PartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique primary identifier for the duplicate party.",
            "nullable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique internal identifier of a duplicate party. Either the PartyId, PartyNumber, or SourceSystem and SourceSystemReferenceValue keys is required to uniquely identify the duplicate party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceSystemReference":{
            "title":"Source System References",
            "type":"array",
            "description":"The source system references resource is used to view the unique identifier of the duplicate record in the source system. Source system is the system from the duplicate record originated.",
            "items":{
                "$ref":"#/components/schemas/resolutionRequests-DuplicateParty-SourceSystemReference-item-post-request"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The original system of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "MasterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the duplicate party is master. The default value is false.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The original system reference of this party.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : ソース・システム参照

タイプ: array

タイトル: Source System References

ソース・システム参照リソースは、ソース・システム内の重複レコードの一意の識別子を表示するために使用されます。 ソース・システムは、発生した重複レコードのシステムです。

ソースを表示

• Array of: object resolutionRequests-DuplicateParty-SourceSystemReference-item-post-request

{
    "title":"Source System References",
    "type":"array",
    "description":"The source system references resource is used to view the unique identifier of the duplicate record in the source system. Source system is the system from the duplicate record originated.",
    "items":{
        "$ref":"#/components/schemas/resolutionRequests-DuplicateParty-SourceSystemReference-item-post-request"
    }
}

ネストされたスキーマ : resolutionRequests-DuplicateParty-SourceSystemReference-item-post-request

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : 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
  このパーティの元のシステム参照。

{
    "type":"object",
    "properties":{
        "PartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique primary identifier for the duplicate party.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique internal identifier of a duplicate party. Either the PartyId, PartyNumber, or SourceSystem and SourceSystemReferenceValue keys is required to uniquely identify the duplicate party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystemReference":{
            "title":"Source System References",
            "type":"array",
            "description":"The source system references resource is used to view the unique identifier of the duplicate record in the source system. Source system is the system from the duplicate record originated.",
            "items":{
                "$ref":"#/components/schemas/resolutionRequests-DuplicateParty-SourceSystemReference-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyName":{
            "type":"string",
            "description":"The name of the duplicate party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The original system of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyType":{
            "type":"string",
            "description":"The type of the duplicate party, such as ORGANIZATION or PERSON.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the duplicate party is master. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The original system reference of this party.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : ソース・システム参照

タイプ: array

タイトル: Source System References

ソース・システム参照リソースは、ソース・システム内の重複レコードの一意の識別子を表示するために使用されます。 ソース・システムは、発生した重複レコードのシステムです。

ソースを表示

• Array of: object resolutionRequests-DuplicateParty-SourceSystemReference-item-response

{
    "title":"Source System References",
    "type":"array",
    "description":"The source system references resource is used to view the unique identifier of the duplicate record in the source system. Source system is the system from the duplicate record originated.",
    "items":{
        "$ref":"#/components/schemas/resolutionRequests-DuplicateParty-SourceSystemReference-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : resolutionRequests-DuplicateParty-SourceSystemReference-item-response

タイプ: object

ソースを表示

• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• SourceSystem: string
  読取り専用: true

  最大長: 30

  外部ソース・システムの名前。
• SourceSystemReferenceId: integer (int64)
  読取り専用: true

  外部ソース・システム内の重複パーティの一意の識別子。
• SourceSystemReferenceValue: string
  読取り専用: true

  最大長: 255

  重複パーティがインポートされた外部ソース・システムの名前。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceSystemReferenceId":{
            "type":"integer",
            "description":"The unique identifier of the duplicate party in the external source system.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The name of external source system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the external source system from where the duplicate party was imported.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

SourceSystemReference

操作: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty/{DuplicatePartyUniqID}/child/SourceSystemReference

パラメータ:

• DuplicatePartyUniqID: $request.path.DuplicatePartyUniqID
• RequestId: $request.path.RequestId

パーティのオリジナル・システム参照。

トップに戻る

例:

解決リクエストを作成すると、重複パーティが作成されます。 詳細は、「解決リクエストの作成」メソッドの例の項を参照してください。

「トップに戻る」