Get a user table detail value.
get
/hcmRestApi/resources/11.13.18.05/userTableDetailValues/{UserTableId}
Request
Path Parameters
-
UserTableId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : userTableDetailValues-item-response
Type:
Show Source
object
-
ColumnidEight: number
Read Only:
true
Unique identifier of the eighth column. -
ColumnidEleven: number
Read Only:
true
Unique identifier of the eleventh column. -
ColumnidFifteen: number
Read Only:
true
Unique identifier of the fifteenth column. -
ColumnidFive: number
Read Only:
true
Unique identifier of the fifth column. -
ColumnidFour: number
Read Only:
true
Unique identifier of the fourth column. -
ColumnidFourteen: number
Read Only:
true
Unique identifier of the fourteenth column. -
ColumnidNine: number
Read Only:
true
Unique identifier of the ninth column. -
ColumnidOne: number
Read Only:
true
Unique identifier of the first column. -
ColumnidSeven: number
Read Only:
true
Unique identifier of the seventh column. -
ColumnidSix: number
Read Only:
true
Unique identifier of the sixth column. -
ColumnidTen: number
Read Only:
true
Unique identifier of the tenth column. -
ColumnidThirteen: number
Read Only:
true
Unique identifier of the thirteenth column. -
ColumnidThree: number
Read Only:
true
Unique identifier of the third column. -
ColumnidTwelve: number
Read Only:
true
Unique identifier of the twelfth column. -
ColumnidTwo: number
Read Only:
true
Unique identifier of the second column. -
ColumnValueEight: string
Read Only:
true
Maximum Length:255
Value of the column instance for the eighth column. -
ColumnValueEleven: string
Read Only:
true
Maximum Length:255
Value of the column instance for the eleventh column. -
ColumnValueFifteen: string
Read Only:
true
Maximum Length:255
Value of the column instance for the fifteenth column. -
ColumnValueFive: string
Read Only:
true
Maximum Length:255
Value of the column instance for the fifth column. -
ColumnValueFour: string
Read Only:
true
Maximum Length:255
Value of the column instance for the fourth column. -
ColumnValueFourteen: string
Read Only:
true
Maximum Length:255
Value of the column instance for the fourteenth column. -
ColumnValueNine: string
Read Only:
true
Maximum Length:255
Value of the column instance for the ninth column. -
ColumnValueOne: string
Read Only:
true
Maximum Length:255
Value of the column instance for the first column. -
ColumnValueSeven: string
Read Only:
true
Maximum Length:255
Value of the column instance for the seventh column. -
ColumnValueSix: string
Read Only:
true
Maximum Length:255
Value of the column instance for the sixth column. -
ColumnValueTen: string
Read Only:
true
Maximum Length:255
Value of the column instance for the tenth column. -
ColumnValueThirteen: string
Read Only:
true
Maximum Length:255
Value of the column instance for the thirteenth column. -
ColumnValueThree: string
Read Only:
true
Maximum Length:255
Value of the column instance for the third column. -
ColumnValueTwelve: string
Read Only:
true
Maximum Length:255
Value of the column instance for the twelfth column. -
ColumnValueTwo: string
Read Only:
true
Maximum Length:255
Value of the column instance for the second column. -
DisplaySequence: integer
(int32)
Read Only:
true
Display sequence of the user row. -
EffectiveEndDateEight: string
(date)
Read Only:
true
Effective end date of the eighth column instance. -
EffectiveEndDateEleven: string
(date)
Read Only:
true
Effective end date of the eleventh column instance. -
EffectiveEndDateFifteen: string
(date)
Read Only:
true
Effective end date of the fifteenth column instance. -
EffectiveEndDateFive: string
(date)
Read Only:
true
Effective end date of the fifth column instance. -
EffectiveEndDateFour: string
(date)
Read Only:
true
Effective end date of the fourth column instance. -
EffectiveEndDateFourteen: string
(date)
Read Only:
true
Effective end date of the fourteenth column instance. -
EffectiveEndDateNine: string
(date)
Read Only:
true
Effective end date of the ninth column instance. -
EffectiveEndDateOne: string
(date)
Read Only:
true
Effective end date of the first column instance. -
EffectiveEndDateSeven: string
(date)
Read Only:
true
Effective end date of the seventh column instance. -
EffectiveEndDateSix: string
(date)
Read Only:
true
Effective end date of the sixth column instance. -
EffectiveEndDateTen: string
(date)
Read Only:
true
Effective end date of the tenth column instance. -
EffectiveEndDateThirteen: string
(date)
Read Only:
true
Effective end date of the thirteenth column instance. -
EffectiveEndDateThree: string
(date)
Read Only:
true
Effective end date of the third column instance. -
EffectiveEndDateTwelve: string
(date)
Read Only:
true
Effective end date of the twelfth column instance. -
EffectiveEndDateTwo: string
(date)
Read Only:
true
Effective end date of the second column instance. -
EffectiveStartDateEgiht: string
(date)
Read Only:
true
Effective end date of the eighth column instance. -
EffectiveStartDateEleven: string
(date)
Read Only:
true
Effective start date of the eleventh column instance. -
EffectiveStartDateFifteen: string
(date)
Read Only:
true
Effective start date of the fifteenth column instance. -
EffectiveStartDateFive: string
(date)
Read Only:
true
Effective start date of the fifth column instance. -
EffectiveStartDateFour: string
(date)
Read Only:
true
Effective start date of the fourth column instance. -
EffectiveStartDateFourteen: string
(date)
Read Only:
true
Effective start date of the fourteenth column instance. -
EffectiveStartDateNine: string
(date)
Read Only:
true
Effective start date of the ninth column instance. -
EffectiveStartDateOne: string
(date)
Read Only:
true
Effective start date of the first column instance. -
EffectiveStartDateSeven: string
(date)
Read Only:
true
Effective start date of the seventh column instance. -
EffectiveStartDateSix: string
(date)
Read Only:
true
Effective start date of the sixth column instance. -
EffectiveStartDateTen: string
(date)
Read Only:
true
Effective start date of the tenth column instance. -
EffectiveStartDateThirteen: string
(date)
Read Only:
true
Effective start date of the thirteenth column instance. -
EffectiveStartDateThree: string
(date)
Read Only:
true
Effective start date of the third column instance. -
EffectiveStartDateTwelve: string
(date)
Read Only:
true
Effective start date of the twelfth column instance. -
EffectiveStartDateTwo: string
(date)
Read Only:
true
Effective start date of the second column instance. -
InstanceIdEight: number
Read Only:
true
Unique identifier of the eighth column instance. -
InstanceIdEleven: number
Read Only:
true
Unique identifier of the eleventh column instance. -
InstanceIdFifteen: number
Read Only:
true
Unique identifier of the fifteenth column instance. -
InstanceIdFive: number
Read Only:
true
Unique identifier of the fifth column instance. -
InstanceIdFour: number
Read Only:
true
Unique identifier of the fourth column instance. -
InstanceIdFourteen: number
Read Only:
true
Unique identifier of the fourteenth column instance. -
InstanceIdNine: number
Read Only:
true
Unique identifier of the ninth column instance. -
InstanceIdOne: number
Read Only:
true
Unique identifier of the first column instance. -
InstanceIdSeven: number
Read Only:
true
Unique identifier of the seventh column instance. -
InstanceIdSix: number
Read Only:
true
Unique identifier of the sixth column instance. -
InstanceIdTen: number
Read Only:
true
Unique identifier of the tenth column instance. -
InstanceIdThirteen: number
Read Only:
true
Unique identifier of the thirteenth column instance. -
InstanceIdThree: number
Read Only:
true
Unique identifier of the third column instance. -
InstanceIdTwelve: number
Read Only:
true
Unique identifier of the twelfth column instance. -
InstanceIdTwo: number
Read Only:
true
Unique identifier of the second column instance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RowName: string
Read Only:
true
Maximum Length:80
Name of the user row. -
UserRowId: integer
(int64)
Read Only:
true
Unique identifier of user the row. -
UserTableId: integer
Read Only:
true
Unique identifier of the user table.
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.