Organization Metadata Options

Gets all organization metadata options for the specified organization metadata entry.

get

Retrieves a paginated list of all organization metadata options for the specified organization metadata entry, with optional search and sorting.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

organizationMetadataIdentifierstring · uuidRequired

The identifier of the organization metadata entry.

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/{organizationMetadataIdentifier}/options

HTTPcURLJavaScriptPython

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

[
  {
    "name": "text",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Creates a new organization metadata option for the specified organization metadata entry.

post

Creates a new organization metadata option for the specified organization metadata entry.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

organizationMetadataIdentifierstring · uuidRequired

The identifier of the organization metadata entry.

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/organization-metadata/{organizationMetadataIdentifier}/options

HTTPcURLJavaScriptPython

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

{
  "name": "text"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Gets the details of a specific organization metadata option by its object identifier.

get

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the option.

organizationMetadataIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/organization-metadata/{organizationMetadataIdentifier}/options/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Updates an existing organization metadata option for playbooks.

put

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the option to update.

organizationMetadataIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

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/{organizationMetadataIdentifier}/options/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "name": "text"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Deletes an organization metadata option for playbooks.

delete

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the option to delete.

organizationMetadataIdentifierstringRequired

Responses

204

No Content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/playbooks/organization-metadata/{organizationMetadataIdentifier}/options/{objectIdentifier}

HTTPcURLJavaScriptPython

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

No content