Update a context data source
patch
/crmRestApi/resources/11.13.18.05/userContextDataSources/{DataSourceCode}
Request
Path Parameters
-
DataSourceCode(required): string
Data source code for sources where user context information is captured and stored.
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
Root Schema : schema
Type:
Show Source
object
-
Enabled: string
Title:
Enabled
Maximum Length:1
Indicates whether the data source will be enabled for user context. The default is 'Y'. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The object version number 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 queried.
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.
Root Schema : userContextDataSources-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DataSourceCode: string
Title:
Data Source Code
Maximum Length:30
Data source code for sources where user context information is captured and stored. -
Enabled: string
Title:
Enabled
Maximum Length:1
Indicates whether the data source will be enabled for user context. The default is 'Y'. -
LastUpdateDate: string
(date-time)
Title:
Last Update 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. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The object version number 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 queried.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 an user context data source by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl --user
sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextDataSources/FAVORITE
Request Body
The following shows the contents of the request body in JSON format.
{ "Enabled" : "Y" }
Response Body
The following shows the contents of the response body in JSON format.
{ "DataSourceCode": "FAVORITE", "Enabled": "Y", "CreationDate": "2019-11-29T21:54:37+00:00", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "LastUpdateDate": "2020-10-13T08:39:41+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "B06943A3DB08FE9AE05369B3F20A5B58", "ObjectVersionNumber": 3, ... }