Skip to main content
GET
/
api
/
v1
/
v-ciso
/
organizations
/
{organizationid}
/
workflows
/
{workflowid}
/
framework
/
spec
JSON spec for a framework's controls
curl --request GET \
  --url https://app.aegister.com/api/v1/v-ciso/organizations/{organizationid}/workflows/{workflowid}/framework/spec \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": "<array>",
  "data": {
    "kind": "framework",
    "framework": {
      "id": "<string>",
      "name": {
        "en": "<string>",
        "it": "<string>"
      }
    },
    "steps": [
      {}
    ],
    "controls": [
      {
        "id": "<string>",
        "label": {
          "en": "<string>",
          "it": "<string>"
        },
        "description": {
          "en": "<string>",
          "it": "<string>"
        },
        "type": "<string>",
        "multiple": true,
        "required": true,
        "custom": true,
        "choices": [
          {
            "value": "<string>",
            "label": {
              "en": "<string>",
              "it": "<string>"
            }
          }
        ],
        "format": {},
        "evidence": true,
        "step": "<string>",
        "subframework": "<string>",
        "category": {
          "en": "<string>",
          "it": "<string>"
        },
        "weight": 123
      }
    ]
  }
}

Authorizations

​
X-Aegister-Token
string
header
required

Path Parameters

​
organizationid
integer
required
​
workflowid
string
required

Query Parameters

​
lan
string

Language for labels/validation (en|it).

​
step
string

Restrict to a single framework step id.

Response

​
error
integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0
Example:

0

​
messages
array

If error is 1, contains zero or more details on the error.

Example:
[]
​
data
object