Skip to main content
PUT
/
api
/
task-templates
/
{id}
Update TaskTemplate
curl --request PUT \
  --url https://platform.kodexa.ai/api/task-templates/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<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": [
      {
        "actions": [
          {
            "label": "<string>",
            "properties": {},
            "type": "<string>",
            "uuid": "<string>"
          }
        ],
        "availablePanels": {},
        "dataFormRef": "<string>",
        "properties": {}
      }
    ],
    "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": {},
    "workspaceId": "<string>"
  },
  "name": "<string>",
  "planTemplate": {
    "items": [
      {
        "allowedOutcomes": [
          "<string>"
        ],
        "approvalCriteria": {},
        "approverRole": "<string>",
        "condition": {},
        "dependsOn": [
          "<string>"
        ],
        "hideLock": true,
        "maxStepsToInsert": 123,
        "moduleRef": "<string>",
        "name": "<string>",
        "options": {},
        "plannerContext": {},
        "taskData": {
          "actions": [
            {
              "label": "<string>",
              "properties": {},
              "type": "<string>",
              "uuid": "<string>"
            }
          ],
          "description": "<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": [
            {
              "actions": [
                {
                  "label": "<string>",
                  "properties": {},
                  "type": "<string>",
                  "uuid": "<string>"
                }
              ],
              "availablePanels": {},
              "dataFormRef": "<string>",
              "properties": {}
            }
          ],
          "panelProperties": {},
          "priority": 123,
          "properties": {},
          "title": "<string>"
        },
        "taskStatusSlug": "<string>",
        "taskTemplateRef": "<string>"
      }
    ]
  },
  "planned": true,
  "project": {
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "dataFlow": {
      "edges": [
        {
          "id": "<string>",
          "properties": {},
          "source": "<string>",
          "target": "<string>"
        }
      ],
      "nodes": [
        {
          "dimensions": {
            "height": 123,
            "width": 123
          },
          "id": "<string>",
          "parentId": "<string>",
          "position": {
            "x": 123,
            "y": 123
          },
          "properties": {},
          "type": "<string>"
        }
      ],
      "viewPort": {
        "x": 123,
        "y": 123,
        "zoom": 123
      }
    },
    "description": "<string>",
    "id": "<string>",
    "memory": {
      "changeSequence": 123,
      "orderedDashboards": [
        "<string>"
      ],
      "recentFilters": {},
      "recentQueries": {}
    },
    "name": "<string>",
    "notes": "<string>",
    "options": {
      "dataOptions": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": [
            {}
          ],
          "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": [
            {}
          ],
          "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": {}
    },
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "<string>",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "<string>",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "<string>",
      "organizationStatus": "<string>",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "<string>",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "organizationId": "<string>",
    "owner": {
      "active": true,
      "bio": "<string>",
      "businessGroup": "<string>",
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "firstName": "<string>",
      "groupsJson": "<string>",
      "id": "<string>",
      "image": "<string>",
      "isExternallyManaged": true,
      "lastName": "<string>",
      "preferences": {
        "showOnboarding": true,
        "showScrollbars": true,
        "showWelcomeMessage": true
      },
      "roles": {
        "roles": [
          "<string>"
        ]
      },
      "rolesJson": "<string>",
      "searchText": "<string>",
      "showDeveloperTools": true,
      "title": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "userStorage": {
        "favoriteLinks": [
          {
            "link": "<string>"
          }
        ]
      },
      "userType": "<string>",
      "uuid": "<string>"
    },
    "ownerId": "<string>",
    "projectTemplateRef": "<string>",
    "searchText": "<string>",
    "slug": "<string>",
    "status": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "id": "<string>",
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "<string>",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "<string>",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "<string>",
        "organizationStatus": "<string>",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "<string>",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "organizationId": "<string>",
      "production": true,
      "status": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "statusId": "<string>",
    "statusType": "<string>",
    "templateArticleId": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "projectId": "<string>",
  "slug": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<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": [
      {
        "actions": [
          {
            "label": "<string>",
            "properties": {},
            "type": "<string>",
            "uuid": "<string>"
          }
        ],
        "availablePanels": {},
        "dataFormRef": "<string>",
        "properties": {}
      }
    ],
    "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": {},
    "workspaceId": "<string>"
  },
  "name": "<string>",
  "planTemplate": {
    "items": [
      {
        "allowedOutcomes": [
          "<string>"
        ],
        "approvalCriteria": {},
        "approverRole": "<string>",
        "condition": {},
        "dependsOn": [
          "<string>"
        ],
        "hideLock": true,
        "maxStepsToInsert": 123,
        "moduleRef": "<string>",
        "name": "<string>",
        "options": {},
        "plannerContext": {},
        "taskData": {
          "actions": [
            {
              "label": "<string>",
              "properties": {},
              "type": "<string>",
              "uuid": "<string>"
            }
          ],
          "description": "<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": [
            {
              "actions": [
                {
                  "label": "<string>",
                  "properties": {},
                  "type": "<string>",
                  "uuid": "<string>"
                }
              ],
              "availablePanels": {},
              "dataFormRef": "<string>",
              "properties": {}
            }
          ],
          "panelProperties": {},
          "priority": 123,
          "properties": {},
          "title": "<string>"
        },
        "taskStatusSlug": "<string>",
        "taskTemplateRef": "<string>"
      }
    ]
  },
  "planned": true,
  "project": {
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "dataFlow": {
      "edges": [
        {
          "id": "<string>",
          "properties": {},
          "source": "<string>",
          "target": "<string>"
        }
      ],
      "nodes": [
        {
          "dimensions": {
            "height": 123,
            "width": 123
          },
          "id": "<string>",
          "parentId": "<string>",
          "position": {
            "x": 123,
            "y": 123
          },
          "properties": {},
          "type": "<string>"
        }
      ],
      "viewPort": {
        "x": 123,
        "y": 123,
        "zoom": 123
      }
    },
    "description": "<string>",
    "id": "<string>",
    "memory": {
      "changeSequence": 123,
      "orderedDashboards": [
        "<string>"
      ],
      "recentFilters": {},
      "recentQueries": {}
    },
    "name": "<string>",
    "notes": "<string>",
    "options": {
      "dataOptions": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": [
            {}
          ],
          "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": [
            {}
          ],
          "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": {}
    },
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "<string>",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "<string>",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "<string>",
      "organizationStatus": "<string>",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "<string>",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "organizationId": "<string>",
    "owner": {
      "active": true,
      "bio": "<string>",
      "businessGroup": "<string>",
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "firstName": "<string>",
      "groupsJson": "<string>",
      "id": "<string>",
      "image": "<string>",
      "isExternallyManaged": true,
      "lastName": "<string>",
      "preferences": {
        "showOnboarding": true,
        "showScrollbars": true,
        "showWelcomeMessage": true
      },
      "roles": {
        "roles": [
          "<string>"
        ]
      },
      "rolesJson": "<string>",
      "searchText": "<string>",
      "showDeveloperTools": true,
      "title": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "userStorage": {
        "favoriteLinks": [
          {
            "link": "<string>"
          }
        ]
      },
      "userType": "<string>",
      "uuid": "<string>"
    },
    "ownerId": "<string>",
    "projectTemplateRef": "<string>",
    "searchText": "<string>",
    "slug": "<string>",
    "status": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "id": "<string>",
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "<string>",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "<string>",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "<string>",
        "organizationStatus": "<string>",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "<string>",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "organizationId": "<string>",
      "production": true,
      "status": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "statusId": "<string>",
    "statusType": "<string>",
    "templateArticleId": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "projectId": "<string>",
  "slug": "<string>",
  "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.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

A task template defines a reusable task configuration with default values.

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
id
string
​
metadata
object
​
name
string
​
planTemplate
object
​
planned
boolean | null
​
project
object
​
projectId
string | null
​
slug
string
​
updatedOn
string<date-time>
​
uuid
string

Response

Updated TaskTemplate

A task template defines a reusable task configuration with default values.

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
id
string
​
metadata
object
​
name
string
​
planTemplate
object
​
planned
boolean | null
​
project
object
​
projectId
string | null
​
slug
string
​
updatedOn
string<date-time>
​
uuid
string