Skip to main content
GET
/
api
/
data-definitions
List Data Definitions
curl --request GET \
  --url https://platform.kodexa.ai/api/data-definitions \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "deprecated": true,
      "extensionPackRef": "<string>",
      "id": "d3456789-01ab-cdef-2345-678901abcdef",
      "metadata": {
        "taxons": [
          {
            "additionContexts": [
              "<string>"
            ],
            "cardinality": "<string>",
            "children": "<array>",
            "color": "<string>",
            "conditionalFormats": [
              {
                "background": "<string>",
                "color": "<string>",
                "formula": "<string>",
                "icon": "<string>",
                "name": "<string>",
                "style": "<string>"
              }
            ],
            "dataPath": "<string>",
            "denormalizeToChildren": true,
            "description": "<string>",
            "enableFallbackExpression": true,
            "enableSerializationExpression": true,
            "enabled": true,
            "expression": "<string>",
            "externalName": "<string>",
            "fallbackExpression": "<string>",
            "generateName": true,
            "group": true,
            "guideProperties": {
              "overviewMarkdown": "<string>"
            },
            "id": "<string>",
            "label": "<string>",
            "lexicalRelations": [
              {
                "type": "<string>",
                "value": "<string>"
              }
            ],
            "metadataValue": "<string>",
            "multiValue": true,
            "name": "<string>",
            "naturalKeys": [
              {
                "name": "<string>"
              }
            ],
            "nodeTypes": [
              "<string>"
            ],
            "notUserLabelled": true,
            "nullValue": "<string>",
            "nullable": true,
            "options": [
              {
                "aliases": [
                  "<string>"
                ],
                "default": {},
                "description": "<string>",
                "developerOnly": true,
                "displayProperties": {
                  "columns": 123,
                  "rows": 123,
                  "width": 123
                },
                "falseLabel": "<string>",
                "featureFlag": "<string>",
                "groupOptions": "<array>",
                "hint": "<string>",
                "label": "<string>",
                "listDescription": "<string>",
                "listLabel": "<string>",
                "listType": "<string>",
                "name": "<string>",
                "overviewMarkdown": "<string>",
                "possibleValues": [
                  {
                    "description": "<string>",
                    "label": "<string>",
                    "value": "<string>"
                  }
                ],
                "properties": {
                  "color": "<string>",
                  "icon": "<string>"
                },
                "required": true,
                "showIf": "<string>",
                "showOnPopup": true,
                "subType": "<string>",
                "supportArticle": "<string>",
                "tabName": "<string>",
                "type": "<string>"
              }
            ],
            "order": 123,
            "overviewMarkdown": "<string>",
            "path": "<string>",
            "postExpression": "<string>",
            "properties": {
              "alignment": "<string>",
              "visible": true,
              "width": 123
            },
            "selectWeight": 123,
            "selectionOptions": [
              {
                "conditionalFormula": "<string>",
                "description": "<string>",
                "disabled": "<string>",
                "id": "<string>",
                "isConditional": true,
                "label": "<string>",
                "lexicalRelations": [
                  {
                    "type": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            ],
            "semanticDefinition": "<string>",
            "serializationExpression": "<string>",
            "synonyms": [
              "<string>"
            ],
            "taxonType": "<string>",
            "typeFeatures": {
              "currencyCode": "<string>",
              "dateFormat": "<string>",
              "decimalPlaces": 123,
              "formulaExpression": "<string>"
            },
            "usePostExpression": true,
            "userEditable": true,
            "validationRules": [
              {
                "conditional": true,
                "conditionalFormula": "<string>",
                "description": "<string>",
                "detailFormula": "<string>",
                "disabled": true,
                "exceptionId": "<string>",
                "messageFormula": "<string>",
                "name": "<string>",
                "overridable": true,
                "ruleFormula": "<string>",
                "supportArticleId": "<string>"
              }
            ],
            "valuePath": "<string>"
          }
        ]
      },
      "name": "Invoice Taxonomy",
      "publicAccess": true,
      "slug": "invoice-taxonomy",
      "template": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "version": "1.0.0"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Query Parameters

page
integer<int32>

Page number (1-indexed). Defaults to 1.

pageSize
integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

sort
string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

filter
string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

query
string

Full-text search query matching against the entity's searchable fields.

Response

Page of Taxonomies

Paginated response containing TaxonomyMetadata items.

content
object[]

Array of TaxonomyMetadata items on this page.

first
boolean

Whether this is the first page.

last
boolean

Whether this is the last page.

number
integer<int32>

Current page number (0-indexed).

numberOfElements
integer<int32>

Number of items on the current page.

pageable
object

Pagination metadata.

size
integer<int32>

Page size (number of items per page).

sort
object

Sort metadata.

totalElements
integer<int64>

Total number of items across all pages.

totalPages
integer<int32>

Total number of pages.