Update user column instance.
patch
/hcmRestApi/resources/11.13.18.05/userColumnInstances/{userColumnInstancesUniqID}
Request
Path Parameters
-
userColumnInstancesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- UserColumnInstanceId, EffectiveStartDate and EffectiveEndDate ---for the User Column Instances resource and used to uniquely identify an instance of User Column Instances. The client should not generate the hash key value. Instead, the client should query on the User Column Instances collection resource with a filter on the primary key values in order to navigate to a specific instance of User Column Instances.
For example: userColumnInstances?q=UserColumnInstanceId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date of the user column instance. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date of the user column instance. -
Value: string
Title:
Value
Maximum Length:255
Value for the user column instance.
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 : userColumnInstances-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date of the user column instance. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date of the user column instance. -
LegislativeDataGroupId: integer
(int64)
Title:
Legislative Data Group
Unique identifier for the legislative data group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserColumnId: integer
(int64)
Title:
Column
Unique identifier of the user column. -
UserColumnInstanceId: integer
(int64)
Unique identifier of the user column instance.
-
UserRowId: integer
(int64)
Title:
Row Name
Unique identifier of the user row. -
Value: string
Title:
Value
Maximum Length:255
Value for the user column instance.
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.