Skip to main content
GET
/
apiKey
/
beta
/
test-targets
/
{testTargetId}
/
test-plans
/
{id}
Get test plan by ID
curl --request GET \
  --url https://app.octomind.dev/api/apiKey/beta/test-targets/{testTargetId}/test-plans/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "status": "CREATED",
  "testTargetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "context": {
    "source": "<string>",
    "repo": "<string>",
    "owner": "<string>",
    "issueNumber": 123,
    "ref": "<string>",
    "sha": "<string>",
    "triggeredBy": {
      "type": "<string>",
      "userId": "<string>"
    },
    "nodeId": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
testTargetId
string<uuid>
required

The ID of the test target

​
id
string<uuid>
required

The ID of the test plan

Response

Test plan retrieved successfully

schema for a test plan

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
createdAt
any
required
​
updatedAt
any
required
​
status
enum<string>
required
Available options:
CREATED,
IN_PROGRESS,
ERROR,
DONE
​
testTargetId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
context
object
required