Sales Cloud Relationship

The service used to create, update, retrieve, and delete relationships. Accounts, contacts and household could have various types of predefined relationships within Oracle Sales Cloud. A contact can have a contact relationship with an account or household while it could also be a member of a household. Other such relationships could exist between two contacts or between two accounts or households. This service is used to manage all such relationships between two parties.

Life Cycle Status: Active

QName: {http://xmlns.oracle.com/apps/crmCommon/salesParties/relationshipService/}RelationshipService

Service WSDL URL: https://servername/crmService/SalesPartiesRelationshipService?WSDL

Logical Business Objects

CRM : Trading Community Model : Account
CRM : Trading Community Model : Account
CRM : Trading Community Model : Account

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Handles	Relationship

createRelationship

An operation to create a relationship.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
relationship	Sales Cloud Relationship	The operation for the relationship to be created.

Response Payload

Element Name	Type	Description
result	Sales Cloud Relationship	The operation that returns create relationship.

updateRelationship

The operation to update relationship.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
relationship	Sales Cloud Relationship	The operation to update relationship.

Response Payload

Element Name	Type	Description
result	Sales Cloud Relationship	The parameter that returns updated relationship.

deleteRelationship

The operation that deletes a relationship.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
relationship	Sales Cloud Relationship	The operation for the relationship to be deleted.

Response Payload

Element Name	Type	Description
result	void	Not applicable.

mergeRelationship

The merge operation for relationship. It will perform an update if the object exists, or an insert if the object doesn't already exist.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
relationship	Sales Cloud Relationship	The operation for the relationship to be merged.

Response Payload

Element Name	Type	Description
result	Sales Cloud Relationship	The operation returns merged relationship.

findRelationship

An operation to find a list of relationships based matching the supplied criteria pertaining to the object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	The criteria used to limit your query result, such as the filter (or where clause), the fetch size, and so on.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	This operation is currently not in use.

Response Payload

Element Name	Type	Description
result	Sales Cloud Relationship	A list of relationship that satisfy the inbound criteria.

processRelationship

The operation that performs a create, update, delete, or merge operation on a list of relationship rows. The specified operation is applied to all objects in the given list.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
changeOperation	string	The operation that indicates what action, such as create, update, merge, or delete, will be performed.
relationship	Sales Cloud Relationship	The list of relationships to be processed.
processControl	{http://xmlns.oracle.com/adf/svc/types/}ProcessControl	The operation to control your bulk upload behavior. For example, whether the valid data will be committed if there are other invalid data in the same batch and whether the outbound will contain the key attributes only or the full object.

Response Payload

Element Name	Type	Description
result	Sales Cloud Relationship	The operation that returns the list of relationships that are successfully processed.

processCSRelationship

The operation that performs create, update, or delete on a list of relationship rows. Different operations may be applied to different objects, depending on what is specified in the change summary object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
processData	{http://xmlns.oracle.com/adf/svc/types/}ProcessData	The object that is used to represent the changes that have been made.
processControl	{http://xmlns.oracle.com/adf/svc/types/}ProcessControl	The operation to control your bulk upload behavior. For example, whether the valid data will be committed if there are other invalid data in the same batch and whether the outbound will contain the key attributes only or the full object.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ProcessData	The result of the operation including a list of created or updated data objects, and all warning and informational messages.

getDfltObjAttrHints

An operation to retrieve user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
viewName	string	The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload.
localeName	string	The locale to use when evaluating locale-based user interface hints. The locale name is in ISO 639-1 format.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints	The label and user interface hints for the specified service data object and its attributes in a name-value pair format.

getServiceLastUpdateTime

An operation that returns the date and time when the schema files referenced in the service definition last changed.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	The date and time when the service definition last changed in ISO 8601 format.

getEntityList

An operation to get the list of service data objects defined on this service.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo	A list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name	Privilege Code	Privilege Name	Privilege Description
findRelationship	ZCM_VIEW_SALES_PARTY_RELATIONSHIP_PRIV	View Sales Party Relationship	Allows viewing a sales party relationships to other parties.
processCSRelationship	ZCM_DELETE_SALES_PARTY_RELATIONSHIP_PRIV	Delete Sales Party Relationship	Allows deleting sales party relationships to other parties.
processCSRelationship	ZCM_CREATE_SALES_PARTY_RELATIONSHIP_PRIV	Create Sales Party Relationship	Allows creating sales party relationships to other parties.
processCSRelationship	ZCM_UPDATE_SALES_PARTY_RELATIONSHIP_PRIV	Update Sales Party Relationship	Allows updating a sales party relationships to other parties.
deleteRelationship	ZCM_DELETE_SALES_PARTY_RELATIONSHIP_PRIV	Delete Sales Party Relationship	Allows deleting sales party relationships to other parties.
updateRelationship	ZCM_UPDATE_SALES_PARTY_RELATIONSHIP_PRIV	Update Sales Party Relationship	Allows updating a sales party relationships to other parties.
createRelationship	ZCM_CREATE_SALES_PARTY_RELATIONSHIP_PRIV	Create Sales Party Relationship	Allows creating sales party relationships to other parties.
mergeRelationship	ZCM_UPDATE_SALES_PARTY_RELATIONSHIP_PRIV	Update Sales Party Relationship	Allows updating a sales party relationships to other parties.
processRelationship	ZCM_DELETE_SALES_PARTY_RELATIONSHIP_PRIV	Delete Sales Party Relationship	Allows deleting sales party relationships to other parties.
processRelationship	ZCM_CREATE_SALES_PARTY_RELATIONSHIP_PRIV	Create Sales Party Relationship	Allows creating sales party relationships to other parties.
processRelationship	ZCM_UPDATE_SALES_PARTY_RELATIONSHIP_PRIV	Update Sales Party Relationship	Allows updating a sales party relationships to other parties.

Privileges to Duty Roles Mapping

Privilege Code	Granted to Duty Role Code	Granted to Duty Role Name	Granted To Duty Role Description
ZCM_VIEW_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_SR_SALES_PARTY_MANAGEMENT	Service Sales Party Management	Can create Service Requests and help with resolution of the Service Request. Has basic Service Request management capabilities.
ZCM_VIEW_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY	Marketing Sales Party Management	Manages creation and maintenance of the sales organizations and consumers for internal marketing users. Additional duties include viewing of appointments, interactions, and customer contacts.
ZCM_VIEW_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_SALES_PARTY_REVIEW_DUTY	Sales Party Review	Allows resources read-only access to sales parties information such as manage customer work area and all sales party duties. Additional duties include view access to other customer and sales lead features.
ZCM_CREATE_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_SR_SALES_PARTY_MANAGEMENT	Service Sales Party Management	Can create Service Requests and help with resolution of the Service Request. Has basic Service Request management capabilities.
ZCM_CREATE_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY	Marketing Sales Party Management	Manages creation and maintenance of the sales organizations and consumers for internal marketing users. Additional duties include viewing of appointments, interactions, and customer contacts.
ZCM_CREATE_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY	Sales Party Management	Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts.
ZCM_UPDATE_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY	Marketing Sales Party Management	Manages creation and maintenance of the sales organizations and consumers for internal marketing users. Additional duties include viewing of appointments, interactions, and customer contacts.
ZCM_UPDATE_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY	Sales Party Management	Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts.
ZCM_DELETE_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY	Marketing Sales Party Management	Manages creation and maintenance of the sales organizations and consumers for internal marketing users. Additional duties include viewing of appointments, interactions, and customer contacts.
ZCM_DELETE_SALES_PARTY_RELATIONSHIP_PRIV	ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY	Sales Party Management	Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts.

Duty Roles to Duty or Job Roles Mapping

Duty Role Code	Granted to Duty or Job Role Code	Granted to Duty or Job Role Name	Granted To Duty or Job Role Description
ORA_ZCM_SALES_PARTY_REVIEW_DUTY	ORA_OKC_ALL_BUSINESS_UNITS_CONTRACT_INQUIRY_DUTY_CRM	Contract View Access Across All Contracts	Views all contracts across an enterprise.
ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY	ORA_OKC_ALL_BUSINESS_UNITS_CONTRACT_INQUIRY_DUTY_CRM	Contract View Access Across All Contracts	Views all contracts across an enterprise.
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY	ORA_ZCM_SALES_PARTY_REVIEW_DUTY	Sales Party Review	Allows resources read-only access to sales parties information such as manage customer work area and all sales party duties. Additional duties include view access to other customer and sales lead features.
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY	ORA_MANAGE_TRADING_COMMUNITY_IMPORT_BATCH_DUTY	Trading Community Import Batch Management	Manages trading community data import batches.
ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY	ORA_MANAGE_TRADING_COMMUNITY_IMPORT_BATCH_DUTY	Trading Community Import Batch Management	Manages trading community data import batches.