Update a relationship
patch
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Request
Path Parameters
-
PartyNumber(required): string
The unique alternate identifier for the account 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.
-
RelationshipRecId(required): integer(int64)
The unique identifier of the relationship record.
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
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
DependentFlag: string
Title:
Dependent Indicator
Maximum Length:1
Default Value:N
Indicates whether one party is a dependent on another. -
EndDate: string
(date)
Title:
To Date
The date when the relationship ends. -
HeadOfHouseholdFlag: string
Title:
Head of Household Indicator
Maximum Length:1
Default Value:N
Indicates whether a person is the head of the household that he belongs to. -
InfluenceLevel: string
Title:
Influence Level
The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None. -
JobDefinitionName: string
Maximum Length:
100
The definition of the job name. -
JobDefinitionPackage: string
Maximum Length:
900
The definition of the job package. -
ObjectPartyId: integer
(int64)
The unique identifier of the object party in this relationship.
-
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The alternate key identifier for the object party of the relationship. -
ObjectSourceSystem: string
Title:
Object Source System
The name of the external source system for the object party in the relationship. -
ObjectSourceSystemReferenceValue: string
Title:
Object Source System Reference
The identifier for the object party in the relationship from the external source system. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PercentageOwnership: number
Title:
Ownership Percentage
The percentage of the child entity owned by the parent entity. -
PreferredContactFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PrimaryCustomerFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
RelationshipSourceSystem: string
The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
-
RelationshipSourceSystemReferenceValue: string
The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
-
RequestId: integer
(int64)
The unique identifier of the request.
-
SubjectPartyId: integer
(int64)
The unique identifier of the subject party in this relationship.
-
SubjectPartyNumber: string
Title:
Subject Registry ID
Maximum Length:30
The alternate key identifier for the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of the external source system for the subject party in the relationship. -
SubjectSourceSystemReferenceValue: string
Title:
Subject Source System Reference
The identifier for the subject party in the relationship from the external source system.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : accounts-Relationship-item-response
Type:
Show Source
object
-
BackwardRole: string
Title:
Backward Role
Read Only:true
The backward relationship code used to describe relationships. For example, SUPPLIER_OF. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the relationship record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DependentFlag: string
Title:
Dependent Indicator
Maximum Length:1
Default Value:N
Indicates whether one party is a dependent on another. -
DirectionCode: string
Read Only:
true
Maximum Length:30
The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional. -
EndDate: string
(date)
Title:
To Date
The date when the relationship ends. -
HeadOfHouseholdFlag: string
Title:
Head of Household Indicator
Maximum Length:1
Default Value:N
Indicates whether a person is the head of the household that he belongs to. -
InfluenceLevel: string
Title:
Influence Level
The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None. -
JobDefinitionName: string
Maximum Length:
100
The definition of the job name. -
JobDefinitionPackage: string
Maximum Length:
900
The definition of the job package. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectPartyId: integer
(int64)
The unique identifier of the object party in this relationship.
-
ObjectPartyName: string
Title:
Object Party Name
Read Only:true
Maximum Length:360
The name of the object party of the relationship. -
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The alternate key identifier for the object party of the relationship. -
ObjectSourceSystem: string
Title:
Object Source System
The name of the external source system for the object party in the relationship. -
ObjectSourceSystemReferenceValue: string
Title:
Object Source System Reference
The identifier for the object party in the relationship from the external source system. -
ObjectTableName: string
Maximum Length:
30
The source table name of the object party in this relationship. -
ObjectType: string
Maximum Length:
30
The object type of the contact. -
ObjectUsageCode: string
Maximum Length:
30
The usage code of object party in the relationship. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumber1: integer
(int32)
Read Only:
true
The attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried. -
ObjectVersionNumber2: integer
(int32)
Read Only:
true
The number to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of the party. -
PartyId1: integer
(int64)
Read Only:
true
The alternate unique identifier of the party. -
PercentageOwnership: number
Title:
Ownership Percentage
The percentage of the child entity owned by the parent entity. -
PreferredContactFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PrimaryCustomerFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
RelationshipCode: string
Title:
Relationship Code
Maximum Length:30
The code of the relationship that specifies if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. -
RelationshipId: integer
(int64)
Read Only:
true
The unique identifier of the relationship. -
RelationshipRecId: integer
(int64)
The unique identifier of the relationship record.
-
RelationshipSourceSystem: string
The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
-
RelationshipSourceSystemReferenceValue: string
The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The relationship type such as CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. -
RequestId: integer
(int64)
The unique identifier of the request.
-
Role: string
Title:
Role
The role between the subject and object party. -
SSROwnerTableName: string
Read Only:
true
Maximum Length:255
Default Value:HZ_PARTIES
The name of the table that holds the record data and is referenced to manage source system reference. -
StartDate: string
(date)
Title:
From Date
The date when the relationship was created. -
Status: string
Read Only:
true
Maximum Length:1
Default Value:A
Indicates if the relationship is active or inactive, such as A for active and I for inactive. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SubjectPartyId: integer
(int64)
The unique identifier of the subject party in this relationship.
-
SubjectPartyName: string
Title:
Subject Party Name
Read Only:true
Maximum Length:360
The name of the subject party. -
SubjectPartyNumber: string
Title:
Subject Registry ID
Maximum Length:30
The alternate key identifier for the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of the external source system for the subject party in the relationship. -
SubjectSourceSystemReferenceValue: string
Title:
Subject Source System Reference
The identifier for the subject party in the relationship from the external source system. -
SubjectTableName: string
Maximum Length:
30
The source table of the subject. -
SubjectType: string
Maximum Length:
30
The subject type of the contact. -
SubjectUsageCode: string
Maximum Length:
30
The usage code of subject party in the contact.
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
- BackwardRoleLOV
-
Parameters:
- finder:
RoleForSubjectObjectFinder%3BbindObjectType%3D{SubjectType}%2CbindSubjectType%3D{ObjectType}
The following properties are defined on the LOV link relation:- Source Attribute: BackwardRole; Target Attribute: Role
- Display Attribute: Description
- finder:
- InfluenceLevelLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_INFLUENCE_LVL_CD
The list of values indicating the influence level of the object party in the relationship.
The following properties are defined on the LOV link relation:- Source Attribute: InfluenceLevel; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- RelationshipCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DPARTY_RELATIONS_TYPE
The list of values indicating the phrase used to describe the relationship, such as Associate of and Affiliate of.
The following properties are defined on the LOV link relation:- Source Attribute: RelationshipCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RelationshipTypeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_RELATIONSHIP_TYPE
The list of values indicating the type of the relationship, such as Associate or Competitor.
The following properties are defined on the LOV link relation:- Source Attribute: RelationshipType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RoleLOV
-
Parameters:
- finder:
RoleForSubjectObjectFinder%3BbindObjectType%3D{ObjectType}%2CbindSubjectType%3D{SubjectType}
The list of values indicating the role between the subject and object party in the relationship.
The following properties are defined on the LOV link relation:- Source Attribute: Role; Target Attribute: Role
- Display Attribute: Description
- finder: