Jump to

• Request
• Response
• Examples

Create a duplicate party

post

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

Request

Path Parameters

• RequestId(required): integer(int64)
  The unique identifier of the resolution request.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• MasterFlag: boolean
  Maximum Length: 1

  Indicates if the duplicate party is master. The default value is false.
• PartyId(required): integer (int64)
  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.
• PartyNumber(required): string
  Maximum Length: 30

  The unique primary identifier for the duplicate party.
• SourceSystem: string
  The original system of the party.
• SourceSystemReference: array Source System References
  Title: Source System References

  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.
• SourceSystemReferenceValue: string
  The original system reference of this party.

{
    "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
        }
    }
}

Nested Schema : Source System References

Type: array

Title: Source System References

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.

Show Source

• 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"
    }
}

Nested Schema : resolutionRequests-DuplicateParty-SourceSystemReference-item-post-request

Type: object

Show Source

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : resolutionRequests-DuplicateParty-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MasterFlag: boolean
  Maximum Length: 1

  Indicates if the duplicate party is master. The default value is false.
• PartyId: integer (int64)
  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.
• PartyName: string
  Read Only: true

  The name of the duplicate party.
• PartyNumber: string
  Maximum Length: 30

  The unique primary identifier for the duplicate party.
• PartyType: string
  Read Only: true

  The type of the duplicate party, such as ORGANIZATION or PERSON.
• SourceSystem: string
  The original system of the party.
• SourceSystemReference: array Source System References
  Title: Source System References

  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.
• SourceSystemReferenceValue: string
  The original system reference of this party.

{
    "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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Source System References

Type: array

Title: Source System References

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.

Show Source

• 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"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Nested Schema : resolutionRequests-DuplicateParty-SourceSystemReference-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceSystem: string
  Read Only: true

  Maximum Length: 30

  The name of external source system.
• SourceSystemReferenceId: integer (int64)
  Read Only: true

  The unique identifier of the duplicate party in the external source system.
• SourceSystemReferenceValue: string
  Read Only: true

  Maximum Length: 255

  The name of the external source system from where the duplicate party was imported.

{
    "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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

SourceSystemReference

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

Parameters:

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

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.

Back to Top

Examples

A Duplicate Party is created when you create a Resolution Request. For more information, see the example section of the Create a Resolution Request method.

Back to Top