Organization Metadata Options

List organization metadata options.

get

Returns a paged, optionally filtered and sorted list of the options defined on an organization metadata field.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

organizationMetadataIdentifierstring · uuidRequired

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

namestring · nullableRequired

objectIdentifierstring · uuidRequired

401

Unauthorized

403

Forbidden

get/projects/organization-metadata/{organizationMetadataIdentifier}/options

GET /projects/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"
  }
]

Create organization metadata option.

post

Adds a new selectable option to an existing organization metadata definition. For external developers managing the set of choices available on a metadata field.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

organizationMetadataIdentifierstring · uuidRequired

Body

namestring · nullableRequired

Responses

200

OK

namestring · nullableRequired

objectIdentifierstring · uuidRequired

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/projects/organization-metadata/{organizationMetadataIdentifier}/options

POST /projects/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"
}

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

Get organization metadata option by id.

get

Returns the details of a single organization metadata option identified by its GUID.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

organizationMetadataIdentifierstringRequired

Responses

200

OK

namestring · nullableRequired

objectIdentifierstring · uuidRequired

401

Unauthorized

403

Forbidden

get/projects/organization-metadata/{organizationMetadataIdentifier}/options/{objectIdentifier}

GET /projects/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"
}

Update organization metadata option.

put

Replaces the value and settings of an existing organization metadata option identified by its GUID.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

organizationMetadataIdentifierstringRequired

Body

namestring · nullableRequired

Responses

200

OK

namestring · nullableRequired

objectIdentifierstring · uuidRequired

400

Bad Request

401

Unauthorized

403

Forbidden

put/projects/organization-metadata/{organizationMetadataIdentifier}/options/{objectIdentifier}

PUT /projects/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"
}

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

Delete organization metadata option.

delete

Permanently removes an organization metadata option identified by its GUID.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

organizationMetadataIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

delete/projects/organization-metadata/{organizationMetadataIdentifier}/options/{objectIdentifier}

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

No content