Update an object type
patch
/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}
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.
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
Default Value:Y
Indicates whether the object type is enabled for user context. The default value is 'Y'. -
objectConfigs: array
Object Configurations
Title:
Object Configurations
The object configurations resource is used to view and update an object configuration. -
objectCriteria: array
Object Criteria
Title:
Object Criteria
The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches. -
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. - relatedObjects: array Related Objects
Nested Schema : Object Configurations
Type:
array
Title:
Object Configurations
The object configurations resource is used to view and update an object configuration.
Show Source
Nested Schema : Object Criteria
Type:
array
Title:
Object Criteria
The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.
Show Source
Nested Schema : userContextObjectTypes-objectConfigs-item-patch-request
Type:
Show Source
object
-
Enabled: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the object for the data source is enabled for user context. -
objectConfigDetails: array
Object Configuration Details
Title:
Object Configuration Details
The object configuration details resource is used to view and update the object configuration. -
ObjectMappingCode: string
Title:
Object Mapping Code
Maximum Length:150
The name of the object type used for the data source. -
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. -
ObjectWeight: integer
(int32)
Title:
Object Weight
The weight or relevance of a data source. This is used to calculate the relevance score. -
Score: integer
(int64)
Title:
Score
The score of a relevant item.
Nested Schema : Object Configuration Details
Type:
array
Title:
Object Configuration Details
The object configuration details resource is used to view and update the object configuration.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
DataSourceCode: string
Title:
Data Source Code
Maximum Length:30
The data source code for sources where user context information is captured and stored. -
Enabled: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether Saved Search is enabled for the user context or not. -
MaximumFetchSize: integer
(int32)
Title:
Maximum Fetch Size
Default Value:5
Indicates the maximum number of matching objects that can be added to the user context. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Default Value:1
The attribute is used to implement optimistic locking. 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. -
SavedSearchJson: string
(byte)
Title:
Saved Search JSON
Stores the saved search criteria parameters in JSON format. -
Score: integer
(int32)
Title:
Score
Default Value:0
Indicates the base score defined for the Saved Search Criteria.
Nested Schema : schema
Type:
Show Source
object
-
Enabled: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the Saved Search is enabled for user context or not. -
MaximumFetchSize: integer
(int32)
Title:
Maximum Fetch Size
Default Value:5
The maximum number of matching objects that can be added to the user context. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Default Value:1
The attribute used to implement optimistic locking. 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. -
SavedSearchJson: string
(byte)
Title:
Saved Search JSON
The saved search criteria parameters in JSON format. -
Score: integer
(int32)
Title:
Score
Default Value:0
The base score defined for the Saved Search Criteria.
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 : userContextObjectTypes-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. -
Enabled: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the object type is enabled for user context. The default value is 'Y'. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when time 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. -
objectConfigs: array
Object Configurations
Title:
Object Configurations
The object configurations resource is used to view and update an object configuration. -
objectCriteria: array
Object Criteria
Title:
Object Criteria
The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches. -
ObjectTypeCode: string
Title:
Object Type Code
Maximum Length:30
Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on. -
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. - relatedObjects: array Related Objects
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Object Configurations
Type:
array
Title:
Object Configurations
The object configurations resource is used to view and update an object configuration.
Show Source
Nested Schema : Object Criteria
Type:
array
Title:
Object Criteria
The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.
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.
Nested Schema : userContextObjectTypes-objectConfigs-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
The data source code for sources where user context information is captured and stored. -
Enabled: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the object for the data source is enabled for user context. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when time 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. -
objectConfigDetails: array
Object Configuration Details
Title:
Object Configuration Details
The object configuration details resource is used to view and update the object configuration. -
ObjectMappingCode: string
Title:
Object Mapping Code
Maximum Length:150
The name of the object type used for the data source. -
ObjectTypeCode: string
Title:
Object Type Code
Maximum Length:30
Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on. -
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. -
ObjectWeight: integer
(int32)
Title:
Object Weight
The weight or relevance of a data source. This is used to calculate the relevance score. -
Score: integer
(int64)
Title:
Score
The score of a relevant item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Object Configuration Details
Type:
array
Title:
Object Configuration Details
The object configuration details resource is used to view and update the object configuration.
Show Source
Nested Schema : userContextObjectTypes-objectConfigs-objectConfigDetails-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DataSourceCode: string
Title:
Data Source Code
Maximum Length:30
The data source code for sources where user context information is captured and stored. -
Enabled: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether Saved Search is enabled for the user context or not. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumFetchSize: integer
(int32)
Title:
Maximum Fetch Size
Default Value:5
Indicates the maximum number of matching objects that can be added to the user context. -
ObjectConfigDetailsId: string
Title:
Object Configuration Details Identifier
Maximum Length:512
The unique identifier of the object configuration detail. -
ObjectTypeCode: string
Title:
Object Type Code
Maximum Length:30
Indicates the code for the type of object. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Default Value:1
The attribute is used to implement optimistic locking. 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. -
SavedSearchJson: string
(byte)
Title:
Saved Search JSON
Stores the saved search criteria parameters in JSON format. -
Score: integer
(int32)
Title:
Score
Default Value:0
Indicates the base score defined for the Saved Search Criteria.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : userContextObjectTypes-objectCriteria-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
Enabled: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the Saved Search is enabled for user context or not. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
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. -
MaximumFetchSize: integer
(int32)
Title:
Maximum Fetch Size
Default Value:5
The maximum number of matching objects that can be added to the user context. -
ObjectTypeCode: string
Title:
Object Type Code
Maximum Length:30
Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Default Value:1
The attribute used to implement optimistic locking. 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. -
SavedSearchJson: string
(byte)
Title:
Saved Search JSON
The saved search criteria parameters in JSON format. -
SavedSearchUuid: string
Title:
Saved Search GUID
Maximum Length:512
The foreign key reference to the SavedSearchUUID of the Saved Search(zca_es_saved_searches) defined in Workspace. -
Score: integer
(int32)
Title:
Score
Default Value:0
The base score defined for the Saved Search Criteria.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- objectConfigs
-
Operation: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigsParameters:
- ObjectTypeCode:
$request.path.ObjectTypeCode
The object configurations resource is used to view and update an object configuration. - ObjectTypeCode:
- objectCriteria
-
Operation: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteriaParameters:
- ObjectTypeCode:
$request.path.ObjectTypeCode
The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches. - ObjectTypeCode:
- relatedObjects
-
Operation: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/relatedObjectsParameters:
- ObjectTypeCode:
$request.path.ObjectTypeCode
The related objects resource is used to view and update a related object. - ObjectTypeCode:
Examples
The following example shows how to update an object type 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/CRMProduct
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.
{ "ObjectTypeCode": "CRMProduct", "Enabled": "Y", "CreationDate": "2020-03-16T17:26:50.053+00:00", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "LastUpdateDate": "2020-10-13T08:55:53+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "B1807D2E569D4C47E053D711F10A50BD", "ObjectVersionNumber": 5, ... }