Update an object criterion
patch
/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria/{SavedSearchUuid}
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.
-
SavedSearchUuid(required): string
The foreign key reference to the SavedSearchUUID of the Saved Search(zca_es_saved_searches) defined in Workspace.
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 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-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
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 object criterion 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/userContextObjectTypes/Activity/child/objectCriteria/UC_SVSearch_Activity_01
Request Body
The following shows the contents of the request body in JSON format.
{ "MaximumFetchSize": 10 }
Response Body
The following shows the contents of the response body in JSON format.
{ "SavedSearchUuid": "UC_SVSearch_Activity_01", "ObjectTypeCode": "Activity", "Score": 500, "MaximumFetchSize": 10, "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-08-29T22:40:19+00:00", "Enabled": "Y", "LastUpdateDate": "2020-08-29T22:40:19.053+00:00", "LastUpdateLogin": "-1", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "ObjectVersionNumber": 2, ... }