Get all positions
get
/hcmRestApi/resources/11.13.18.05/positions
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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- AltKey Finds all the positions that match the alternate key criteria specified.
Finder Variables- BusinessUnitId; integer; Identifier of the business unit of the position to be provided when using the alternate key finder on the position.
- EffectiveStartDate; string; Effective start date of the position to be provided when using the alternate key finder on the position.
- PositionCode; string; Code of the position to be provided when using the alternate key finder on the position.
- PrimaryKey Finds all the positions that match the specified primary key criteria.
Finder Variables- EffectiveEndDate; string; Effective end date of the position to be provided when using the primary key finder on the position.
- EffectiveStartDate; string; Effective start date of the position to be provided when using the primary key finder on the position.
- PositionId; integer; Surrogate identifier for the position in the primary key finder.
- findByPositionId Finds all positions that match the position identifier specified.
Finder Variables- PositionId; integer; Unique identifier for the position.
- SysEffectiveDate; string;
- AltKey Finds all the positions that match the alternate key criteria specified.
-
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:- ActiveStatus; string; Status of the position such as active or inactive.
- BudgetAmount; number; Budget amount of the position.
- BudgetAmountCurrency; string; Currency of the position's budget amount currency.
- BudgetedPositionFlag; boolean; Indicates whether the position is a budgeted position. The default value is true.
- BusinessUnitId; integer; Unique identifier of the mandatory business unit for the position.
- CalculateFTE; string; Indicates whether the FTE should be calculated. The default value is true.
- CostCenter; string; Cost center of the position.
- CostCenterName; string; Name of the cost center.
- CreationDate; string; Date and time when the position record was created.
- DelegatePositionBusinessUnitId; integer; Unique identifier of the business unit of the position's delegate position.
- DelegatePositionBusinessUnitName; string; Business unit of the position's delegate position.
- DelegatePositionCode; string; Code of the position's delegate position.
- DelegatePositionId; integer; Unique identifier for the position's delegate position.
- DepartmentId; integer; Unique identifier of the mandatory department for the position.
- EffectiveEndDate; string; Effective end date of the position.
- EffectiveStartDate; string; Effective start date of the position.
- EntryGradeId; integer; Unique identifier for the position's entry grade.
- EntryStepId; integer; Unique identifier for the position's entry step.
- FTE; number; FTE of the position.
- FullPartTime; string; Indicates whether a position is full-time or part-time.
- FundedByExistingPositionFlag; boolean; Indicates whether a position is funded by existing positions. The default value is false.
- GradeLadderId; integer; Unique identifier for the position's grade ladder.
- HeadCount; integer; Head count of the position.
- HiringStatus; string; Hiring status of the position such as proposed, frozen, or approved.
- JobId; integer; Unique identifier for the position's job.
- LastUpdateDate; string; Date and time the position was updated.
- LocationId; integer; Unique identifier for the position's location.
- Name; string; Name of the position.
- OverlapAllowedFlag; boolean; Indicates whether overlap is allowed for the position. The default value is false.
- PositionCode; string; Code that uniquely references the position within the business unit.
- PositionId; integer; Surrogate identifier for the position.
- PositionType; string; Type of the position such as pooled or single.
- ProbationPeriod; number; Probation period of the position.
- RegularTemporary; string; Indicates whether a position is regular or temporary.
- SeasonalEndDate; string; Seasonal end date of the position.
- SeasonalFlag; boolean; Indicates whether the position is seasonal. The default value is false.
- SeasonalStartDate; string; Seasonal start date of the position.
- SecurityClearance; string; Security clearance of the position.
You can use these queryable attributes to filter this collection resource using the q query parameter:- EffectiveEndDate; string; Effective end date of the position's valid grades.
- EffectiveStartDate; string; Effective start date of the position's valid grades.
- GradeId; integer; Unique identifier for the position's valid grade.
-
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
-
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.
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 : positions
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 : positions-item-response
Type:
Show Source
object
-
ActiveStatus: string
Title:
Status
Maximum Length:30
Default Value:A
Status of the position such as active or inactive. -
BudgetAmount: number
Title:
Budget Amount
Budget amount of the position. -
BudgetAmountCurrency: string
Title:
Currency
Maximum Length:20
Currency of the position's budget amount currency. -
BudgetedPositionFlag: boolean
Title:
Budgeted Position
Maximum Length:1
Default Value:true
Indicates whether the position is a budgeted position. The default value is true. -
BusinessUnitId: integer
(int64)
Title:
Business Unit
Unique identifier of the mandatory business unit for the position. -
CalculateFTE: string
Title:
Calculate FTE
Maximum Length:1
Default Value:N
Indicates whether the FTE should be calculated. The default value is true. -
CostCenter: string
Title:
Cost Center
Maximum Length:30
Cost center of the position. -
CostCenterName: string
Name of the cost center.
-
CreationDate: string
(date-time)
Read Only:
true
Date and time when the position record was created. -
DelegatePositionBusinessUnitId: integer
Unique identifier of the business unit of the position's delegate position.
-
DelegatePositionBusinessUnitName: string
Business unit of the position's delegate position.
-
DelegatePositionCode: string
Code of the position's delegate position.
-
DelegatePositionId: integer
(int64)
Title:
Delegate Position
Unique identifier for the position's delegate position. -
DepartmentId: integer
(int64)
Unique identifier of the mandatory department for the position.
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date of the position. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date of the position. -
EntryGradeId: integer
(int64)
Unique identifier for the position's entry grade.
-
EntryStepId: integer
(int64)
Unique identifier for the position's entry step.
-
extraInformation: array
extraInformation
-
FTE: number
Title:
FTE
Default Value:1
FTE of the position. -
FullPartTime: string
Title:
Full Time or Part Time
Maximum Length:30
Default Value:FULL_TIME
Indicates whether a position is full-time or part-time. -
FundedByExistingPositionFlag: boolean
Title:
Funded from Existing Position
Maximum Length:1
Default Value:false
Indicates whether a position is funded by existing positions. The default value is false. -
GradeLadderId: integer
(int64)
Unique identifier for the position's grade ladder.
-
HeadCount: integer
(int32)
Title:
Head Count
Default Value:1
Head count of the position. -
HiringStatus: string
Title:
Hiring Status
Maximum Length:30
Default Value:PROPOSED
Hiring status of the position such as proposed, frozen, or approved. -
JobId: integer
(int64)
Unique identifier for the position's job.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time the position was updated. -
legislativeExtraInformation: array
legislativeExtraInformation
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Unique identifier for the position's location.
-
Name: string
Title:
Name
Maximum Length:240
Name of the position. -
OverlapAllowedFlag: boolean
Title:
Overlap Allowed
Maximum Length:30
Default Value:false
Indicates whether overlap is allowed for the position. The default value is false. -
PositionCode: string
Title:
Code
Maximum Length:30
Code that uniquely references the position within the business unit. -
PositionCustomerFlex: array
PositionCustomerFlex
Customer's flexfield for position.
-
PositionId: integer
(int64)
Surrogate identifier for the position.
-
PositionType: string
Title:
Type
Maximum Length:30
Default Value:SINGLE
Type of the position such as pooled or single. -
ProbationPeriod: number
Title:
Probation Period
Probation period of the position. -
RegularTemporary: string
Title:
Regular or Temporary
Maximum Length:30
Default Value:R
Indicates whether a position is regular or temporary. -
SeasonalEndDate: string
(date)
Title:
Seasonal End Date
Seasonal end date of the position. -
SeasonalFlag: boolean
Title:
Seasonal
Maximum Length:30
Default Value:false
Indicates whether the position is seasonal. The default value is false. -
SeasonalStartDate: string
(date)
Title:
Seasonal Start Date
Seasonal start date of the position. -
SecurityClearance: string
Title:
Security Clearance
Maximum Length:30
Security clearance of the position. -
validGrades: array
Positions Valid Grade
Title:
Positions Valid Grade
The validGrades resource is a child of the positions resource. It includes all valid grades for the position, as of the specified date.
Nested Schema : extraInformation
Type:
Show Source
array
-
Array of:
object Discriminator: CategoryCode
Discriminator:
{ "propertyName":"CategoryCode", "mapping":{ "POS_EIT":"#/components/schemas/oracle_apps_hcm_workStructures_positions_flex_positionExtraInfoDeveloperFlex_classification_view_j__PositionEitCategoryPosEitprivateVO-item-response" } }
Nested Schema : legislativeExtraInformation
Type:
Show Source
array
-
Array of:
object Discriminator: CategoryCode
Discriminator:
{ "propertyName":"CategoryCode", "mapping":{ "POS_LEG":"#/components/schemas/oracle_apps_hcm_workStructures_positions_flex_positionLegDeveloperFlex_classification_view_j__PositionLegCategoryPosLegprivateVO-item-response" } }
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Positions Valid Grade
Type:
array
Title:
Positions Valid Grade
The validGrades resource is a child of the positions resource. It includes all valid grades for the position, as of the specified date.
Show Source
Nested Schema : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_workStructures_positions_flex_positionExtraInfoDeveloperFlex_classification_view_j__PositionEitCategoryPosEitprivateVO-item-response
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
80
Default Value:POS_EIT
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PositionId: integer
(int64)
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.
Nested Schema : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_workStructures_positions_flex_positionLegDeveloperFlex_classification_view_j__PositionLegCategoryPosLegprivateVO-item-response
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
80
Default Value:POS_LEG
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PositionId: integer
(int64)
-
PositionLegDeveloperFlexORA_5FHRX_5FBR_5FPOSITIONprivateVO: array
PositionLegDeveloperFlexORA_5FHRX_5FBR_5FPOSITIONprivateVO
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : positions-legislativeExtraInformation-PositionLegDeveloperFlexORA_5FHRX_5FBR_5FPOSITIONprivateVO-item-response
Type:
Show Source
object
-
_ORA_HRX_BR_POS_CBO: string
Title:
CBO Occupation
Maximum Length:150
-
_ORA_HRX_BR_POS_CBO_Display: string
Title:
CBO Occupation
-
ActionOccurrenceId: integer
(int64)
Default Value:
0
-
AttributeCategory: string
Maximum Length:
30
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
InformationCategory: string
Maximum Length:
30
Default Value:ORA_HRX_BR_POSITION
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
LegislationCode: string
Maximum Length:
30
Default Value:US
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
-
PositionId: integer
(int64)
-
PositionLegId: integer
(int64)
-
SequenceNumber: integer
(int32)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : positions-PositionCustomerFlex-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PositionId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : positions-validGrades-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Effective end date of the position's valid grades.
-
EffectiveStartDate: string
(date)
Effective start date of the position's valid grades.
-
GradeId: integer
(int64)
Unique identifier for the position's valid grade.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all the positions by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/positions
Example of Response Header
The following shows an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [25] 0: { "PositionId": 300100008883956 "EffectiveStartDate": "2007-01-01" "EffectiveEndDate": "4712-12-31" "BusinessUnitId": 204 "PositionCode": "WFMTLPJC Analyst" "Name": "WFMTLPJC Analyst" "DepartmentId": 5186 "JobId": 300100003260494 "LocationId": 18627 "RegularTemporary": "R" "FTE": 1 "HiringStatus": "PROPOSED" "FullPartTime": "FULL_TIME" "PositionType": "POOLED" "HeadCount": 1 "OverlapAllowedFlag": false "SeasonalFlag": false "SeasonalStartDate": null "SeasonalEndDate": null "ProbationPeriod": null "SecurityClearance": null "CreationDate": "2012-04-26T03:14:14-07:00" "LastUpdateDate": "2012-04-26T03:17:35-07:00" "links": [7] 0: { ...} } 1: { "PositionId": 300100008883966 "EffectiveStartDate": "2007-01-01" "EffectiveEndDate": "4712-12-31" "BusinessUnitId": 204 "PositionCode": "WFMTLPJC Manager" "Name": "WFMTLPJC Manager" "DepartmentId": 207 "JobId": 300100003304841 "LocationId": 20795 "RegularTemporary": "R" "FTE": 1 "HiringStatus": "PROPOSED" "FullPartTime": "FULL_TIME" "PositionType": "POOLED" "HeadCount": 1 "OverlapAllowedFlag": false "SeasonalFlag": false "SeasonalStartDate": null "SeasonalEndDate": null "ProbationPeriod": null "SecurityClearance": null "CreationDate": "2012-04-26T03:17:48-07:00" "LastUpdateDate": "2012-04-26T03:30:49-07:00" "links": [7] 0: { ...} }