Get all relationships
get
/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship
Request
Path Parameters
-
PartyNumber(required): string
The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a relationship with the specified primary key.
Finder Variables:- RelationshipRecId; integer; The unique identifier of the relationship.
- Relationship2AltKey: Finds a relationship with the specified parameters.
Finder Variables:- ObjectPartyId; integer; The identifier of the object in this relationship.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectPartyNumber; string; The unique identification number for the subject party of the relationship.
- Relationship3AltKey: Finds a relationship with the specified parameters.
Finder Variables:- ObjectPartyId; integer; The identifier of the object in this relationship.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectSourceSystem; string; The name of external source system for the subject party in the relationship.
- SubjectSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from external source system.
- Relationship4AltKey: Finds a relationship with the specified parameters.
Finder Variables:- ObjectPartyNumber; string; The unique identification number for the object party of the relationship.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectPartyId; integer; The identifier for a subject in the relationship.
- Relationship5AltKey: Finds a relationship with
specified parameters.
Finder Variables:- ObjectPartyNumber; string; The unique identification number for the object party of the relationship.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectPartyNumber; string; The unique identification number for the subject party of the relationship.
- Relationship6AltKey: Finds a relationship with the specified parameters.
Finder Variables:- ObjectPartyNumber; string; The unique identification number for the object party of the relationship.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectSourceSystem; string; The name of external source system for the subject party in the relationship.
- SubjectSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from external source system.
- Relationship7AltKey: Finds a relationship with the specified parameters.
Finder Variables:- ObjectSourceSystem; string; The name of external source system for the object party in the relationship.
- ObjectSourceSystemReferenceValue; string; The identifier for the object party in the relationship from external source system.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectPartyId; integer; The identifier for a subject in the relationship.
- Relationship8AltKey: Finds a relationship with the specified parameters.
Finder Variables:- ObjectSourceSystem; string; The name of external source system for the object party in the relationship.
- ObjectSourceSystemReferenceValue; string; The identifier for the object party in the relationship from external source system.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectPartyNumber; string; The unique identification number for the subject party of the relationship.
- Relationship9AltKey: Finds a relationship with the specified parameters.
Finder Variables:- ObjectSourceSystem; string; The name of external source system for the object party in the relationship.
- ObjectSourceSystemReferenceValue; string; The identifier for the object party in the relationship from external source system.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectSourceSystem; string; The name of external source system for the subject party in the relationship.
- SubjectSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from external source system.
- RelationshipAltKey: Finds a relationship with the specified parameters.
Finder Variables:- ObjectPartyId; integer; The identifier of the object in this relationship.
- RelationshipCode; string; Indicates whether this is a forward or a backward relationship code.
- RelationshipType; string; The relationship type name.
- SubjectPartyId; integer; The identifier for a subject in the relationship.
- PrimaryKey: Finds a relationship with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BackwardRole; string; The backward relationship code used to describe relationships. For example, SUPPLIER_OF.
- Comments; string; The comments provided by the user.
- ConflictId; integer; The unique identifier of the conflict for the relationship record. This number is used by mobile or portable applications that consume the web service.
- CreatedBy; string; The user who created the record.
- CreatedByModule; string; 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; The date and time when the record was created.
- DependentFlag; string; Indicates whether one party is dependent on another. Default value is N.
- DirectionCode; string; The code of the relationship direction. The list of accepted values are defined in the lookup DIRECTION_CODE. Valid values are P-Parent, C-Child, N-Not Directional.
- EndDate; string; The date when the relationship ends.
- HeadOfHouseholdFlag; string; Indicates whether a person is the head of the household that he belongs to. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation.
- InfluenceLevel; string; The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.
- JobDefinitionName; string; The definition of the job name.
- JobDefinitionPackage; string; The definition of the job package.
- LastUpdateDate; string; The date and time when the record was last updated.
- LastUpdateLogin; string; The login details of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- ObjectPartyId; integer; The unique identifier of the object in this relationship.
- ObjectPartyName; string; The name of the object party.
- ObjectPartyNumber; string; The alternate key identifier of the object party of the relationship.
- ObjectSourceSystem; string; The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup.
- ObjectSourceSystemReferenceValue; string; The unique identifier for the object party in the relationship from external source system.
- ObjectTableName; string; The source table name of the object party in this relationship.
- ObjectType; string; The object type of the relationship like ORGANIZATION, PERSON.
- ObjectUsageCode; string; The usage code of object party in the relationship.
- ObjectVersionNumber; integer; The number used to implement optimistic locking for relationship record. This number is incremented every time 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.
- ObjectVersionNumber1; integer; The alternate number used to implement optimistic locking for relationship record.
- ObjectVersionNumber2; integer; The alternate number to implement optimistic locking for relationship record.
- PartyId; integer; The alternate unique identifier of the associated party record.
- PartyId1; integer; The alternate identifier of the associated party record.
- PercentageOwnership; number; The percentage of the child entity owned by the parent entity.
- RelationshipCode; string; The code indicating whether this is a forward or a backward relationship code.
- RelationshipId; integer; The unique identifier of the relationship.
- RelationshipRecId; integer; The unique identifier of the relationship record.
- RelationshipType; string; The name of the type of the relationship. For example, CUSTOMER_SUPPLIER.
- RequestId; integer; The unique identifier of the request on relationship record.
- SSROwnerTableName; string; The name of the table that holds the record data and is referenced to manage source system reference.
- StartDate; string; The date when the relationship begins.
- Status; string; The status of the relationship, A for active, I for inactive.
- SubjectPartyId; integer; The unique identifier of the subject in this relationship.
- SubjectPartyName; string; The name of the subject party.
- SubjectPartyNumber; string; The alternate key identifier of the subject party of the relationship.
- SubjectSourceSystem; string; The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup.
- SubjectSourceSystemReferenceValue; string; The unique identifier of the subject party in the relationship from external source system.
- SubjectTableName; string; The source table name of the subject party in this relationship.
- SubjectType; string; The subject type of the relationship like ORGANIZATION, PERSON.
- SubjectUsageCode; string; The usage code of subject party in the relationship.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : households-Relationship
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-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 comments provided by the user. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict for the relationship record. 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 and time when the record was created. -
DependentFlag: string
Title:
Dependent Indicator
Maximum Length:1
Default Value:N
Indicates whether one party is dependent on another. Default value is N. -
DirectionCode: string
Read Only:
true
Maximum Length:30
The code of the relationship direction. The list of accepted values are defined in the lookup DIRECTION_CODE. Valid values are P-Parent, C-Child, N-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. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation. -
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 and time 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 details 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 in this relationship.
-
ObjectPartyName: string
Title:
Object Party Name
Read Only:true
Maximum Length:360
The name of the object party. -
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The alternate key identifier of the object party of the relationship. -
ObjectSourceSystem: string
Title:
Object Source System
The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup. -
ObjectSourceSystemReferenceValue: string
Title:
Object Source System Reference
The unique identifier for the object party in the relationship from 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 relationship like ORGANIZATION, PERSON. -
ObjectUsageCode: string
Maximum Length:
30
The usage code of object party in the relationship. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking for relationship record. This number is incremented every time 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.
-
ObjectVersionNumber1: integer
(int32)
Read Only:
true
The alternate number used to implement optimistic locking for relationship record. -
ObjectVersionNumber2: integer
(int32)
Read Only:
true
The alternate number to implement optimistic locking for relationship record. -
PartyId: integer
(int64)
Read Only:
true
The alternate unique identifier of the associated party record. -
PartyId1: integer
(int64)
Read Only:
true
The alternate identifier of the associated party record. -
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 indicating whether this is a forward or a backward relationship code. -
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 the external source system for the relationship, which are defined by an admin as part of the system setup.
-
RelationshipSourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The name of the type of the relationship. For example, CUSTOMER_SUPPLIER. -
RequestId: integer
(int64)
The unique identifier of the request on relationship record.
-
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 begins. -
Status: string
Read Only:
true
Maximum Length:1
Default Value:A
The status of the relationship, A for active, I for inactive. -
SubjectPartyId: integer
(int64)
The unique identifier of the subject 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 of the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup. -
SubjectSourceSystemReferenceValue: string
Title:
Subject Source System Reference
The unique identifier of the subject party in the relationship from external source system. -
SubjectTableName: string
Maximum Length:
30
The source table name of the subject party in this relationship. -
SubjectType: string
Maximum Length:
30
The subject type of the relationship like ORGANIZATION, PERSON. -
SubjectUsageCode: string
Maximum Length:
30
The usage code of subject party in the relationship.
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.