Metadata

Assign a metadata category option.

post

Assigns a predefined category option to a metadata entry on the project so it can be tagged and filtered. Requires project read-write access.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

optionIdentifierstring · uuidRequired

Responses

200

OK

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

List project metadata entries.

get

Returns a paginated, optionally searched and sorted list of metadata entries on the project. Requires project read access.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

isYesboolean · nullableOptional

textstring · nullableOptional

decimalValuenumber · double · nullableOptional

datestring · date-time · nullableOptional

categoriesstring · uuid[] · nullableOptional

singleCategoryIdentifierstring · uuid · nullableOptional

objectIdentifierstring · uuidRequired

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": "2026-01-01T00:00:00.000Z",
    "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"
    }
  }
]

Create a project metadata entry.

post

Creates a new typed metadata entry on the project and returns the created entry. Requires project read-write access.

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

200

OK

isYesboolean · nullableOptional

textstring · nullableOptional

decimalValuenumber · double · nullableOptional

datestring · date-time · nullableOptional

categoriesstring · uuid[] · nullableOptional

singleCategoryIdentifierstring · uuid · nullableOptional

objectIdentifierstring · uuidRequired

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": "2026-01-01T00:00:00.000Z",
  "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": "2026-01-01T00:00:00.000Z",
  "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"
  }
}

Get a project metadata entry.

get

Returns a single project metadata entry identified by its GUID. Requires project read access.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

isYesboolean · nullableOptional

textstring · nullableOptional

decimalValuenumber · double · nullableOptional

datestring · date-time · nullableOptional

categoriesstring · uuid[] · nullableOptional

singleCategoryIdentifierstring · uuid · nullableOptional

objectIdentifierstring · uuidRequired

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": "2026-01-01T00:00:00.000Z",
  "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"
  }
}

Update a project metadata entry.

put

Updates an existing project metadata entry and returns the updated entry. Requires project read-write access.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

isYesboolean · nullableOptional

decimalValuenumber · double · nullableOptional

textstring · nullableOptional

datestring · date-time · nullableOptional

organizationMetadataIdentifierstring · uuidOptional

singleCategoryIdentifierstring · uuid · nullableOptional

Responses

200

OK

isYesboolean · nullableOptional

textstring · nullableOptional

decimalValuenumber · double · nullableOptional

datestring · date-time · nullableOptional

categoriesstring · uuid[] · nullableOptional

singleCategoryIdentifierstring · uuid · nullableOptional

objectIdentifierstring · uuidRequired

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": "2026-01-01T00:00:00.000Z",
  "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "isYes": true,
  "text": "text",
  "decimalValue": 1,
  "date": "2026-01-01T00:00:00.000Z",
  "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"
  }
}

Delete a project metadata entry.

delete

Permanently deletes a project metadata entry by its GUID. Requires project read-write access and container administrator rights.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

204

No Content

No content

403

Forbidden

404

Not Found

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

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

No content

Remove a metadata category option.

delete

Unassigns a category option from a project metadata entry, leaving the entry in place. Requires project read-write access.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

optionIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

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