Jump to

• Request
• Response
• Examples

Get a List of Actions

get

/action

Retrieves the list of actions.

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

The list of actions was retrieved successfully.

Back to Top

Examples

The following example shows how to retrieve a list of all actions by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

curl -X GET "hostname:port/action" -H "accept: */*"

Example of Response Body

If successful, the response code 200 is returned with a response body. For example:

{
  "total": 91,
  "limit": 10,
  "offset": 0,
  "page": 1,
  "pages": 10,
  "docs": [
    {
      "_id": 1,
      "bdd": "process json",
      "data": {
        "method": "GET",
        "resource": "todo",
        "expectedStatusCode": "200"
      },
      "name": "process json",
      "path": "STAP/JSON/process-json",
      "tags": [
        "todo",
        "read"
      ],
      "product": "JSON",
      "actionType": "REST",
      "description": "JSON Processing"
    },
    {
      "_id": 2,
      "bdd": "set variable",
      "data": {
        "method": "GET",
        "resource": "dummy",
        "expectedStatusCode": "0"
      },
      "name": "set variable",
      "path": "STAP/JSON/set-variable",
      "tags": [
        "dummy"
      ],
      "product": "system",
      "actionType": "REST",
      "description": "set variable"
    },
    {
      "_id": 3,
      "bdd": "validate promotion structure on Launch",
      "data": {
        "method": "GET",
        "resource": "productOffering/",
        "expectedStatusCode": "200"
      },
      "name": "validate promotion structure on Launch",
      "path": "launch/",
      "tags": [
        "validate",
        "promotion",
        "structure",
        "launch"
      ],
      "product": "launch_expanded",
      "actionType": "REST",
      "description": "validate promotion structure on Launch"
    },
    {
      "_id": 4,
      "bdd": "Get initiative for product model",
      "data": {
        "method": "GET",
        "resource": "project/",
        "expectedStatusCode": "200"
      },
      "name": "Get initiative for product model",
      "path": "launch/",
      "tags": [
        "validate",
        "promotion",
        "id",
        "publish",
        "launch"
      ],
      "product": "launch-project",
      "actionType": "REST",
      "description": "Get initiative for product model"
    },
    {
      "_id": 5,
      "bdd": "publish the initiative by id",
      "data": {
        "method": "POST",
        "request": "publish-initiative.request.json",
        "resource": "publishJob",
        "requestType": "REQUEST",
        "requestString": "{    \"projectId\": \"${projectID}\"}",
        "expectedStatusCode": "201"
      },
      "name": "publish the initiative by id",
      "path": "launch/",
      "tags": [
        "publish",
        "initiative",
        "id"
      ],
      "product": "launch-publish",
      "actionType": "REST",
      "description": "publish the initiative by id"
    },
    {
      "_id": 6,
      "bdd": "verify the import job status by id",
      "data": {
        "method": "GET",
        "resource": "importJob/",
        "expectedStatusCode": "200"
      },
      "name": "verify the import job status by id",
      "path": "launch/",
      "tags": [
        "import",
        "job",
        "status",
        "id"
      ],
      "product": "launch",
      "actionType": "REST",
      "description": "verify the import job status by id"
    },
    {
      "_id": 7,
      "bdd": "create an import job for product model",
      "data": {
        "method": "POST_MEDIA",
        "resource": "importJob",
        "expectedStatusCode": "201"
      },
      "name": "create an import job for product model",
      "path": "launch/",
      "tags": [
        "create",
        "import",
        "job",
        "product",
        "model"
      ],
      "product": "launch",
      "actionType": "REST",
      "description": "create an import job for product model"
    },
    {
      "_id": 8,
      "bdd": "validate the job status for siebel and pdc",
      "data": {
        "method": "GET",
        "resource": "PublishingAPI/publishJob?id=",
        "expectedStatusCode": "200"
      },
      "name": "validate the job status for siebel and pdc",
      "path": "launch/",
      "tags": [
        "validate",
        "job",
        "status",
        "siebel",
        "pdc"
      ],
      "product": "launch-lifecyclestatus",
      "actionType": "REST",
      "description": "validate the job status for siebel and pdc"
    },
    {
      "_id": 9,
      "bdd": "validate the lifecycle status of the job",
      "data": {
        "method": "GET",
        "resource": "PublishingAPI/publishJob?id=",
        "expectedStatusCode": "200"
      },
      "name": "validate the lifecycle status of the job",
      "path": "launch/",
      "tags": [
        "validate",
        "lifecycle",
        "status"
      ],
      "product": "launch-lifecyclestatus",
      "actionType": "REST",
      "description": "validate the lifecycle status of the job"
    },
    {
      "_id": 10,
      "bdd": "change the job status",
      "data": {
        "method": "PATCH",
        "request": "import-job-status-change.request.json",
        "resource": "project/",
        "requestType": "REQUEST",
        "requestString": "{       \"id\": \"${projectID}\",    \"lifecycleStatus\": \"${modelLifecycleStatus}\"   }",
        "expectedStatusCode": "200"
      },
      "name": "change the job status",
      "path": "launch/",
      "tags": [
        "change",
        "job",
        "status"
      ],
      "product": "launch-project",
      "actionType": "REST",
      "description": "change the job status"
    }
  ]
}

If the request fails, the response includes the appropriate HTTP code. For a 4xx/5xx code, the message body also contains a ProblemDetails structure with the cause attribute set to the appropriate application error.

Back to Top