Retrieve a test case

Get detailed information about a specific test case

GET /apiKey/v3/test-targets/{testTargetId}/test-cases/{testCaseId}

Retrieve a test case

cURL

curl --request GET \
  --url https://app.octomind.dev/api/apiKey/v3/test-targets/{testTargetId}/test-cases/{testCaseId} \
  --header 'X-API-Key: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "testTargetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": "1",
  "type": "<string>",
  "elements": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "index": 123,
      "interaction": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "action": "EXTRACT",
        "calledWith": "<string>",
        "testCaseElementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "assertion": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "expectation": "VISIBLE",
        "calledWith": "<string>",
        "testCaseElementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "scrollState": {},
      "selectors": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "index": 123,
          "selector": "<string>",
          "selectorType": "TEXT",
          "options": {
            "name": "<string>"
          },
          "testCaseElementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "scrollStateId": "<string>"
        }
      ],
      "testCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ignoreFailure": true
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "status": "ENABLED",
  "externalId": "<string>",
  "entryPointUrlPath": "<string>",
  "tags": [
    "<string>"
  ],
  "createdBy": "EDIT",
  "runStatus": "ON",
  "prerequisiteId": "<string>",
  "proposalRunId": "<string>",
  "folderId": "<string>",
  "teardownTestCaseId": "<string>",
  "discovery": {
    "updatedAt": "2023-11-07T05:31:56Z",
    "freePrompt": "<string>",
    "traceUrl": "<string>",
    "status": "CREATED",
    "abortCause": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key · string · header · required

Path Parameters

testTargetId · string<uuid> · required

The ID of the test target

testCaseId · string<uuid> · required

The ID of the test case

Response

200

application/json

Test case details

id · string<uuid> · required

The ID of the test case.

testTargetId · string<uuid> · required

version · enum<string>

The version of the test case response.

Available options: 1

type · string | null

elements · object[]

Show child attributes

createdAt · string<date-time>

updatedAt · string<date-time>

description · string

status · enum<string>

Available options: ENABLED, DRAFT

externalId · string | null

entryPointUrlPath · string | null

tags · string[]

createdBy · enum<string>

Available options: EDIT

runStatus · enum<string>

Available options: ON, OFF

prerequisiteId · string | null

proposalRunId · string | null

folderId · string | null

teardownTestCaseId · string | null

discovery · object

Show child attributes