curl --request GET \
--url http://localhost/api/taxonomies/{organizationSlug}{
"totalPages": 123,
"totalElements": 123,
"size": 123,
"content": [
{
"orgSlug": "<string>",
"slug": "<string>",
"type": "<string>",
"name": "<string>",
"version": "<string>",
"ref": "<string>",
"template": true,
"description": "<string>",
"get_id": "<string>",
"publicAccess": true,
"imageUrl": "<string>",
"icon": "<string>",
"overviewMarkdown": "<string>",
"provider": "<string>",
"providerUrl": "<string>",
"providerImageUrl": "<string>",
"deleteProtection": true,
"checksum": "<string>",
"deprecated": true,
"extensionPackRef": "<string>",
"taxonomyType": "CONTENT",
"enabled": true,
"externalDataTaxonomyRefs": [
"<string>"
],
"taxons": [
{
"name": "<string>",
"externalName": "<string>",
"valuePath": "VALUE_OR_ALL_CONTENT",
"id": "<string>",
"label": "<string>",
"order": 123,
"generateName": true,
"group": true,
"selectWeight": 123,
"metadataValue": "FILENAME",
"dataPath": "<string>",
"expression": "<string>",
"enableFallbackExpression": true,
"fallbackExpression": "<string>",
"enableSerializationExpression": true,
"serializationExpression": "<string>",
"nullable": true,
"nullValue": "<string>",
"denormalizeToChildren": true,
"notUserLabelled": true,
"description": "<string>",
"overviewMarkdown": "<string>",
"semanticDefinition": "<string>",
"synonyms": [
"<string>"
],
"lexicalRelations": [
{
"type": "SYNONYM",
"value": "<string>",
"weight": 123
}
],
"additionContexts": [
{
"type": "RECORD_DEFINITION",
"context": "<string>",
"weight": 123,
"negative": true
}
],
"guideProperties": {
"guidanceKey": true,
"guidanceKeyExpression": "<string>",
"useGuidanceForClassification": true,
"ifPresentRequired": true
},
"enabled": true,
"color": "<string>",
"children": "<array>",
"options": [
{
"name": "<string>",
"type": "<string>",
"groupOptions": "<array>",
"properties": {},
"tabName": "<string>",
"aliases": [
"<string>"
],
"label": "<string>",
"falseLabel": "<string>",
"hint": "<string>",
"required": true,
"subType": "<string>",
"listType": "<string>",
"displayProperties": {},
"listLabel": "<string>",
"listDescription": "<string>",
"featureFlag": "<string>",
"default": {},
"description": "<string>",
"supportArticle": "<string>",
"overviewMarkdown": "<string>",
"showIf": "<string>",
"developerOnly": true,
"showOnPopup": true,
"possibleValues": [
{
"label": "<string>",
"value": {},
"description": "<string>"
}
]
}
],
"nodeTypes": [
"<string>"
],
"taxonType": "STRING",
"selectionOptions": [
{
"label": "<string>",
"id": "<string>",
"description": "<string>",
"isConditional": true,
"conditionalFormula": "<string>",
"lexicalRelations": [
{
"type": "SYNONYM",
"value": "<string>",
"weight": 123
}
]
}
],
"typeFeatures": {},
"properties": {},
"conditionalFormats": [
{
"type": "<string>",
"condition": "<string>",
"properties": {}
}
],
"validationRules": [
{
"name": "<string>",
"disabled": true,
"description": "<string>",
"conditional": true,
"conditionalFormula": "<string>",
"ruleFormula": "<string>",
"messageFormula": "<string>",
"detailFormula": "<string>",
"exceptionId": "<string>",
"supportArticleId": "<string>",
"overridable": true
}
],
"cardinality": "ONCE_PER_DOCUMENT",
"path": "<string>",
"multiValue": true,
"userEditable": true,
"usePostExpression": true,
"postExpression": "<string>"
}
],
"totalTaxons": 123
}
],
"number": 123,
"sort": [
{
"direction": "<string>",
"nullHandling": "<string>",
"ascending": true,
"property": "<string>",
"ignoreCase": true
}
],
"first": true,
"numberOfElements": 123,
"pageable": {
"offset": 123,
"sort": [
{
"direction": "<string>",
"nullHandling": "<string>",
"ascending": true,
"property": "<string>",
"ignoreCase": true
}
],
"paged": true,
"unpaged": true,
"pageNumber": 123,
"pageSize": 123
},
"last": true,
"empty": true
}Get a paginated list of the resources for an organization
curl --request GET \
--url http://localhost/api/taxonomies/{organizationSlug}{
"totalPages": 123,
"totalElements": 123,
"size": 123,
"content": [
{
"orgSlug": "<string>",
"slug": "<string>",
"type": "<string>",
"name": "<string>",
"version": "<string>",
"ref": "<string>",
"template": true,
"description": "<string>",
"get_id": "<string>",
"publicAccess": true,
"imageUrl": "<string>",
"icon": "<string>",
"overviewMarkdown": "<string>",
"provider": "<string>",
"providerUrl": "<string>",
"providerImageUrl": "<string>",
"deleteProtection": true,
"checksum": "<string>",
"deprecated": true,
"extensionPackRef": "<string>",
"taxonomyType": "CONTENT",
"enabled": true,
"externalDataTaxonomyRefs": [
"<string>"
],
"taxons": [
{
"name": "<string>",
"externalName": "<string>",
"valuePath": "VALUE_OR_ALL_CONTENT",
"id": "<string>",
"label": "<string>",
"order": 123,
"generateName": true,
"group": true,
"selectWeight": 123,
"metadataValue": "FILENAME",
"dataPath": "<string>",
"expression": "<string>",
"enableFallbackExpression": true,
"fallbackExpression": "<string>",
"enableSerializationExpression": true,
"serializationExpression": "<string>",
"nullable": true,
"nullValue": "<string>",
"denormalizeToChildren": true,
"notUserLabelled": true,
"description": "<string>",
"overviewMarkdown": "<string>",
"semanticDefinition": "<string>",
"synonyms": [
"<string>"
],
"lexicalRelations": [
{
"type": "SYNONYM",
"value": "<string>",
"weight": 123
}
],
"additionContexts": [
{
"type": "RECORD_DEFINITION",
"context": "<string>",
"weight": 123,
"negative": true
}
],
"guideProperties": {
"guidanceKey": true,
"guidanceKeyExpression": "<string>",
"useGuidanceForClassification": true,
"ifPresentRequired": true
},
"enabled": true,
"color": "<string>",
"children": "<array>",
"options": [
{
"name": "<string>",
"type": "<string>",
"groupOptions": "<array>",
"properties": {},
"tabName": "<string>",
"aliases": [
"<string>"
],
"label": "<string>",
"falseLabel": "<string>",
"hint": "<string>",
"required": true,
"subType": "<string>",
"listType": "<string>",
"displayProperties": {},
"listLabel": "<string>",
"listDescription": "<string>",
"featureFlag": "<string>",
"default": {},
"description": "<string>",
"supportArticle": "<string>",
"overviewMarkdown": "<string>",
"showIf": "<string>",
"developerOnly": true,
"showOnPopup": true,
"possibleValues": [
{
"label": "<string>",
"value": {},
"description": "<string>"
}
]
}
],
"nodeTypes": [
"<string>"
],
"taxonType": "STRING",
"selectionOptions": [
{
"label": "<string>",
"id": "<string>",
"description": "<string>",
"isConditional": true,
"conditionalFormula": "<string>",
"lexicalRelations": [
{
"type": "SYNONYM",
"value": "<string>",
"weight": 123
}
]
}
],
"typeFeatures": {},
"properties": {},
"conditionalFormats": [
{
"type": "<string>",
"condition": "<string>",
"properties": {}
}
],
"validationRules": [
{
"name": "<string>",
"disabled": true,
"description": "<string>",
"conditional": true,
"conditionalFormula": "<string>",
"ruleFormula": "<string>",
"messageFormula": "<string>",
"detailFormula": "<string>",
"exceptionId": "<string>",
"supportArticleId": "<string>",
"overridable": true
}
],
"cardinality": "ONCE_PER_DOCUMENT",
"path": "<string>",
"multiValue": true,
"userEditable": true,
"usePostExpression": true,
"postExpression": "<string>"
}
],
"totalTaxons": 123
}
],
"number": 123,
"sort": [
{
"direction": "<string>",
"nullHandling": "<string>",
"ascending": true,
"property": "<string>",
"ignoreCase": true
}
],
"first": true,
"numberOfElements": 123,
"pageable": {
"offset": 123,
"sort": [
{
"direction": "<string>",
"nullHandling": "<string>",
"ascending": true,
"property": "<string>",
"ignoreCase": true
}
],
"paged": true,
"unpaged": true,
"pageNumber": 123,
"pageSize": 123
},
"last": true,
"empty": true
}Zero-based page index (0..N)
The size of the page to be returned
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
A filter that will be applied
A simple text query that will be applied
OK
Show child attributes
The slug of the organization that owns this metadata object
The slug used when referencing this metadata object
The type of metadata object The metadata object type
The name of the object
The version of the object
The reference to the metadata object
Is this component a template that can be used to create new components
The description of the object
An internal identifier (not for public use)
Is the metadata object publicly accessible by other organizations
URL of image when presenting this object in a UI
Material Icon name to use in the UI
Markdown that is used to present the overview of the object
The details of the of provider
The link to the provider website
The link to the model image
Delete protection status
The checksum of the metadata, calculated by the platform and used to determine if the metadata has changed
The resource is marked for deprecation
The reference to the extension pack (if the metadata object was created by an extension pack)
The type of taxonomy
CONTENT, CLASSIFICATION, PROCESSING, MODEL Is the taxonomy enabled (effects display in the UI)
A list of references to taxonomies that will represent the external data
A list of references to taxonomies that will represent the external data
The hierarchical structure of taxon's in this taxonomy
Show child attributes
The name to be used
1 - 512The name to be used when we are publishing this taxon to external systems
1 - 512Where to get the value for this taxon when extracting
VALUE_OR_ALL_CONTENT, VALUE_ONLY, ALL_CONTENT, DATA_PATH, METADATA, EXPRESSION, SCRIPT, FORMULA, DERIVED, REVIEW, EXTERNAL The ID of the taxon
The text to display for this taxon
Is the name generated, this allows that you can change displays without impacted existing content
Is this taxon a group, and therefore can't have a value, can only have children
The weight of this taxon, used to order the taxon for the user labeling (default is 1)
If the type is metadata this will be the metadata option
FILENAME, TRANSACTION_UUID, CREATED_DATETIME, DOCUMENT_LABELS, OWNER_NAME, DOCUMENT_STATUS, PAGE_NUMBER The path to the data, based on the data inside the label (tag) within the document
If the taxon is based on expression, this is the expression based on the available objects
Allow for the use of a fallback expression if the taxon wasn't found
Fallback expression if enabled, this is the expression based on the available objects
Enable serialization expression
Serialization expression
Determine if the value of the taxon can be null (unknown)
Allows the setting of a value to replace null if the taxon is nullable
Denormalize the value of the taxon into child data groups when we are looking to 'flatten' the data
If set to true this taxon will not be shown to the user for labeling
The description of the taxon
Overview for the taxon (supports markdown)
Semantic Definition
Synonyms
Synonyms
Additional Context
Show child attributes
RECORD_DEFINITION, RECORD_SECTION_STARTER_MARKER, RECORD_SECTION_END_MARKER, RECORD_START_MARKER, RECORD_END_MARKER Is the taxon enabled (used in the UI)
Hex encoding of the color to use for the taxon
The children under this taxon
Options that can be shown for the taxon (usually used in assistant taxonomies)
Show child attributes
A list of the node types that this taxon applies to (empty means everything), used in the UI
A list of the node types that this taxon applies to (empty means everything), used in the UI
Expected data type to coalesce to (defaults to STRING)
STRING, DATE, DATE_TIME, NUMBER, BOOLEAN, CURRENCY, URL, EMAIL_ADDRESS, PHONE_NUMBER, SELECTION, PERCENTAGE, FORMULA, DERIVED, SECTION If data type is SELECTION, this is the list of available options
Show child attributes
Show child attributes
SYNONYM, ANTONYM, HYPERNYM, HYPONYM, MERONYM, HOLONYM, ENTAILMENT, SIMILAR_TO, OTHER Additional properties that can be set and used by models or assistants based on the additional taxon options
Show child attributes
Additional properties that can be set and used by models or assistants based on the additional taxon options
The validation rules for the taxon
Show child attributes
The cardinality of the taxon, applies to a group taxon
ONCE_PER_DOCUMENT, MULTIPLE_PER_DOCUMENT, ONCE_PER_SEGMENT, MULTIPLE_PER_SEGMENT The path to the node
Does this taxon allow multiple values (for none-group)
Can the value of this taxon be edited by a user
Use a post extraction expression
An expression that is applied post extraction of the data
The total number of taxons in the taxonomy
Show child attributes