Organization Metadata

Gets all organization metadata entries for playbooks.

get

Retrieves a paginated list of all organization metadata entries for playbooks, with optional search and sorting.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

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/organization-metadata

HTTPcURLJavaScriptPython

GET /playbooks/organization-metadata HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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 organization metadata entry for playbooks.

post

Creates a new organization metadata entry for playbooks.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableRequired

isRequiredbooleanRequired

optionsstring[] · nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/organization-metadata

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    {
      "name": "text",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Gets a specific organization metadata entry for playbooks by its object identifier.

get

Retrieves the details of an organization metadata entry for playbooks using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the organization metadata entry.

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/organization-metadata/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "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 organization metadata entry for playbooks.

put

Updates the details of an existing organization metadata entry for playbooks using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the organization metadata entry to update.

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

descriptionstring · nullableRequired

isRequiredbooleanRequired

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/organization-metadata/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "isRequired": true
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    {
      "name": "text",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Deletes an organization metadata entry for playbooks.

delete

Deletes an organization metadata entry for playbooks using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the organization metadata entry to delete.

Responses

204

No Content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/playbooks/organization-metadata/{objectIdentifier}

HTTPcURLJavaScriptPython

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

No content