Metadata

Adds a metadata category to the specified project.

post

Adds a metadata category to the specified project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the project.

projectIdentifierstringRequired

Body

optionIdentifierstring · uuidRequired

Responses

204

No Content

400

Bad Request

403

Forbidden

404

Not Found

post

/projects/{projectIdentifier}/metadata/{objectIdentifier}/categories

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

No content

Retrieves a paginated list of metadata entries for the project.

get

Retrieves a paginated list of metadata entries for the project, optionally filtered and sorted.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter metadata entries.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

403

Forbidden

get

/projects/{projectIdentifier}/metadata

GET /projects/{projectIdentifier}/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-06T03:57:25.131Z",
    "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 project.

post

Creates a new metadata entry for the project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Body

isYesboolean | nullableOptional

decimalValuenumber · double | nullableOptional

textstring | nullableOptional

datestring · date-time | nullableOptional

singleCategoryIdentifierstring · uuid | nullableOptional

categoriesstring · uuid[] | nullableOptional

organizationMetadataIdentifierstring · uuidOptional

Responses

201

Created

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/metadata

POST /projects/{projectIdentifier}/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-06T03:57:25.131Z",
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "isYes": true,
  "text": "text",
  "decimalValue": 1,
  "date": "2025-12-06T03:57:25.131Z",
  "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"
  }
}

Retrieves a metadata entry by its object identifier.

get

Retrieves a metadata entry by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the metadata entry.

projectIdentifierstringRequired

Responses

200

403

Forbidden

404

Not Found

get

/projects/{projectIdentifier}/metadata/{objectIdentifier}

GET /projects/{projectIdentifier}/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-06T03:57:25.131Z",
  "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 a metadata entry for the project.

put

Updates a metadata entry for the project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the metadata entry to update.

projectIdentifierstringRequired

Body

isYesboolean | nullableOptional

decimalValuenumber · double | nullableOptional

textstring | nullableOptional

datestring · date-time | nullableOptional

organizationMetadataIdentifierstring · uuidOptional

singleCategoryIdentifierstring · uuid | nullableOptional

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

put

/projects/{projectIdentifier}/metadata/{objectIdentifier}

PUT /projects/{projectIdentifier}/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-06T03:57:25.131Z",
  "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "isYes": true,
  "text": "text",
  "decimalValue": 1,
  "date": "2025-12-06T03:57:25.131Z",
  "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 metadata category from the specified project.

delete

Removes a metadata category from the specified project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the project.

optionIdentifierstring · uuidRequired

The unique identifier of the category option to remove.

projectIdentifierstringRequired

Responses

204

No Content

400

Bad Request

403

Forbidden

404

Not Found

delete

/projects/{projectIdentifier}/metadata/{objectIdentifier}/categories/{optionIdentifier}

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

No content

PreviousMessages NextOrganization Metadata

Last updated 4 months ago