1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Positions
  4. Positions Valid Grade

Get all position valid grades

get

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

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>
  • 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
  • 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

    • AltKey Finds all the valid grades of a position that match the alternate key criteria specified.
      Finder Variables
      • EffectiveStartDate; string; Effective start date of the position to be provided when using the alternate key finder on positions valid grades.
      • GradeId; integer; Identifier of the valid grade of the position to be provided when using the alternate key finder on positions valid grades.
    • PrimaryKey Finds all the valid grades for the position that match the specified primary key criteria.
      Finder Variables
      • EffectiveEndDate; string; Effective end date of the position to be provided when using primary key finder on positions valid grades.
      • EffectiveStartDate; string; Effective start date of the position to be provided when using primary key finder on positions valid grades.
  • 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; 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.
  • 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
  • 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.
  • 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-validGrades
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : positions-validGrades-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all valid grades for a position 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/validGrades/

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": [
   {
     "EffectiveStartDate": "2017-12-11",
     "EffectiveEndDate": "4712-12-31",
     "GradeId": 300100111726081,
         "links": [
                {
				  ...}
}
Back to Top