Skip to main content
POST
/
apiKey
/
beta
/
test-targets
/
{testTargetId}
/
code
Retrieve the typescript code in a zip file for a set of yaml based test cases. This code can then be executed by playwright.
curl --request POST \
  --url https://app.octomind.dev/api/apiKey/beta/test-targets/{testTargetId}/code \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "executionUrl": "<string>",
  "testCases": [
    {
      "version": "1",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tagNames": [
        "<string>"
      ],
      "runStatus": "OFF",
      "elements": [
        {
          "selectors": [
            {
              "selectorType": "FRAME",
              "selector": "<string>",
              "options": {
                "name": "<string>",
                "exact": true,
                "checked": true,
                "disabled": true,
                "expanded": true,
                "includeHidden": true,
                "level": 123,
                "pressed": true,
                "selected": true,
                "hasText": "<string>",
                "hasNotText": "<string>"
              }
            }
          ],
          "interaction": {
            "action": "CLICK",
            "calledWith": {
              "button": "right",
              "double": true,
              "force": true
            }
          },
          "assertion": {
            "expectation": "VISIBLE",
            "calledWith": "<unknown>"
          },
          "ignoreFailure": true
        }
      ],
      "description": "<string>",
      "prompt": "<string>",
      "type": "LOGIN",
      "dependencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teardownId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entryPointUrlPath": "<string>",
      "folderName": "<string>",
      "externalId": "<string>"
    }
  ],
  "environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
"<string>"

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
testTargetId
string<uuid>
required

The ID of the test target

Body

application/json

schema for export of test cases as code

​
executionUrl
string<uri>
required
​
testCases
object[]
required
​
environmentId
string<uuid>

Response

Test target code retrieved successfully

The response is of type file.