Get an Action by BDD

get

/action/bdd/{bdd}

Retrieves the action by its BDD.

Request

Path Parameters
Back to Top

Response

200 Response

The action was retrieved successfully.

404 Response

The action was not found.
Back to Top

Examples

The following example shows how to retrieve details of an action by its BDD 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/bdd/add todo task" -H "accept: */*"

Example of Response Body

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

{
  "_id": 180,
  "bdd": "add todo task",
  "name": "Add one todo task",
  "path": "TodoApp/add-todo-tasks/add-one-todo-task",
  "tags": [
    "todo",
    "read"
  ],
  "method": "POST",
  "product": "todo",
  "request": "add-one-todo-task.request.json",
  "subType": "REST",
  "resource": "todo",
  "actionType": "API",
  "description": "Add one todo task",
  "requestType": "FILE",
  "requestString": "{    \"name\" : \"Run automation\",    \"description\" : \"Run automation from main environment\"}",
  "queryParameters": null,
  "expectedStatusCode": 200
}

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