1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Accounts
  4. Relationships

Get all relationships

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship

Request

Path Parameters
  • 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. Inactive records can't be updated.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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 identifier of the relationship.
    • Relationship2AltKey: Finds a relationship using the subject party and relationship details.
      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. For example, CUSTOMER_SUPPLIER.
      • SubjectPartyNumber; string; The unique identification number for the subject party of the relationship.
    • Relationship3AltKey: Finds a relationship using the source system, object party, and relationship details.
      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. For example, CUSTOMER_SUPPLIER.
      • SubjectSourceSystem; string; Name of external source system for the subject party in the relationship
      • SubjectSourceSystemReferenceValue; string; Identifier for the subject party in the relationship from external source system
    • Relationship4AltKey: Finds a relationship using the subject party identifier, object party number, and relationship details.
      Finder Variables:
      • ObjectPartyNumber; string; 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. For example, CUSTOMER_SUPPLIER.
      • SubjectPartyId; integer; Identifier for a subject in the relationship.
    • Relationship5AltKey: Finds a relationship with the specified parameters.
      Finder Variables:
      • ObjectPartyNumber; string; 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. For example, CUSTOMER_SUPPLIER.
      • SubjectPartyNumber; string; Unique identification number for the subject party of the relationship.
    • Relationship6AltKey: Finds a relationship using the subject source system, object party number, and relationship details.
      Finder Variables:
      • ObjectPartyNumber; string; 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; Identifier for a subject in the relationship.
      • SubjectSourceSystem; string; Name of external source system for the subject party in the relationship
      • SubjectSourceSystemReferenceValue; string; Identifier for the subject party in the relationship from external source system
    • Relationship7AltKey: Finds a relationship using the object source system, subject party identifier, and relationship details.
      Finder Variables:
      • ObjectSourceSystem; string; Name of external source system for the subject party in the relationship
      • ObjectSourceSystemReferenceValue; string; 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; Identifier for a subject in the relationship.
      • SubjectPartyId; integer; Identifier for a subject in the relationship.
    • Relationship8AltKey: Finds a relationship using the object source system, subject party number, and relationship details.
      Finder Variables:
      • ObjectSourceSystem; string; Name of external source system for the object party in the relationship.
      • ObjectSourceSystemReferenceValue; string; 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; Identifier for a subject in the relationship.
      • SubjectPartyNumber; string; Unique identification number for the subject party of the relationship.
    • Relationship9AltKey: Finds a relationship using the subject and object source system information.
      Finder Variables:
      • ObjectSourceSystem; string; Name of external source system for the object party in the relationship.
      • ObjectSourceSystemReferenceValue; string; 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. For example, CUSTOMER_SUPPLIER.
      • SubjectSourceSystem; string; Name of external source system for the subject party in the relationship.
      • SubjectSourceSystemReferenceValue; string; Identifier for the subject party in the relationship from external source system.
    • RelationshipAltKey: Find a relationship using the subject party identifier, the object party identifier, and the relationship details.
      Finder Variables:
      • ObjectPartyId; integer; The identifier of the object in this relationship.
      • RelationshipCode; string; Specifies if this is a forward or a backward relationship code.
      • RelationshipType; string; The relationship type name. For example, CUSTOMER_SUPPLIER.
      • SubjectPartyId; integer; Identifier for a subject in the relationship.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 user-provided comments for the relationship.
    • ConflictId; integer; The unique identifier of the conflict. 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 when the record was created.
    • DependentFlag; string; Indicates whether one party is a dependent on another.
    • DirectionCode; string; The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for 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.
    • 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 when the record was last updated.
    • LastUpdateLogin; string; The login 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 party in this relationship.
    • ObjectPartyName; string; The name of the object party of the relationship.
    • ObjectPartyNumber; string; The alternate key identifier for the object party of the relationship.
    • ObjectSourceSystem; string; The name of the external source system for the object party in the relationship.
    • ObjectSourceSystemReferenceValue; string; The identifier for the object party in the relationship from the external source system.
    • ObjectTableName; string; The source table name of the object party in this relationship.
    • ObjectType; string; The object type of the contact.
    • ObjectUsageCode; string; The usage code of object party in the relationship.
    • ObjectVersionNumber; integer; 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; 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; 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; The unique identifier of the party.
    • PartyId1; integer; The alternate unique identifier of the party.
    • PercentageOwnership; number; The percentage of the child entity owned by the parent entity.
    • RelationshipCode; string; 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; The unique identifier of the relationship.
    • RelationshipRecId; integer; The unique identifier of the relationship record.
    • RelationshipType; string; 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; The unique identifier of the request.
    • 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 was created.
    • Status; string; 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; The unique identifier of the subject party in this relationship.
    • SubjectPartyName; string; The name of the subject party.
    • SubjectPartyNumber; string; The alternate key identifier for the subject party of the relationship.
    • SubjectSourceSystem; string; The name of the external source system for the subject party in the relationship.
    • SubjectSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from the external source system.
    • SubjectTableName; string; The source table of the subject.
    • SubjectType; string; The subject type of the contact.
    • SubjectUsageCode; string; The usage code of subject party in the contact.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : accounts-Relationship
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : accounts-Relationship-item-response
Type: object
Show Source
  • Title: Backward Role
    Read Only: true
    The backward relationship code used to describe relationships. For example, SUPPLIER_OF.
  • Title: Comments
    Maximum Length: 2000
    The user-provided comments for the relationship.
  • Default Value: 0
    The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • 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.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Dependent Indicator
    Maximum Length: 1
    Default Value: N
    Indicates whether one party is a dependent on another.
  • 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.
  • Title: To Date
    The date when the relationship ends.
  • 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.
  • Title: Influence Level
    The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.
  • Maximum Length: 100
    The definition of the job name.
  • Maximum Length: 900
    The definition of the job package.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • The unique identifier of the object party in this relationship.
  • Title: Object Party Name
    Read Only: true
    Maximum Length: 360
    The name of the object party of the relationship.
  • Title: Object Registry ID
    Maximum Length: 30
    The alternate key identifier for the object party of the relationship.
  • Title: Object Source System
    The name of the external source system for the object party in the relationship.
  • Title: Object Source System Reference
    The identifier for the object party in the relationship from the external source system.
  • Maximum Length: 30
    The source table name of the object party in this relationship.
  • Maximum Length: 30
    The object type of the contact.
  • Maximum Length: 30
    The usage code of object party in the relationship.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    The unique identifier of the party.
  • Read Only: true
    The alternate unique identifier of the party.
  • Title: Ownership Percentage
    The percentage of the child entity owned by the parent entity.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    The unique identifier of the relationship.
  • The unique identifier of the relationship record.
  • The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
  • The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
  • 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.
  • The unique identifier of the request.
  • Title: Role
    The role between the subject and object party.
  • 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.
  • Title: From Date
    The date when the relationship was created.
  • 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.
  • The unique identifier of the subject party in this relationship.
  • Title: Subject Party Name
    Read Only: true
    Maximum Length: 360
    The name of the subject party.
  • Title: Subject Registry ID
    Maximum Length: 30
    The alternate key identifier for the subject party of the relationship.
  • Title: Subject Source System
    The name of the external source system for the subject party in the relationship.
  • Title: Subject Source System Reference
    The identifier for the subject party in the relationship from the external source system.
  • Maximum Length: 30
    The source table of the subject.
  • Maximum Length: 30
    The subject type of the contact.
  • Maximum Length: 30
    The usage code of subject party in the contact.
Back to Top

Examples

The following example shows how to get all relationships by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_336853/child/Relationship

Example of Response Body

The following shows an example of the response body in JSON format.

{
  {
   items: 
[
3]
0:  
{
RelationshipSourceSystem: null
RelationshipSourceSystemReferenceValue: null
ObjectPartyId: 300100046354520
SubjectPartyId: 300100046362488
RelationshipType: "CONTACT"
RelationshipCode: "CONTACT_OF"
StartDate: "2015-01-16"
EndDate: "4712-12-31"
CreatedByModule: "HZ_WS"
Comments: null
Status: "A"
CreatedBy: "SALES_ADMIN"
"PartyId" : 300100046354520,
  "PartyNumber" : "CDRM_336853",
   ...
  }
}
Back to Top