Update an object configuration detail
patch
/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails/{ObjectConfigDetailsId}
Request
Path Parameters
-
DataSourceCode(required): string
The data source code for sources where user context information is captured and stored.
-
ObjectConfigDetailsId(required): string
The unique identifier of the object configuration detail.
-
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
-
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.
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-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 : 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.