Jump to

• Request
• Response

Update a non-duplicate record

patch

/crmRestApi/resources/11.13.18.05/nonDuplicates/{NonDuplicateId}

Request

Path Parameters

• NonDuplicateId(required): integer(int64)
  The unique identifier of the non-duplicate record.

Header Parameters

• Metadata-Context: string
  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: string
  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

• EndDate: string (date)
  The date when the exclusion ends.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "type":"string",
            "description":"The date when the exclusion ends.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : nonDuplicates-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has created the non-duplicate record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the non-duplicate record was created.
• EndDate: string (date)
  The date when the exclusion ends.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the non-duplicate record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the non-duplicate record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MasterPartyId: integer (int64)
  The unique identifier of the master party associated with the non-duplicate record.
• MasterPartyName: string
  Read Only: true

  The name of the master party associated with the non-duplicate record.
• MasterPartyNumber: string
  The alternate key identifier of the master party associated with the non-duplicate record.
• NonDuplicateId: integer (int64)
  Read Only: true

  The unique identifier of the non-duplicate record.
• NonDuplicatePartyId: integer (int64)
  The unique identifier of the party associated with the non-duplicate record.
• NonDuplicatePartyName: string
  Read Only: true

  The name of the party associated with the non-duplicate record.
• NonDuplicatePartyNumber: string
  The alternate key identifier of the party associated with the non-duplicate record.
• PartyType: string
  Read Only: true

  The type of the non-duplicate and master parties.
• StartDate: string (date)
  The date when the exclusion starts.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has created the non-duplicate record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the non-duplicate record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the exclusion ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the non-duplicate record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the non-duplicate record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterPartyId":{
            "type":"integer",
            "description":"The unique identifier of the master party associated with the non-duplicate record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MasterPartyName":{
            "type":"string",
            "description":"The name of the master party associated with the non-duplicate record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterPartyNumber":{
            "type":"string",
            "description":"The alternate key identifier of the master party associated with the non-duplicate record.",
            "nullable":true,
            "x-queryable":true
        },
        "NonDuplicateId":{
            "type":"integer",
            "description":"The unique identifier of the non-duplicate record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NonDuplicatePartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with the non-duplicate record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NonDuplicatePartyName":{
            "type":"string",
            "description":"The name of the party associated with the non-duplicate record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NonDuplicatePartyNumber":{
            "type":"string",
            "description":"The alternate key identifier of the party associated with the non-duplicate record.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyType":{
            "type":"string",
            "description":"The type of the non-duplicate and master parties.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the exclusion starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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."
        }
    }
}

Back to Top