Update a related object mapping
patch
/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/relatedObjects/{TargetObjectTypeCode}
Request
Path Parameters
-
ObjectTypeCode(required): string
Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.
-
TargetObjectTypeCode(required): string
The object type code of the related object. The related object mapping is used for deriving user context.
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
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.
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to update a related object mapping by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextObjectTypes/Activity/child/relatedObjects/Lead
Example of Request Body
The following shows the contents of the request body in JSON format.
{ "Enabled": "Y" }
Example of Response Body
The following shows the contents of the response body in JSON format.
{ "SourceObjectTypeCode": "Activity", "TargetObjectTypeCode": "Lead", "Enabled": "Y", "CreationDate": "2019-12-19T13:18:31.942+00:00", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "LastUpdateDate": "2020-06-16T07:31:47.216+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "LastUpdateLogin": "-1", "ObjectVersionNumber": 1, ... }