Read the installed workflow schema and authoring contract

GET

https://studio.runautomat.com/api/v1/schema

GET

/api/v1/schema

curl https://studio.runautomat.com/api/v1/schema \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "schema": {},
  "authoringContract": {
    "block": {
      "parameters": [
        "string"
      ],
      "runtimeLib": true,
      "transpilesTypeScript": true,
      "async": true,
      "notes": [
        "string"
      ]
    },
    "helper": {
      "parameters": [
        "string"
      ],
      "runtimeLib": true,
      "transpilesTypeScript": true,
      "async": true,
      "notes": [
        "string"
      ]
    },
    "decision": {
      "parameters": [
        "string"
      ],
      "runtimeLib": true,
      "transpilesTypeScript": true,
      "async": true,
      "notes": [
        "string"
      ]
    },
    "executeInput": {
      "parameters": [
        "string"
      ],
      "runtimeLib": true,
      "transpilesTypeScript": true,
      "async": true,
      "notes": [
        "string"
      ]
    },
    "documentExpression": {
      "parameters": [
        "string"
      ],
      "runtimeLib": true,
      "transpilesTypeScript": true,
      "async": true,
      "notes": [
        "string"
      ]
    },
    "hitlTemplate": {
      "parameters": [
        "string"
      ],
      "runtimeLib": true,
      "transpilesTypeScript": true,
      "async": true,
      "notes": [
        "string"
      ]
    },
    "selfHealVerify": {
      "parameters": [
        "string"
      ],
      "runtimeLib": true,
      "transpilesTypeScript": true,
      "async": true,
      "notes": [
        "string"
      ]
    }
  },
  "schemaPackageVersion": "string",
  "requestedRuntimeVersion": "string"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

runtimeVersionstringOptional

Response

Declared primary response

schemamap from strings to any

authoringContractobject

schemaPackageVersionstring

requestedRuntimeVersionstringOptional