1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Positions
  4. Position Extra Information

Get all flexfields

get

/hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/extraInformation

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Positions resource and used to uniquely identify an instance of Positions. The client should not generate the hash key value. Instead, the client should query on the Positions collection resource in order to navigate to a specific instance of Positions to get the hash key.
Query Parameters
  • 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>
  • 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
      Finder Variables:
      • PositionId
  • 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:
    • ActiveStatus; string; Indicates if a position is active or inactive.
    • BudgetAmount; number; Budget Amount for the Position.
    • BudgetAmountCurrency; string; Currency in which Budget Amount is measured.
    • BudgetedPositionFlag; boolean; Flag to indicate whether this is a Budgeted Position.
    • BusinessUnitId; integer; Foreign key to HRW_BUSINESS_UNITS table.
    • CalculateFTE; string; Indicates whether FTE should be calculated for this position.
    • CostCenter; string; Cost Center for the position.
    • CostCenterName; string; Cost Center Name of the position.
    • CreationDate; string
    • DelegatePositionBusinessUnitId; integer; Business Unit Id of Delegate Position.
    • DelegatePositionBusinessUnitName; string; Business Unit Name of Delegate Position.
    • DelegatePositionCode; string; Code of Delegate Position.
    • DelegatePositionId; integer; Position to which duties and resposibilities of the current position will be delegated when the current position is away.
    • DepartmentId; integer; Foreign Key to HR_ALL_ORGANIZATION_UNITS_F
    • EffectiveEndDate; string; Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
    • EffectiveStartDate; string; Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
    • EntryGradeId; integer; Identifier of the entry grade.
    • EntryStepId; integer; Identifier of the entry step.
    • FTE; number; Position full time equivalent.
    • FullPartTime; string; Indicates if a position is full-time or part-time.
    • FundedByExistingPositionFlag; boolean; Flag to indicate whether this position is funded by existing positions.
    • GradeLadderId; integer; Foreign Key to PER_GRADE_LADDERS_F
    • HeadCount; integer; Position headcount.
    • HiringStatus; string; Indicates the hiring status of the position, for example approved or frozen.
    • JobId; integer; Foreign Key to PER_JOBS_F table.
    • LastUpdateDate; string
    • LocationId; integer; Foreign Key to PER_LOCATIONS table.
    • Name; string; Denotes the translated name of the position.
    • OverlapAllowedFlag; boolean; Indicates if overlap is allowed.
    • PositionCode; string; Code of the position.
    • PositionId; integer; System generated primary key column.
    • PositionType; string; Indicates the type of the position for example pooled or single.
    • ProbationPeriod; number; Number of the probation period.
    • RegularTemporary; string; Indicates if a position is regular or temporary.
    • SeasonalEndDate; string; Seasonal end date.
    • SeasonalFlag; boolean; Indicates if a position is seasonal.
    • SeasonalStartDate; string; Seasonal start date.
    • SecurityClearance; string; Indicates the security clearance of a position.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • EffectiveEndDate; string; Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
    • EffectiveStartDate; string; Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
    • GradeId; integer; Foreign Key to PER_GRADES_F 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 : positions-extraInformation
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
  • 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 : 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: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Back to Top

Examples

The following example shows how to retrieve all position extra information flexfields 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/00020000000EACED00057708000110F0808E76AE0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001604805600078/child/extraInformation"

Example of Response Header

The following is 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": [
    {
      "PositionId": 300100111726254,
      "CategoryCode": "POS_EIT",
          "links": [
                {
				  ...}
}
Back to Top