Introduction
Tasks
- GETGet a resource with the provided ID
- PUTUpdate the given instance
- DELDelete the resource with the provided ID
- PUTUpdate the status of the task
- DELRemove the task status
- PUTUpdate the assignee of the task
- DELRemove the task assignee
- GETGet the entity metadata for the filter
- POSTCreate a new instance of the resource
- POSTCreate a new task with the given request (to include document families)
Projects
- GETGet a resource with the provided ID
- PUTUpdate the given instance
- DELDelete the project with the provided ID and its associated resources
- GETGet the tags on a project
- PUTUpdate the tags on a project
- GETGet the project resources
- PUTUpdate all the resources associated with this project
- GETPaginated list of assistants that have been added to this project
- PUTUpdate the assistant in the given project
- POSTCreate and add assistant to project
- PUTUpdate the assistant in the given project
- DELDelete specified assistant
- GETList the assistant stores specified assistant
- PUTUpdate the list of stores for an assistant
- PUTSend a schedule event now to this assistant
- PUTDeactivate the assistant (stopping it from getting content events)
- PUTActivate the assistant (ensuring it gets content events)
- GETGet a list of the data forms associated with this project
- POSTAdd a dataform to the project
- POSTSend a document to upload and send as an event to an assistant
- GETGet the task tags for the project
- GETGet the notes for the project
- GETGet a list of the stores (type data) associated with this project
- GETCreate a project template request
- GETPaginated list of assistant executions
- GETGet event handler options for an assistant
DocumentFamilies
- Document Families Overview
- GETGet a resource with the provided ID
- PUTUpdate the given instance
- DELDelete the resource with the provided ID
- GETGet the external data for a document family
- PUTUpdate the external data for a document family
- GETGet the entity metadata for the filter
- POSTCreate a new instance of the resource
- GETTouching a document family triggers a DocumentFamilyEvent without changing the document family
Taxonomies
Stores
Organizations
Executions
Data Forms
- GETGet data form by slug
- PUTUpdate data form
- DELDelete data form
- GETList data forms for organization
- POSTCreate new data form
- GETList all data forms
- GETGet a resource with the provided ID
- PUTUpdate the given instance
- DELDelete the resource with the provided ID
- GETGet the entity metadata for the filter
- POSTCreate a new instance of the resource
cURL
Copy
Ask AI
curl --request POST \
--url http://localhost/api/projects/{id}/dataForms \
--header 'Content-Type: application/json' \
--data '
{
"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>",
"entrypoints": [
"<string>"
],
"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>"
}
]
}
],
"cards": [
{
"id": "<string>",
"type": "<string>",
"properties": {},
"children": "<array>"
}
]
}
'Copy
Ask AI
{
"name": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"name": "<string>",
"slug": "<string>",
"organizationStatus": "ACTIVE",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"publicAccess": true,
"description": "<string>",
"hasImage": true,
"defaultToPrivateTemplates": true,
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"description": "<string>",
"owner": {
"email": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"firstName": "<string>",
"lastName": "<string>",
"bio": "<string>",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"showDeveloperTools": true,
"image": "<string>",
"userHash": "<string>",
"acceptedTerms": true,
"userType": "HUMAN",
"active": true,
"fullName": "<string>",
"externallyManaged": true,
"hasAcceptedTerms": true,
"id": "<string>",
"security": {
"roles": [
"PLATFORM_ADMIN"
]
},
"preferences": {
"showWelcomeMessage": true,
"showOnboarding": true,
"showScrollbars": true
}
},
"status": {
"status": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"name": "<string>",
"slug": "<string>",
"organizationStatus": "ACTIVE",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"publicAccess": true,
"description": "<string>",
"hasImage": true,
"defaultToPrivateTemplates": true,
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"color": "<string>",
"icon": "<string>",
"production": true,
"id": "<string>"
},
"templateArticleId": "<string>",
"projectTemplateRef": "<string>",
"notes": "<string>",
"color": "<string>",
"tags": [
{
"name": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"name": "<string>",
"slug": "<string>",
"organizationStatus": "ACTIVE",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"publicAccess": true,
"description": "<string>",
"hasImage": true,
"defaultToPrivateTemplates": true,
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"color": "<string>",
"id": "<string>"
}
],
"dataFlow": {
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
},
"nodes": [
{
"id": "<string>",
"parentId": "<string>",
"type": "<string>",
"position": {
"x": 123,
"y": 123
},
"dimensions": {
"width": 123,
"height": 123
},
"properties": {}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"target": "<string>",
"properties": {}
}
]
},
"options": {
"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>"
}
]
}
],
"properties": {},
"groupTaxonTypeFeatures": {},
"taxonTypeFeatures": {},
"taskOptions": {
"showTakeNext": true,
"showNewTask": true
}
},
"documentStatuses": [
{
"status": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"color": "<string>",
"icon": "<string>",
"slug": "<string>",
"statusType": "UNRESOLVED",
"id": "<string>"
}
],
"statusType": "ACTIVE",
"taskStatuses": [
{
"label": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"color": "<string>",
"icon": "<string>",
"slug": "<string>",
"statusType": "TODO",
"id": "<string>"
}
],
"id": "<string>"
}Projects
Add a dataform to the project
Add a dataform to the project
POST
/
api
/
projects
/
{id}
/
dataForms
cURL
Copy
Ask AI
curl --request POST \
--url http://localhost/api/projects/{id}/dataForms \
--header 'Content-Type: application/json' \
--data '
{
"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>",
"entrypoints": [
"<string>"
],
"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>"
}
]
}
],
"cards": [
{
"id": "<string>",
"type": "<string>",
"properties": {},
"children": "<array>"
}
]
}
'Copy
Ask AI
{
"name": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"name": "<string>",
"slug": "<string>",
"organizationStatus": "ACTIVE",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"publicAccess": true,
"description": "<string>",
"hasImage": true,
"defaultToPrivateTemplates": true,
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"description": "<string>",
"owner": {
"email": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"firstName": "<string>",
"lastName": "<string>",
"bio": "<string>",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"showDeveloperTools": true,
"image": "<string>",
"userHash": "<string>",
"acceptedTerms": true,
"userType": "HUMAN",
"active": true,
"fullName": "<string>",
"externallyManaged": true,
"hasAcceptedTerms": true,
"id": "<string>",
"security": {
"roles": [
"PLATFORM_ADMIN"
]
},
"preferences": {
"showWelcomeMessage": true,
"showOnboarding": true,
"showScrollbars": true
}
},
"status": {
"status": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"name": "<string>",
"slug": "<string>",
"organizationStatus": "ACTIVE",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"publicAccess": true,
"description": "<string>",
"hasImage": true,
"defaultToPrivateTemplates": true,
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"color": "<string>",
"icon": "<string>",
"production": true,
"id": "<string>"
},
"templateArticleId": "<string>",
"projectTemplateRef": "<string>",
"notes": "<string>",
"color": "<string>",
"tags": [
{
"name": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"name": "<string>",
"slug": "<string>",
"organizationStatus": "ACTIVE",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"publicAccess": true,
"description": "<string>",
"hasImage": true,
"defaultToPrivateTemplates": true,
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"color": "<string>",
"id": "<string>"
}
],
"dataFlow": {
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
},
"nodes": [
{
"id": "<string>",
"parentId": "<string>",
"type": "<string>",
"position": {
"x": 123,
"y": 123
},
"dimensions": {
"width": 123,
"height": 123
},
"properties": {}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"target": "<string>",
"properties": {}
}
]
},
"options": {
"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>"
}
]
}
],
"properties": {},
"groupTaxonTypeFeatures": {},
"taxonTypeFeatures": {},
"taskOptions": {
"showTakeNext": true,
"showNewTask": true
}
},
"documentStatuses": [
{
"status": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"color": "<string>",
"icon": "<string>",
"slug": "<string>",
"statusType": "UNRESOLVED",
"id": "<string>"
}
],
"statusType": "ACTIVE",
"taskStatuses": [
{
"label": "<string>",
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"color": "<string>",
"icon": "<string>",
"slug": "<string>",
"statusType": "TODO",
"id": "<string>"
}
],
"id": "<string>"
}Path Parameters
Body
application/json
A data form is a way to allow validation and editing of data extracted from a document Services used by the assistant
The slug of the organization that owns this metadata object
The slug used when referencing this metadata object
The type of metadata object
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)
Show child attributes
Show child attributes
Response
OK
The UUID of the object
The change sequence of the object, which can be used to track modications
Show child attributes
Show child attributes
Available options:
ACTIVE, HAS_ISSUES, CANCELLED, ARCHIVED The UUID of the object
The change sequence of the object, which can be used to track modications
The ID of the object
A user of the Kodexa Platform
Show child attributes
Show child attributes
Email address of the user
The UUID of the object
The change sequence of the object, which can be used to track modications
First name of the user
Last name of the user
About the user
Show developer tools in the UI
Link to user image
Available options:
HUMAN, ASSISTANT, SERVICE Flag to indicate if the user is active
Full name of the user
Flag to indicate if the user has accepted the terms of service
The ID of the object
The project status
Show child attributes
Show child attributes
The UUID of the object
The change sequence of the object, which can be used to track modications
Show child attributes
Show child attributes
Available options:
ACTIVE, HAS_ISSUES, CANCELLED, ARCHIVED The UUID of the object
The change sequence of the object, which can be used to track modications
The ID of the object
The ID of the object
The project tags related to this project
Show child attributes
Show child attributes
The UUID of the object
The change sequence of the object, which can be used to track modications
Show child attributes
Show child attributes
Available options:
ACTIVE, HAS_ISSUES, CANCELLED, ARCHIVED The UUID of the object
The change sequence of the object, which can be used to track modications
The ID of the object
The ID of the object
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Options for the project template
Show child attributes
Show child attributes
The options available for this project
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The UUID of the object
The change sequence of the object, which can be used to track modications
Available options:
UNRESOLVED, RESOLVED The ID of the object
The project status type (ACTIVE or ARCHIVED)
Available options:
ACTIVE, ARCHIVED Show child attributes
Show child attributes
The UUID of the object
The change sequence of the object, which can be used to track modications
Available options:
TODO, IN_PROGRESS, DONE The ID of the object
The ID of the object
Get a list of the data forms associated with this projectSend a document to upload and send as an event to an assistant
⌘I