Get all user table detail values.

get

/hcmRestApi/resources/11.13.18.05/userTableDetailValues

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all the detail values of a user table that match the specified primary key criteria.
      Finder Variables
      • UserTableId; integer; Unique identifier of the user table.
    • findByUserTableId Finds the user defined table detail values with the specified user table ID.
      Finder Variables
      • EffectiveAsOfDate; string; Get user table detail values as of this date.
      • LegislativeDataGroupId; integer; Unique identifier for the legislative data group.
      • UserTableId; integer; Unique identifier of the user table.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ColumnValueEight; string; Value of the column instance for the eighth column.
    • ColumnValueEleven; string; Value of the column instance for the eleventh column.
    • ColumnValueFifteen; string; Value of the column instance for the fifteenth column.
    • ColumnValueFive; string; Value of the column instance for the fifth column.
    • ColumnValueFour; string; Value of the column instance for the fourth column.
    • ColumnValueFourteen; string; Value of the column instance for the fourteenth column.
    • ColumnValueNine; string; Value of the column instance for the ninth column.
    • ColumnValueOne; string; Value of the column instance for the first column.
    • ColumnValueSeven; string; Value of the column instance for the seventh column.
    • ColumnValueSix; string; Value of the column instance for the sixth column.
    • ColumnValueTen; string; Value of the column instance for the tenth column.
    • ColumnValueThirteen; string; Value of the column instance for the thirteenth column.
    • ColumnValueThree; string; Value of the column instance for the third column.
    • ColumnValueTwelve; string; Value of the column instance for the twelfth column.
    • ColumnValueTwo; string; Value of the column instance for the second column.
    • ColumnidEight; number; Unique identifier of the eighth column.
    • ColumnidEleven; number; Unique identifier of the eleventh column.
    • ColumnidFifteen; number; Unique identifier of the fifteenth column.
    • ColumnidFive; number; Unique identifier of the fifth column.
    • ColumnidFour; number; Unique identifier of the fourth column.
    • ColumnidFourteen; number; Unique identifier of the fourteenth column.
    • ColumnidNine; number; Unique identifier of the ninth column.
    • ColumnidOne; number; Unique identifier of the first column.
    • ColumnidSeven; number; Unique identifier of the seventh column.
    • ColumnidSix; number; Unique identifier of the sixth column.
    • ColumnidTen; number; Unique identifier of the tenth column.
    • ColumnidThirteen; number; Unique identifier of the thirteenth column.
    • ColumnidThree; number; Unique identifier of the third column.
    • ColumnidTwelve; number; Unique identifier of the twelfth column.
    • ColumnidTwo; number; Unique identifier of the second column.
    • DisplaySequence; integer; Display sequence of the user row.
    • EffectiveEndDateEight; string; Effective end date of the eighth column instance.
    • EffectiveEndDateEleven; string; Effective end date of the eleventh column instance.
    • EffectiveEndDateFifteen; string; Effective end date of the fifteenth column instance.
    • EffectiveEndDateFive; string; Effective end date of the fifth column instance.
    • EffectiveEndDateFour; string; Effective end date of the fourth column instance.
    • EffectiveEndDateFourteen; string; Effective end date of the fourteenth column instance.
    • EffectiveEndDateNine; string; Effective end date of the ninth column instance.
    • EffectiveEndDateOne; string; Effective end date of the first column instance.
    • EffectiveEndDateSeven; string; Effective end date of the seventh column instance.
    • EffectiveEndDateSix; string; Effective end date of the sixth column instance.
    • EffectiveEndDateTen; string; Effective end date of the tenth column instance.
    • EffectiveEndDateThirteen; string; Effective end date of the thirteenth column instance.
    • EffectiveEndDateThree; string; Effective end date of the third column instance.
    • EffectiveEndDateTwelve; string; Effective end date of the twelfth column instance.
    • EffectiveEndDateTwo; string; Effective end date of the second column instance.
    • EffectiveStartDateEgiht; string; Effective end date of the eighth column instance.
    • EffectiveStartDateEleven; string; Effective start date of the eleventh column instance.
    • EffectiveStartDateFifteen; string; Effective start date of the fifteenth column instance.
    • EffectiveStartDateFive; string; Effective start date of the fifth column instance.
    • EffectiveStartDateFour; string; Effective start date of the fourth column instance.
    • EffectiveStartDateFourteen; string; Effective start date of the fourteenth column instance.
    • EffectiveStartDateNine; string; Effective start date of the ninth column instance.
    • EffectiveStartDateOne; string; Effective start date of the first column instance.
    • EffectiveStartDateSeven; string; Effective start date of the seventh column instance.
    • EffectiveStartDateSix; string; Effective start date of the sixth column instance.
    • EffectiveStartDateTen; string; Effective start date of the tenth column instance.
    • EffectiveStartDateThirteen; string; Effective start date of the thirteenth column instance.
    • EffectiveStartDateThree; string; Effective start date of the third column instance.
    • EffectiveStartDateTwelve; string; Effective start date of the twelfth column instance.
    • EffectiveStartDateTwo; string; Effective start date of the second column instance.
    • InstanceIdEight; number; Unique identifier of the eighth column instance.
    • InstanceIdEleven; number; Unique identifier of the eleventh column instance.
    • InstanceIdFifteen; number; Unique identifier of the fifteenth column instance.
    • InstanceIdFive; number; Unique identifier of the fifth column instance.
    • InstanceIdFour; number; Unique identifier of the fourth column instance.
    • InstanceIdFourteen; number; Unique identifier of the fourteenth column instance.
    • InstanceIdNine; number; Unique identifier of the ninth column instance.
    • InstanceIdOne; number; Unique identifier of the first column instance.
    • InstanceIdSeven; number; Unique identifier of the seventh column instance.
    • InstanceIdSix; number; Unique identifier of the sixth column instance.
    • InstanceIdTen; number; Unique identifier of the tenth column instance.
    • InstanceIdThirteen; number; Unique identifier of the thirteenth column instance.
    • InstanceIdThree; number; Unique identifier of the third column instance.
    • InstanceIdTwelve; number; Unique identifier of the twelfth column instance.
    • InstanceIdTwo; number; Unique identifier of the second column instance.
    • RowName; string; Name of the user row.
    • UserRowId; integer; Unique identifier of user the row.
    • UserTableId; integer; Unique identifier of the user table.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : userTableDetailValues
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : userTableDetailValues-item-response
Type: object
Show Source
Back to Top