Skip to main content
POST
/
api
/
project-templates
Create ProjectTemplateMetadata
curl --request POST \
  --url https://platform.kodexa.ai/api/project-templates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "assistants": [
      {
        "assistantDefinitionRef": "<string>",
        "assistantRole": "<string>",
        "chatEnabled": true,
        "connections": [
          {
            "active": true,
            "sourceRef": "<string>",
            "sourceType": "STORE",
            "subscription": "<string>",
            "targetRef": "<string>",
            "targetType": "STORE"
          }
        ],
        "description": "<string>",
        "loggingEnabled": true,
        "name": "<string>",
        "options": {},
        "priorityHint": 123,
        "schedules": [
          {
            "cronExpression": "<string>",
            "type": "<string>"
          }
        ],
        "showInTraining": true,
        "slug": "<string>",
        "stores": [
          "<string>"
        ],
        "subscription": "<string>"
      }
    ],
    "attributeStatuses": [
      {
        "color": "<string>",
        "icon": "<string>",
        "status": "<string>",
        "statusType": "UNRESOLVED"
      }
    ],
    "checksum": "<string>",
    "dataForms": [
      {
        "cards": {},
        "description": "<string>",
        "entrypoints": [
          "<string>"
        ],
        "name": "<string>",
        "ref": "<string>",
        "slug": "<string>",
        "templateRef": "<string>"
      }
    ],
    "deleteProtection": true,
    "deprecated": true,
    "description": "<string>",
    "documentStatuses": [
      {
        "color": "<string>",
        "icon": "<string>",
        "oldIdentifier": "<string>",
        "slug": "<string>",
        "status": "<string>",
        "statusType": "UNRESOLVED"
      }
    ],
    "extensionPackRef": "<string>",
    "helpUrl": "<string>",
    "icon": "<string>",
    "id": "<string>",
    "imageUrl": "<string>",
    "knowledgeSets": [
      {
        "active": true,
        "clauses": [
          {
            "features": [
              {
                "featureUuid": "<string>",
                "positive": true
              }
            ]
          }
        ],
        "description": "<string>",
        "featureExpression": {
          "children": "<array>",
          "slug": "<string>",
          "type": "FEATURE"
        },
        "features": [
          {
            "active": true,
            "featureTypeRef": "<string>",
            "originalFeatureId": "<string>",
            "properties": {},
            "slug": "<string>",
            "uuid": "<string>"
          }
        ],
        "knowledgeItems": [
          {
            "active": true,
            "description": "<string>",
            "knowledgeItemTypeRef": "<string>",
            "properties": {},
            "sequenceOrder": 123,
            "slug": "<string>",
            "title": "<string>"
          }
        ],
        "name": "<string>",
        "ref": "<string>",
        "setType": "<string>",
        "showOnNewProject": true,
        "slug": "<string>"
      }
    ],
    "memory": {
      "changeSequence": 123,
      "orderedDashboards": [
        "<string>"
      ],
      "recentFilters": {},
      "recentQueries": {}
    },
    "name": "<string>",
    "options": {
      "dataOptions": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "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": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "dataProperties": {},
      "groupTaxonTypeFeatures": {},
      "options": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "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": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "properties": {},
      "taskOptions": {
        "showNewTask": true,
        "showTakeNext": true
      },
      "taxonTypeFeatures": {}
    },
    "orgSlug": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>",
    "publicAccess": true,
    "ref": "<string>",
    "scheduledJobs": [
      {
        "active": true,
        "deleted": true,
        "description": "<string>",
        "modelRef": "<string>",
        "name": "<string>",
        "oldIdentifier": "<string>",
        "properties": {},
        "schedules": [
          {
            "cronExpression": "<string>",
            "id": "<string>",
            "type": "<string>"
          }
        ]
      }
    ],
    "slug": "<string>",
    "stores": [
      {
        "allowDataEditing": true,
        "deleteProtection": true,
        "description": "<string>",
        "documentProperties": {},
        "files": [
          {
            "metadata": {},
            "url": "<string>"
          }
        ],
        "hasImage": true,
        "highQualityPreview": true,
        "labelExpressions": {},
        "name": "<string>",
        "ref": "<string>",
        "showStoreInLabeling": true,
        "showThumbnails": true,
        "slug": "<string>",
        "storePurpose": "<string>",
        "storeType": "<string>",
        "templateRef": "<string>"
      }
    ],
    "tags": [
      {
        "color": "<string>",
        "label": "<string>"
      }
    ],
    "taskStatuses": [
      {
        "color": "<string>",
        "icon": "<string>",
        "label": "<string>",
        "locked": true,
        "oldIdentifier": "<string>",
        "slug": "<string>",
        "statusType": "TODO"
      }
    ],
    "taskTemplates": [
      {
        "description": "<string>",
        "metadata": {
          "actions": [
            {
              "label": "<string>",
              "properties": {},
              "type": "<string>",
              "uuid": "<string>"
            }
          ],
          "documentFamilyGroups": [
            {
              "automaticallyAdd": true,
              "documentFamilyFilter": "<string>",
              "editable": true,
              "maxHits": 123,
              "maxPages": 123,
              "maxSize": 123,
              "name": "<string>",
              "notes": "<string>",
              "sort": "<string>",
              "titlePrompt": "<string>",
              "uniqueFilenames": true,
              "uploadOnly": true
            }
          ],
          "forms": [
            {
              "dataFormRef": "<string>"
            }
          ],
          "options": [
            {
              "aliases": [
                "<string>"
              ],
              "default": {},
              "description": "<string>",
              "developerOnly": true,
              "displayProperties": {},
              "falseLabel": "<string>",
              "featureFlag": "<string>",
              "hint": "<string>",
              "label": "<string>",
              "listDescription": "<string>",
              "listLabel": "<string>",
              "listType": "<string>",
              "name": "<string>",
              "overviewMarkdown": "<string>",
              "properties": {},
              "required": true,
              "showIf": "<string>",
              "showOnPopup": true,
              "subType": "<string>",
              "supportArticle": "<string>",
              "tabName": "<string>",
              "type": "<string>"
            }
          ],
          "priority": 123,
          "properties": {},
          "teamSlug": "<string>",
          "workspaceId": "<string>"
        },
        "name": "<string>",
        "oldIdentifier": "<string>",
        "slug": "<string>"
      }
    ],
    "taxonomies": [
      {
        "description": "<string>",
        "name": "<string>",
        "ref": "<string>",
        "slug": "<string>",
        "taxonomyType": "<string>",
        "taxons": {},
        "templateRef": "<string>"
      }
    ],
    "template": true,
    "type": "<string>",
    "version": "<string>"
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "assistants": [
      {
        "assistantDefinitionRef": "<string>",
        "assistantRole": "<string>",
        "chatEnabled": true,
        "connections": [
          {
            "active": true,
            "sourceRef": "<string>",
            "sourceType": "STORE",
            "subscription": "<string>",
            "targetRef": "<string>",
            "targetType": "STORE"
          }
        ],
        "description": "<string>",
        "loggingEnabled": true,
        "name": "<string>",
        "options": {},
        "priorityHint": 123,
        "schedules": [
          {
            "cronExpression": "<string>",
            "type": "<string>"
          }
        ],
        "showInTraining": true,
        "slug": "<string>",
        "stores": [
          "<string>"
        ],
        "subscription": "<string>"
      }
    ],
    "attributeStatuses": [
      {
        "color": "<string>",
        "icon": "<string>",
        "status": "<string>",
        "statusType": "UNRESOLVED"
      }
    ],
    "checksum": "<string>",
    "dataForms": [
      {
        "cards": {},
        "description": "<string>",
        "entrypoints": [
          "<string>"
        ],
        "name": "<string>",
        "ref": "<string>",
        "slug": "<string>",
        "templateRef": "<string>"
      }
    ],
    "deleteProtection": true,
    "deprecated": true,
    "description": "<string>",
    "documentStatuses": [
      {
        "color": "<string>",
        "icon": "<string>",
        "oldIdentifier": "<string>",
        "slug": "<string>",
        "status": "<string>",
        "statusType": "UNRESOLVED"
      }
    ],
    "extensionPackRef": "<string>",
    "helpUrl": "<string>",
    "icon": "<string>",
    "id": "<string>",
    "imageUrl": "<string>",
    "knowledgeSets": [
      {
        "active": true,
        "clauses": [
          {
            "features": [
              {
                "featureUuid": "<string>",
                "positive": true
              }
            ]
          }
        ],
        "description": "<string>",
        "featureExpression": {
          "children": "<array>",
          "slug": "<string>",
          "type": "FEATURE"
        },
        "features": [
          {
            "active": true,
            "featureTypeRef": "<string>",
            "originalFeatureId": "<string>",
            "properties": {},
            "slug": "<string>",
            "uuid": "<string>"
          }
        ],
        "knowledgeItems": [
          {
            "active": true,
            "description": "<string>",
            "knowledgeItemTypeRef": "<string>",
            "properties": {},
            "sequenceOrder": 123,
            "slug": "<string>",
            "title": "<string>"
          }
        ],
        "name": "<string>",
        "ref": "<string>",
        "setType": "<string>",
        "showOnNewProject": true,
        "slug": "<string>"
      }
    ],
    "memory": {
      "changeSequence": 123,
      "orderedDashboards": [
        "<string>"
      ],
      "recentFilters": {},
      "recentQueries": {}
    },
    "name": "<string>",
    "options": {
      "dataOptions": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "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": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "dataProperties": {},
      "groupTaxonTypeFeatures": {},
      "options": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "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": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "properties": {},
      "taskOptions": {
        "showNewTask": true,
        "showTakeNext": true
      },
      "taxonTypeFeatures": {}
    },
    "orgSlug": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>",
    "publicAccess": true,
    "ref": "<string>",
    "scheduledJobs": [
      {
        "active": true,
        "deleted": true,
        "description": "<string>",
        "modelRef": "<string>",
        "name": "<string>",
        "oldIdentifier": "<string>",
        "properties": {},
        "schedules": [
          {
            "cronExpression": "<string>",
            "id": "<string>",
            "type": "<string>"
          }
        ]
      }
    ],
    "slug": "<string>",
    "stores": [
      {
        "allowDataEditing": true,
        "deleteProtection": true,
        "description": "<string>",
        "documentProperties": {},
        "files": [
          {
            "metadata": {},
            "url": "<string>"
          }
        ],
        "hasImage": true,
        "highQualityPreview": true,
        "labelExpressions": {},
        "name": "<string>",
        "ref": "<string>",
        "showStoreInLabeling": true,
        "showThumbnails": true,
        "slug": "<string>",
        "storePurpose": "<string>",
        "storeType": "<string>",
        "templateRef": "<string>"
      }
    ],
    "tags": [
      {
        "color": "<string>",
        "label": "<string>"
      }
    ],
    "taskStatuses": [
      {
        "color": "<string>",
        "icon": "<string>",
        "label": "<string>",
        "locked": true,
        "oldIdentifier": "<string>",
        "slug": "<string>",
        "statusType": "TODO"
      }
    ],
    "taskTemplates": [
      {
        "description": "<string>",
        "metadata": {
          "actions": [
            {
              "label": "<string>",
              "properties": {},
              "type": "<string>",
              "uuid": "<string>"
            }
          ],
          "documentFamilyGroups": [
            {
              "automaticallyAdd": true,
              "documentFamilyFilter": "<string>",
              "editable": true,
              "maxHits": 123,
              "maxPages": 123,
              "maxSize": 123,
              "name": "<string>",
              "notes": "<string>",
              "sort": "<string>",
              "titlePrompt": "<string>",
              "uniqueFilenames": true,
              "uploadOnly": true
            }
          ],
          "forms": [
            {
              "dataFormRef": "<string>"
            }
          ],
          "options": [
            {
              "aliases": [
                "<string>"
              ],
              "default": {},
              "description": "<string>",
              "developerOnly": true,
              "displayProperties": {},
              "falseLabel": "<string>",
              "featureFlag": "<string>",
              "hint": "<string>",
              "label": "<string>",
              "listDescription": "<string>",
              "listLabel": "<string>",
              "listType": "<string>",
              "name": "<string>",
              "overviewMarkdown": "<string>",
              "properties": {},
              "required": true,
              "showIf": "<string>",
              "showOnPopup": true,
              "subType": "<string>",
              "supportArticle": "<string>",
              "tabName": "<string>",
              "type": "<string>"
            }
          ],
          "priority": 123,
          "properties": {},
          "teamSlug": "<string>",
          "workspaceId": "<string>"
        },
        "name": "<string>",
        "oldIdentifier": "<string>",
        "slug": "<string>"
      }
    ],
    "taxonomies": [
      {
        "description": "<string>",
        "name": "<string>",
        "ref": "<string>",
        "slug": "<string>",
        "taxonomyType": "<string>",
        "taxons": {},
        "templateRef": "<string>"
      }
    ],
    "template": true,
    "type": "<string>",
    "version": "<string>"
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

x-api-key
string
header
required

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

Body

application/json

A project template defines a reusable project configuration that can be instantiated.

changeSequence
integer<int32>
createdOn
string<date-time>
deprecated
boolean
extensionPackRef
string
id
string
metadata
object
name
string
organizationId
string
publicAccess
boolean
slug
string
template
boolean
updatedOn
string<date-time>
uuid
string

Response

Created ProjectTemplateMetadata

A project template defines a reusable project configuration that can be instantiated.

changeSequence
integer<int32>
createdOn
string<date-time>
deprecated
boolean
extensionPackRef
string
id
string
metadata
object
name
string
organizationId
string
publicAccess
boolean
slug
string
template
boolean
updatedOn
string<date-time>
uuid
string