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

Update a relationship

patch

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship/{RelationshipRecId}

Request

Path Parameters
  • 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. Inactive records can't be updated.
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Comments
    Maximum Length: 2000
    The comments provided by the user.
  • 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.
  • Title: Dependent Indicator
    Maximum Length: 1
    Default Value: N
    Indicates whether one party is dependent on another. Default value is N.
  • 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. 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.
  • 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.
  • The unique identifier of the object in this relationship.
  • Title: Object Registry ID
    Maximum Length: 30
    The alternate key identifier of the object party of the relationship.
  • 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.
  • Title: Object Source System Reference
    The unique identifier for the object party in the relationship from external source system.
  • 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.
  • 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 Group
    Maximum Length: 255
    Used for filtering the Role and Backward Role drop down values with relationship types that are part of provided relationship group.
  • The name of the external source system for the relationship, which are defined by an admin as part of the system setup.
  • The unique identifier of the relationship from external source system.
  • The unique identifier of the request on relationship record.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • The unique identifier of the subject in this relationship.
  • Title: Subject Registry ID
    Maximum Length: 30
    The alternate key identifier of the subject party of the relationship.
  • 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.
  • Title: Subject Source System Reference
    The unique identifier of the subject party in the relationship from external source system.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : households-Relationship-smartActions-item-patch-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : households-Relationship-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : households-Relationship-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : households-Relationship-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
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 : households-Relationship-item-response
Type: object
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : households-Relationship-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : households-Relationship-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : households-Relationship-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : households-Relationship-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Links
BackwardRoleLOV
Parameters:
  • finder: RoleForSubjectObjectFinder%3BbindObjectType%3D{SubjectType}%2CbindSubjectType%3D{ObjectType}%2CbindRelationshipGroup%3D{RelationshipGroup}
The following properties are defined on the LOV link relation:
  • Source Attribute: BackwardRole; Target Attribute: Role
  • Display Attribute: Description
InfluenceLevelLookupLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_INFLUENCE_LVL_CD
The list of values indicating the influence level of the object party in the relationship.

The following properties are defined on the LOV link relation:
  • Source Attribute: InfluenceLevel; Target Attribute: LookupCode
  • Display Attribute: LookupCode
RelationshipCodeLookupLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DPARTY_RELATIONS_TYPE
The list of values for the relationship code, such as Branch of or Associate of.

The following properties are defined on the LOV link relation:
  • Source Attribute: RelationshipCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
RelationshipEO_setPreferredContactId
Parameters:
  • PartyNumber: $request.path.PartyNumber
  • RelationshipRecId2: $request.path.RelationshipRecId2
RelationshipTypeLookupLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHZ_RELATIONSHIP_TYPE
The list of values for the relationship type name, such as Contact or Association.

The following properties are defined on the LOV link relation:
  • Source Attribute: RelationshipType; Target Attribute: LookupCode
  • Display Attribute: Meaning
RoleLOV
Parameters:
  • finder: RoleForSubjectObjectFinder%3BbindObjectType%3D{ObjectType}%2CbindSubjectType%3D{SubjectType}%2CbindRelationshipGroup%3D{RelationshipGroup}
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
smartActions
Parameters:
  • PartyNumber: $request.path.PartyNumber
  • RelationshipRecId2: $request.path.RelationshipRecId2
This VO stores the endpoint and security details for every user action.
Back to Top

Examples

cURL Command

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

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_2310/child/Relationship/300100090818648

Example of Request Body

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

{
 "ObjectPartyId": 300100044820693,
 "SubjectPartyId": 300100044820259,
 "RelationshipType": "CONTACT",
 "RelationshipCode": "CONTACT_OF",
 "EndDate": "2027-02-26",
 "Comments": "Updating End Date"
 }

Example of Response Body

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

{
 "ObjectPartyId": 300100044820693,
 "SubjectPartyId": 300100044820259,
 "RelationshipType": "CONTACT",
 "RelationshipCode": "CONTACT_OF",
 "StartDate": "2014-02-26",
 "EndDate": "2027-02-26",
 "CreatedByModule": "HZ_WS",
 "Status": "A",
 "CreatedBy": "SALES_REPRESENTATIVE",
 "SubjectPartyNumber": "CDRM_738835",
 "ObjectPartyNumber": "SBS_AACT_226543",
 "Comments": "Updating End Date",
...
}
Back to Top