Get all plan options
get
/hcmRestApi/resources/11.13.18.05/eligibleOptionsLOV
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 eligible options of an eligible individual compensation plan that match the specified primary key criteria.
Finder Variables- ComponentId; integer; Unique identifier of the individual compensation plan option.
- findByWord Finds all eligible options of an eligible individual compensation plan that match the specified criteria.
Finder Variables- AssignmentId; integer; Unique identifier of the assignment
- EffectiveDate; string; Effective date to be used.
- FilterAttributes; string; Attributes used to filter the individual compensation plan, such as ComponentName.
- LegalEntityId; string; Unique identifier of the legal entity.
- PersonId; integer; Unique identifier of the person.
- PlanId; integer; Unique identifier of the individual compensation plan.
- SearchTerms; string; User-entered term in the individual compensation option field, such as Quarterly.
- PrimaryKey Finds all eligible options of an eligible individual compensation plan 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:- AssignmentId; integer; Unique identifier for the assignment.
- AssignmentNumber; string; Assignment number for the specified assignment.
- ComponentId; integer; Unique identifier for the individual compensation plan option.
- ComponentName; string; Name of the option, such as Quarterly Spot Bonus Award.
- DocumentTypeId; integer; Unique identifier of the document type linked to the individual compensation plan option.
- EffectiveDate; string; Date used to find the eligible plans that are in effect.
- ElementTypeId; integer; Unique identifier for the payroll element linked to the individual compensation plan option.
- EndDate; string; Latest date allowed, such as the payroll element eligibility end date or 31-Dec-4712
- EndDateCode; string; Payment end date code, such as Specified date.
- EndDateRule; integer; Indicates that the end date can be overridden.
- GrantType; string; Code for the stock grant type.
- InputCurrencyCode; string; Input currency code of the payroll element linked to the individual compensation plan option.
- LegalEntityId; integer; Unique identifier for the legal entity
- MultipleEntriesAllowedFlag; boolean; Indicates whether multiple entries of the same payroll element are allowed. The default value is No.
- NonMonetaryUOM; string; Code of the unit of measurement when the data type of the primary input value isn't money.
- PeriodId; integer; Unique identifier for the period of the budget pool linked to the individual compensation plan option.
- PersonId; integer; Unique identifier for the person.
- PlanId; integer; Unique identifier for the individual compensation plan.
- PoolIdToConsume; integer; Unique identifier for the budget pool linked to the individual compensation plan option.
- ProcessingType; string; Processing type of the option, such as Recurring or Nonrecurring.
- RequiresAttachment; string; Indicates that an attachment is required for submission.
- StartDate; string; Earliest date allowed. For example, when the Start Date Code is User Entered Date, the Start Date shows the current date or the effective date selected in the When section.
- StartDateCode; string; Payment start date code, such as User chooses date.
- StartDateRule; integer; Indicates that the start date can be overridden.
- TradingSymbol; string; Trading symbol for the share type of the nonmonetary option.
-
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 : eligibleOptionsLOV
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 : eligibleOptionsLOV-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Read Only:
true
Unique identifier for the assignment. -
AssignmentNumber: string
Read Only:
true
Maximum Length:50
Assignment number for the specified assignment. -
ComponentId: integer
(int64)
Read Only:
true
Unique identifier for the individual compensation plan option. -
ComponentName: string
Read Only:
true
Maximum Length:80
Name of the option, such as Quarterly Spot Bonus Award. -
DocumentTypeId: integer
(int64)
Read Only:
true
Unique identifier of the document type linked to the individual compensation plan option. -
EffectiveDate: string
(date)
Read Only:
true
Date used to find the eligible plans that are in effect. -
ElementTypeId: integer
(int64)
Read Only:
true
Unique identifier for the payroll element linked to the individual compensation plan option. -
EndDate: string
(date)
Read Only:
true
Latest date allowed, such as the payroll element eligibility end date or 31-Dec-4712 -
EndDateCode: string
Read Only:
true
Maximum Length:30
Payment end date code, such as Specified date. -
EndDateRule: integer
(int64)
Read Only:
true
Indicates that the end date can be overridden. -
GrantType: string
Read Only:
true
Maximum Length:30
Code for the stock grant type. -
InputCurrencyCode: string
Read Only:
true
Maximum Length:15
Input currency code of the payroll element linked to the individual compensation plan option. -
LegalEntityId: integer
(int64)
Read Only:
true
Unique identifier for the legal entity -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MultipleEntriesAllowedFlag: boolean
Read Only:
true
Maximum Length:30
Indicates whether multiple entries of the same payroll element are allowed. The default value is No. -
NonMonetaryUOM: string
Read Only:
true
Maximum Length:30
Code of the unit of measurement when the data type of the primary input value isn't money. -
PeriodId: integer
(int64)
Read Only:
true
Unique identifier for the period of the budget pool linked to the individual compensation plan option. -
PersonId: integer
(int64)
Read Only:
true
Unique identifier for the person. -
PlanId: integer
(int64)
Read Only:
true
Unique identifier for the individual compensation plan. -
PoolIdToConsume: integer
(int64)
Read Only:
true
Unique identifier for the budget pool linked to the individual compensation plan option. -
ProcessingType: string
Read Only:
true
Maximum Length:30
Processing type of the option, such as Recurring or Nonrecurring. -
RequiresAttachment: string
Read Only:
true
Maximum Length:1
Indicates that an attachment is required for submission. -
StartDate: string
(date)
Read Only:
true
Earliest date allowed. For example, when the Start Date Code is User Entered Date, the Start Date shows the current date or the effective date selected in the When section. -
StartDateCode: string
Read Only:
true
Maximum Length:30
Payment start date code, such as User chooses date. -
StartDateRule: integer
(int64)
Read Only:
true
Indicates that the start date can be overridden. -
TradingSymbol: string
Read Only:
true
Maximum Length:30
Trading symbol for the share type of the nonmonetary option.
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.