Organization Metadata

Get all organization metadata for projects.

get

Returns a paginated list of organization-level custom metadata fields for projects, with optional filtering and sorting.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableRequired

isRequiredbooleanRequired

objectIdentifierstring · uuidRequired

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/organization-metadata

HTTPcURLJavaScriptPython

GET /projects/organization-metadata HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "description": "text",
    "dataType": "text",
    "isRequired": true,
    "options": [
      {
        "name": "text",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Create organization metadata for projects.

post

Defines a new organization-level custom metadata field for projects.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableRequired

isRequiredbooleanRequired

optionsstring[] · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableRequired

isRequiredbooleanRequired

objectIdentifierstring · uuidRequired

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/projects/organization-metadata

HTTPcURLJavaScriptPython

POST /projects/organization-metadata HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    {
      "name": "text",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Get organization metadata for projects by id.

get

Returns a single organization-level custom metadata field for projects by its identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableRequired

isRequiredbooleanRequired

objectIdentifierstring · uuidRequired

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get/projects/organization-metadata/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    {
      "name": "text",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Update organization metadata for projects.

put

Updates the definition of an organization-level custom metadata field for projects.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

descriptionstring · nullableRequired

isRequiredbooleanRequired

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableRequired

isRequiredbooleanRequired

objectIdentifierstring · uuidRequired

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put/projects/organization-metadata/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "isRequired": true
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    {
      "name": "text",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Delete organization metadata for projects.

delete

Deletes an organization-level custom metadata field for projects by its identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete/projects/organization-metadata/{objectIdentifier}

HTTPcURLJavaScriptPython

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

No content