Jump to

• Request
• Response
• Examples

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. Inactive records can't be updated.
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PercentageOwnership":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of the child entity owned by the parent entity.",
            "nullable":true
        },
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the subject party of the relationship.",
            "nullable":false
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the relationship.",
            "nullable":true
        },
        "JobDefinitionName":{
            "maxLength":"100",
            "type":"string",
            "description":"The definition of the job name.",
            "nullable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "SubjectSourceSystemReferenceValue":{
            "title":"Subject Source System Reference",
            "type":"string",
            "description":"The identifier for the subject party in the relationship from the external source system.",
            "nullable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the relationship ends.",
            "format":"date",
            "nullable":false
        },
        "PrimaryCustomerFlag":{
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "InfluenceLevel":{
            "title":"Influence Level",
            "type":"string",
            "description":"The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "RelationshipSourceSystem":{
            "type":"string",
            "description":"The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "HeadOfHouseholdFlag":{
            "title":"Head of Household Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a person is the head of the household that he belongs to.",
            "nullable":true,
            "default":"N"
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the object party in this relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "JobDefinitionPackage":{
            "maxLength":"900",
            "type":"string",
            "description":"The definition of the job package.",
            "nullable":true
        },
        "ObjectSourceSystem":{
            "title":"Object Source System",
            "type":"string",
            "description":"The name of the external source system for the object party in the relationship.",
            "nullable":true
        },
        "ObjectPartyNumber":{
            "title":"Object Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the object party of the relationship.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"The name of the external source system for the subject party in the relationship.",
            "nullable":true
        },
        "PreferredContactFlag":{
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "SubjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subject party in this relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectSourceSystemReferenceValue":{
            "title":"Object Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from the external source system.",
            "nullable":true
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether one party is a dependent on another.",
            "nullable":true,
            "default":"N"
        }
    }
}

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 : accounts-Relationship-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the relationship was created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The subject type of the contact.",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"The name of the external source system for the subject party in the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactFlag":{
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "BackwardRole":{
            "title":"Backward Role",
            "type":"string",
            "description":"The backward relationship code used to describe relationships. For example, SUPPLIER_OF.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subject party in this relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubjectUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of subject party in the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"A",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentageOwnership":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of the child entity owned by the parent entity.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationshipRecId":{
            "type":"integer",
            "description":"The unique identifier of the relationship record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubjectSourceSystemReferenceValue":{
            "title":"Subject Source System Reference",
            "type":"string",
            "description":"The identifier for the subject party in the relationship from the external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCustomerFlag":{
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ObjectVersionNumber2":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Role":{
            "title":"Role",
            "type":"string",
            "description":"The role between the subject and object party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipSourceSystem":{
            "type":"string",
            "description":"The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "HeadOfHouseholdFlag":{
            "title":"Head of Household Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a person is the head of the household that he belongs to.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the table that holds the record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "ObjectUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of object party in the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectSourceSystemReferenceValue":{
            "title":"Object Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from the external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectTableName":{
            "maxLength":"30",
            "type":"string",
            "description":"The source table of the subject.",
            "nullable":false,
            "x-queryable":true
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether one party is a dependent on another.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobDefinitionName":{
            "maxLength":"100",
            "type":"string",
            "description":"The definition of the job name.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTableName":{
            "maxLength":"30",
            "type":"string",
            "description":"The source table name of the object party in this relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "InfluenceLevel":{
            "title":"Influence Level",
            "type":"string",
            "description":"The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The object type of the contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the object party in this relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobDefinitionPackage":{
            "maxLength":"900",
            "type":"string",
            "description":"The definition of the job package.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectPartyNumber":{
            "title":"Object Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the object party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyName":{
            "title":"Object Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the object party of the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubjectPartyName":{
            "title":"Subject Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the subject party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "DirectionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId1":{
            "type":"integer",
            "description":"The alternate unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the relationship ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectSourceSystem":{
            "title":"Object Source System",
            "type":"string",
            "description":"The name of the external source system for the object party in the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

BackwardRoleLOV

Operation: /crmRestApi/resources/11.13.18.05/relationshipTypes

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

InfluenceLevelLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

RelationshipCodeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

RelationshipTypeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

RoleLOV

Operation: /crmRestApi/resources/11.13.18.05/relationshipTypes

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

Back to Top

Examples

The following example shows how to update a relationship by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_2310/child/Relationship/300100090818648

Example of Request Body

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

{
   "Comments": "null"
}

Example of Response Body

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

{
"RelationshipId": 300100090818649,
"RelationshipRecId": 300100090818648,
"ObjectVersionNumber": 5,
"RelationshipSourceSystem": null,
"RelationshipSourceSystemReferenceValue": null,
"ObjectPartyId": 300100010638186,
"SubjectPartyId": 300100010649305,
"RelationshipType": "CONTACT",
"RelationshipCode": "CONTACT_OF",
"StartDate": "2016-12-19",
"EndDate": "4712-12-31",
"CreatedByModule": "HZ_WS",
"Comments": "null",
"Status": "A",
"CreatedBy": "MHoope",
"CreationDate": "2016-12-19T03:08:18-08:00",
"LastUpdateDate": "2016-12-19T03:18:46-08:00",
"LastUpdateLogin": "4401194542482278E053B80AF40ABC9C",
"LastUpdatedBy": "MHoope",
"DirectionCode": "P",
"DependentFlag": "N",
"PercentageOwnership": 50,
"SubjectPartyNumber": "CDRM_2336",
"PartyId": 300100010649305,
"ObjectVersionNumber1": 2,
"SubjectSourceSystem": null,
"SubjectSourceSystemReferenceValue": null,
"ObjectSourceSystem": null,
"ObjectSourceSystemReferenceValue": null,
"ObjectPartyNumber": "CDRM_2310",
"PartyId1": 300100010638186,
"ObjectVersionNumber2": 2,
"SubjectTableName": "HZ_PARTIES",
"SubjectType": "PERSON",
"SubjectUsageCode": null,
"ObjectTableName": "HZ_PARTIES",
"ObjectType": "ORGANIZATION",
"ObjectUsageCode": null,
"HeadOfHouseholdFlag": "N",
"RequestId": null,
"JobDefinitionName": null,
"JobDefinitionPackage": null,
"SSROwnerTableName": "HZ_PARTIES",
"SubjectPartyName": "Consumer First Name :53020121541410142 Consumer Second Name :53020121541410142",
"ObjectPartyName": "WS_SA530201205237378312",
"Role": "CONTACTORG",
"InfluenceLevel": null,
"BackwardRole": "ORGWITHCONTACT",
...
}

Back to Top