Jump to

• Request
• Response

Update a linked party

patch

/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty/{LinkedPartyUniqID}

Request

Path Parameters

• LinkedPartyUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Linked Parties resource and used to uniquely identify an instance of Linked Parties. The client should not generate the hash key value. Instead, the client should query on the Linked Parties collection resource in order to navigate to a specific instance of Linked Parties to get the hash key.
• PartyNumber(required): string
  The unique alternate identifier for the organization party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.

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

{
    "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 : hubOrganizations-LinkedParty-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the linked party.
• CreationDate: string (date-time)
  Read Only: true

  The date when the linked party was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the linked party was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the linked party.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the linked party.
• LinkId: integer (int64)
  Read Only: true

  The unique identifier for the linked party.
• LinkNumber: string
  Read Only: true

  Maximum Length: 64

  The link number of the linked party.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LinkType: string
  Maximum Length: 30

  The type of the link between this party and the linked party.
• MainLink: string
  Maximum Length: 1

  Indicates the link direction. The valid values are Y and N.
• ObjectCode: string
  Read Only: true

  Maximum Length: 30

  The subtype of the linked party, such as Customer or Partner.
• PartyId: integer (int64)
  The unique identifier of the party associated to the linked party.
• PartyName: string
  Read Only: true

  Maximum Length: 360

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

  The party number of the linked party.
• PartyType: string
  Read Only: true

  Maximum Length: 30

  The party type of the linked party.
• RelatedPartyId: integer (int64)
  The unique identifier of the parent party associated to the linked party.
• RelatedPartyNumber: string
  Maximum Length: 30

  The party number of the parent party.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the linked party was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the linked party was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"The unique identifier for the linked party.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LinkNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The link number of the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the link between this party and the linked party.",
            "nullable":false,
            "x-queryable":true
        },
        "MainLink":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the link direction. The valid values are Y and N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The subtype of the linked party, such as Customer or Partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated to the linked party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"The party name of the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The party number of the linked party.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyType":{
            "maxLength":30,
            "type":"string",
            "description":"The party type of the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelatedPartyId":{
            "type":"integer",
            "description":"The unique identifier of the parent party associated to the linked party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedPartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The party number of the parent party.",
            "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."
        }
    }
}

Links

MainLinkLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: MainLink; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top