Get all actions
get
/hcmRestApi/resources/11.13.18.05/actionsLOV
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 actions that match the primary key criteria specified.
Finder Variables- ActionId; integer; Identifier for the action.
- findActionsByUsedInContract Indicates whether the action is used in contract.
Finder Variables- BusinessGroupId; integer; Unique identifier for the business group.
- findByActionTypeCode Finds all the action types that match the specified criteria.
Finder Variables- ActionTypeCode; string; Code for the action type.
- Country; string; Search for action type code for assignment based on the country.
- EffectiveDate; string; Search for action type code for change assignment is based on effective date.
- FilterAttributes; string; Filter attributes for the search criteria find by action type code.
- SearchTerms; string; Search for action type code for type assignment based on search terms.
- findByActionTypeCodeForChangeAsg Search for action type code for change assignment based on the search terms.
Finder Variables- Country; string; Search for action type code for assignment based on the country.
- EffectiveDate; string; Search for action type code for change assignment is based on effective date.
- FilterAttributes; string; Filter attributes for the search criteria find by action type code.
- FilterEndAssignment; string; Search for action type code for assignment based on filter end assignment.
- FilterEndTempAssignment; string; Search for action type code for change assignment based on the filter end temporary assignment.
- FilterGlbTempAssignment; string; Search for action type code for change assignment based on the filter global temporary assignment.
- SearchTerms; string; Search term criteria to find action type list.
- findByActionTypeList Finds all the action types that match the specified criteria.
Finder Variables- ActionTypeCode; string; Filter attributes for the search criteria find by action type code.
- Country; string; Name of the country.
- EffectiveDate; string; Effective date for the search criteria.
- FilterAttributes; string; Filter attributes for the search criteria find by action type list.
- SearchTerms; string; Search term criteria to find action type list.
- TerminationType; string; Type of termination for the assignment.
- PrimaryKey Finds all the actions that match the primary 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:- ActionCode; string; Code for the action.
- ActionId; integer; Unique identifier for the action.
- ActionName; string; Name of the action.
- ActionTypeCode; string; Code of the action type.
- ActionTypeId; integer; Unique identifier for the action type.
- EndDate; string; Date and time when the action ended.
- StartDate; string; Date and time when the action started.
- TerminationType; string; Type of termination.
- UsedInContract; string; Indicates whether the action is used in contract.
-
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 : actionsLOV
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 : actionsLOV-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Read Only:true
Maximum Length:30
Code for the action. -
ActionId: integer
(int64)
Title:
Action
Read Only:true
Unique identifier for the action. -
ActionName: string
Title:
Action Name
Read Only:true
Maximum Length:80
Name of the action. -
ActionTypeCode: string
Title:
Action Type Code
Read Only:true
Maximum Length:30
Code of the action type. -
ActionTypeId: integer
(int64)
Title:
Action Type
Read Only:true
Unique identifier for the action type. -
Description: string
Title:
Description
Read Only:true
Maximum Length:2000
Description of the action. -
EndDate: string
(date)
Title:
End Date
Read Only:true
Date and time when the action ended. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
Date and time when the action started. -
TerminationType: string
Title:
Termination Type
Read Only:true
Maximum Length:150
Type of termination. -
UsedInContract: string
Title:
Used in Contract
Read Only:true
Maximum Length:30
Indicates whether the action is used in contract.
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.
Examples
The following example shows how to retrieve all the actions by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4""-X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/actionsLOV"
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "ActionId": 100010026278062, "ActionCode": "CHANGE_SALARY", "ActionName": "Change Salary", "Description": "Change Salary", "StartDate": "2008-01-01", "EndDate": "2012-12-31", "ActionTypeId": 100000011609053, "ActionTypeCode": "CHANGE_SALARY", "links": [2] { ...} ] }, { "ActionId": 100100065995742, "ActionCode": "CMP_CHANGE_SALARY", "ActionName": "Salary Change", "Description": "Salary Change", "StartDate": "1951-01-01", "EndDate": "4712-12-31", "ActionTypeId": 100000014992001, "ActionTypeCode": "CMP_CHANGE_SALARY", "links": [2] { ...} ] }, { "ActionId": 100100039496769, "ActionCode": "CMP_GRADE_STEP_PROGRESSION", "ActionName": "Automated Grade Step Progression", "Description": "Automated Grade Step Progression", "StartDate": "0001-01-01", "EndDate": "4712-12-31", "ActionTypeId": 300100070836849, "ActionTypeCode": "CMP_GRADE_STEP_PROGRESSION", "links": [2] { ...} ] }, { "ActionId": 100100039496771, "ActionCode": "CMP_GSP_UPD_SAL_ON_ASG_CHG", "ActionName": "Grade Step Change", "Description": "Grade Step Change", "StartDate": "0001-01-01", "EndDate": "4712-12-31", "ActionTypeId": 300100070836849, "ActionTypeCode": "CMP_GRADE_STEP_PROGRESSION", "links": [2] { ...} } ] }