Get all positions
get
/hcmRestApi/resources/11.13.18.05/positionsLovV2
Request
Query Parameters
-
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 -
finder: string
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 positions that match the specified primary key criteria.
Finder Variables- EffectiveEndDate; string; Date at the end of the period within which the position is effective.
- EffectiveStartDate; string; Date at the beginning of the period within which the position is effective.
- PositionId; integer; Unique identifier for the position.
- findByPositionId Finds all the positions that match the specified position identifier.
Finder Variables- EffectiveDate; string; Date from which the position is effective.
- PositionId; integer; Unique identifier for the position.
- findByWord Finds all the positions that match the specified search terms.
Finder Variables- ActiveStatus; string; Status of the position.
- BusinessGroupId; integer; Unique identifier for the business group.
- BusinessUnitId; integer; Unique identifier for the business unit.
- EffectiveDate; string; Date from when the position is effective.
- FilterAttributes; string; Attributes for the search terms.
- HiringStatus; string; Hiring status of the position such as proposed, frozen, or approved.
- SearchTerms; string; Search term criteria to retrieve data.
- TypeCode; string; Code of the position type such as single, shared, pooled, or none.
- PrimaryKey Finds all the positions that match the specified primary key criteria.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- BusinessUnitName; string; Name of the business unit associated with the position.
- DepartmentName; string; Name of the department associated with the position.
- DisplayName; string; Name of the incumbent associated with the position.
- EffectiveEndDate; string; Date at the end of the period within which the position is effective.
- EffectiveStartDate; string; Date at the beginning of the period within which the position is effective.
- FullName; string; Full name of the incumbent associated with the position.
- HiringStatus; string; Hiring status of the position such as proposed, frozen, or approved.
- JobCode; string; Code of the job associated with the position.
- JobName; string; Name of the job associated with the position.
- LocationCode; string; Unique code of the location associated with the position.
- LocationName; string; Name of the location associated with the position.
- ParentPositionCode; string; Code of the parent position associated with the position.
- ParentPositionName; string; Name of the parent position associated with the position.
- PersonNumber; string; Unique Identifier for the person.
- PositionCode; string; Unique code for the position within the business unit.
- PositionId; integer; Unique identifier for the position.
- PositionName; string; Name of the position.
-
totalResults: boolean
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
-
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 : positionsLovV2
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : positionsLovV2-item-response
Type:
Show Source
object
-
BusinessUnitName: string
Title:
Business Unit
Name of the business unit associated with the position. -
DepartmentName: string
Title:
Department
Name of the department associated with the position. -
DisplayName: string
Title:
Incumbent Name
Name of the incumbent associated with the position. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the period within which the position is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the period within which the position is effective. -
FullName: string
Title:
Incumbent Full Name
Full name of the incumbent associated with the position. -
HiringStatus: string
Title:
Hiring Status
Hiring status of the position such as proposed, frozen, or approved. -
JobCode: string
Title:
Job Code
Code of the job associated with the position. -
JobName: string
Title:
Job
Name of the job associated with the position. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Title:
Location Code
Unique code of the location associated with the position. -
LocationName: string
Title:
Location
Name of the location associated with the position. -
ParentPositionCode: string
Title:
Parent Position Code
Code of the parent position associated with the position. -
ParentPositionName: string
Title:
Parent Position
Name of the parent position associated with the position. -
PersonNumber: string
Title:
Person Number
Unique Identifier for the person. -
PositionCode: string
Title:
Code
Unique code for the position within the business unit. -
PositionId: integer
Title:
Position ID
Unique identifier for the position. -
PositionName: string
Title:
Name
Name of the position.
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.