Create a link party
post
/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty
Request
Path Parameters
-
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:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
LinkType: string
Maximum Length:
30
The type of the link such as B2FLink, or DQ Link. -
MainLink: string
Maximum Length:
1
Indicates the link direction. The valid values are Y and N. -
PartyId: integer
(int64)
The unique identifier of the party associated to the linked party.
-
PartyNumber: string
Maximum Length:
30
The party number 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.
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.
Root Schema : hubOrganizations-LinkedParty-item-response
Type:
Show Source
object
-
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 such as B2FLink, or DQ Link. -
MainLink: string
Maximum Length:
1
Indicates the link direction. The valid values are Y and N. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- MainLinkLOV
-
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
- finder: