Organization Metadata Options

Retrieves a paginated list of organization metadata options for the specified organization metadata.

get

Retrieves a paginated list of organization metadata options for the specified organization metadata, optionally filtered and sorted.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
organizationMetadataIdentifierstring · uuidRequired

The unique identifier of the organization metadata.

Query parameters
pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter options.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:
descbooleanOptional

Whether to sort in descending order.

Default: true
Responses
200

OK

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"
  }
]

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

post

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

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
organizationMetadataIdentifierstring · uuidRequired

The unique identifier of the organization metadata.

Body
namestring | nullableRequired
Responses
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"
}

Retrieves an organization metadata option by its object identifier.

get

Retrieves an organization metadata option by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the organization metadata option to retrieve.

organizationMetadataIdentifierstringRequired
Responses
200

OK

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"
}

Updates an organization metadata option.

put

Updates an organization metadata option.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the organization metadata option to update.

organizationMetadataIdentifierstringRequired
Body
namestring | nullableRequired
Responses
200

OK

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"
}

Deletes an organization metadata option by its object identifier.

delete

Deletes an organization metadata option by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the organization metadata option to delete.

organizationMetadataIdentifierstringRequired
Responses
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

Last updated