Retrieve Actions

To retrieve the actions that can be performed on the workers API:

1. Perform a GET operation on the actionsLOV resource using a query parameter.
2. Verify the details returned in the response.

Example URL

Use this resource URL format.

GET

Example Header

Provide the header.

REST-Framework-Version : 4

/hcmRestApi/resources/11.13.18.05/actionsLOV?q=ActionName like '%Worker%'

Example Response

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "ActionId": 100010026278068,
            "ActionCode": "ADD_CWK",
            "ActionName": "Add Contingent Worker",
            "Description": "Add Contingent Worker",
            "StartDate": "1900-01-01",
            "EndDate": "4712-12-31",
            "ActionTypeId": 100000011609002,
            "ActionTypeCode": "EMPL_ADD_CWK",
            "links": [...]
        },
        {
            "ActionId": 100010026278050,
            "ActionCode": "ADD_NON_WKR",
            "ActionName": "Add Non-Worker",
            "Description": "Add Non-Worker",
            "StartDate": "1900-01-01",
            "EndDate": "4712-12-31",
            "ActionTypeId": 100000011609006,
            "ActionTypeCode": "EMPL_ADD_NWK",
            "links": [...]
        },
        {
            "ActionId": 100010026278029,
            "ActionCode": "ADD_PEN_WKR",
            "ActionName": "Add Pending Worker",
            "Description": "Add Pending Worker",
            "StartDate": "1900-01-01",
            "EndDate": "4712-12-31",
            "ActionTypeId": 100000011609008,
            "ActionTypeCode": "EMPL_ADD_PWK",
            "links": [...]
        },
        {
            "ActionId": 100010026278065,
            "ActionCode": "REN_CWK",
            "ActionName": "Renew Contingent Worker",
            "Description": "Renew Contingent Worker",
            "StartDate": "1900-01-01",
            "EndDate": "4712-12-31",
            "ActionTypeId": 100000011609010,
            "ActionTypeCode": "EMPL_RENEW_CWK",
            "links": [...]
        },
        {
            "ActionId": 100010026278017,
            "ActionCode": "ADD_NON_WKR_WORK_RELATION",
            "ActionName": "Add Non-Worker Work Relationship",
            "Description": "Add Non-Worker Work Relationship",
            "StartDate": "1900-01-01",
            "EndDate": "4712-12-31",
            "ActionTypeId": 100000011609007,
            "ActionTypeCode": "EMPL_WR_NWK",
            "links": [...]
        }
    ]
}