Get action(s)

This GET operation retrieves a list of actions or a specific action (if you pass the actionId as a URL parameter or name as a query parameter). If successful, you receive an HTTP response code of 200 as well as a JSON response body containing the action information.


GET /pcc/spcm/actions/<actionId>

or

GET /pcc/spcm/actions?name=<actionName>


HEADER INFO

authorisation: HTTP Basic Auth

tenant: <tenantName>

content-type: application/JSON

accept: application/JSON

By default, accept is XML. You must explicitly set accept in your header to application/JSON to receive a JSON response.

permissions: SPCM_CATALOG_READ_PERMISSION

URL parameters

There is one optional parameter.

Parameter Type Description

actionId

integer

The id of the action.

Query parameters

You can retrieve actions by using the following query parameters.

Parameter Type Description

name

string

The name of the action.


JSON response

The following shows the response for retrieving a plan definition catalog with the id of 42.

If you GET all actions, you will see them listed as an array in the JSON response.
{
    "id": 42,
    "name": "Send Fair Usage Exceeded Sms",
    "_links": {
        "self": {
        "href": "http://localhost:8080/spcm-rest-ws/pcc/spcm/actions/42"
        }
    }
}


HTTP response codes

Code Description

200

success!

403

forbidden; user does not have appropriate privileges

404

action catalog not found

500

internal SPCM error

503

request rejected due to overload