Organization Metadata

Retrieves a paginated list of organization metadata entries for projects.

get

Retrieves a paginated list of organization metadata entries for projects, optionally filtered and sorted.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Query parameters
pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter organization metadata entries.

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

Creates a new organization metadata entry for projects.

post

Creates a new organization metadata entry for projects.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Body
namestring | nullableRequired
descriptionstring | nullableRequired
dataTypestring | nullableRequired
isRequiredbooleanRequired
optionsstring[] | nullableOptional
Responses
post
/projects/organization-metadata
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"
  ]
}
{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    {
      "name": "text",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Retrieves an organization metadata entry for projects by its object identifier.

get

Retrieves an organization metadata entry for projects by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the organization metadata entry to retrieve.

Responses
200

OK

get
/projects/organization-metadata/{objectIdentifier}
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"
}

Updates an organization metadata entry for projects.

put

Updates an organization metadata entry for projects.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the organization metadata entry to update.

Body
namestring | nullableRequired
descriptionstring | nullableRequired
isRequiredbooleanRequired
Responses
200

OK

put
/projects/organization-metadata/{objectIdentifier}
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
}
{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "isRequired": true,
  "options": [
    {
      "name": "text",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Deletes an organization metadata entry for projects by its object identifier.

delete

Deletes an organization metadata entry for projects by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the organization metadata entry to delete.

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

No content
PreviousMetadataNextOrganization Metadata Options

Last updated