Metadata

Adds a category to the specified playbook metadata.

post

Adds a category to the specified playbook metadata.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the playbook metadata.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

optionIdentifierstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/metadata/{objectIdentifier}/categories

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/metadata/{objectIdentifier}/categories HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "optionIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "isYes": true,
  "text": "text",
  "decimalValue": 1,
  "date": "2025-12-06T04:07:52.004Z",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "name": "text",
    "description": "text",
    "dataType": "text",
    "isRequired": true,
    "options": [
      {
        "name": "text",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Gets all metadata entries for the specified playbook.

get

Retrieves a paginated list of all metadata entries for the specified playbook, with optional search and sorting.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number for paginated results.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter results.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/metadata

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/metadata HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "isYes": true,
    "text": "text",
    "decimalValue": 1,
    "date": "2025-12-06T04:07:52.004Z",
    "categories": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "name": "text",
      "description": "text",
      "dataType": "text",
      "isRequired": true,
      "options": [
        {
          "name": "text",
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
]

Creates a new metadata entry for the specified playbook.

post

Creates a new metadata entry for the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

isYesboolean | nullableOptional

decimalValuenumber · double | nullableOptional

textstring | nullableOptional

datestring · date-time | nullableOptional

singleCategoryIdentifierstring · uuid | nullableOptional

categoriesstring · uuid[] | nullableOptional

organizationMetadataIdentifierstring · uuidOptional

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/metadata

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/metadata HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "isYes": true,
  "decimalValue": 1,
  "text": "text",
  "date": "2025-12-06T04:07:52.004Z",
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "isYes": true,
  "text": "text",
  "decimalValue": 1,
  "date": "2025-12-06T04:07:52.004Z",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "name": "text",
    "description": "text",
    "dataType": "text",
    "isRequired": true,
    "options": [
      {
        "name": "text",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Gets the details of a specific playbook metadata entry by its object identifier.

get

Retrieves the details of a playbook metadata entry using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the metadata entry.

playbookIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/metadata/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/metadata/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "isYes": true,
  "text": "text",
  "decimalValue": 1,
  "date": "2025-12-06T04:07:52.004Z",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "name": "text",
    "description": "text",
    "dataType": "text",
    "isRequired": true,
    "options": [
      {
        "name": "text",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Updates an existing metadata entry for the specified playbook.

put

Updates the details of an existing metadata entry for the specified playbook using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the metadata entry to update.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

isYesboolean | nullableOptional

decimalValuenumber · double | nullableOptional

textstring | nullableOptional

datestring · date-time | nullableOptional

organizationMetadataIdentifierstring · uuidOptional

singleCategoryIdentifierstring · uuid | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put

/playbooks/{playbookIdentifier}/metadata/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /playbooks/{playbookIdentifier}/metadata/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "isYes": true,
  "decimalValue": 1,
  "text": "text",
  "date": "2025-12-06T04:07:52.004Z",
  "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "isYes": true,
  "text": "text",
  "decimalValue": 1,
  "date": "2025-12-06T04:07:52.004Z",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "name": "text",
    "description": "text",
    "dataType": "text",
    "isRequired": true,
    "options": [
      {
        "name": "text",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Removes a category from the specified playbook metadata entry.

delete

Removes a category from the specified playbook metadata entry using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the metadata entry.

optionIdentifierstring · uuidRequired

The identifier of the category to remove.

playbookIdentifierstringRequired

Responses

204

No Content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/playbooks/{playbookIdentifier}/metadata/{objectIdentifier}/categories/{optionIdentifier}

HTTPcURLJavaScriptPython

DELETE /playbooks/{playbookIdentifier}/metadata/{objectIdentifier}/categories/{optionIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content