Skip to main content
PUT
/
api
/
notes
/
{id}
Update Note
curl --request PUT \
  --url https://platform.kodexa.ai/api/notes/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "attribute": "aSDinaTvuI8gbWludGxpZnk=",
  "author": "aSDinaTvuI8gbWludGxpZnk=",
  "changeSequence": 123,
  "content": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "dataObject": {
    "cellIndex": 123,
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "dateTime": "2023-11-07T05:31:56Z",
    "deleted": true,
    "documentFamily": {
      "activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
      "changeSequence": 123,
      "created": "2023-11-07T05:31:56Z",
      "createdOn": "2023-11-07T05:31:56Z",
      "deleteUserEmail": "<string>",
      "deleted": true,
      "deletedDate": "2023-11-07T05:31:56Z",
      "documentStatus": "<string>",
      "documentTaxonValidations": [
        {
          "taxonPath": "<string>",
          "taxonomyRef": "<string>",
          "validation": {
            "conditional": true,
            "conditionalFormula": "<string>",
            "description": "<string>",
            "detailFormula": "<string>",
            "disabled": true,
            "exceptionId": "<string>",
            "messageFormula": "<string>",
            "name": "<string>",
            "overridable": true,
            "ruleFormula": "<string>",
            "supportArticleId": "<string>"
          }
        }
      ],
      "executionTargets": {
        "instances": [
          {
            "actor": {
              "actorId": "<string>",
              "actorType": "<string>"
            },
            "contentObjectId": "<string>",
            "documentFamilyId": "<string>",
            "labelsToApply": [
              "<string>"
            ],
            "ref": "<string>",
            "taxonomyRefs": [
              "<string>"
            ],
            "type": "<string>"
          }
        ]
      },
      "id": "<string>",
      "labelStatistics": {
        "averageLabelConfidence": {},
        "labelCounts": {},
        "maxLabelConfidence": {},
        "minLabelConfidence": {}
      },
      "locked": true,
      "metadata": {},
      "metadataSource": {},
      "modified": "2023-11-07T05:31:56Z",
      "numberOfContentExceptions": 123,
      "numberOfInsights": 123,
      "numberOfNotes": 123,
      "originalPath": "<string>",
      "path": "<string>",
      "pendingProcessing": true,
      "size": 123,
      "storeRef": "<string>",
      "summary": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "documentFamilyId": "<string>",
    "groupUuid": "<string>",
    "id": "<string>",
    "lineage": {
      "attributeValidations": {},
      "contentObjectId": "<string>",
      "documentFamilyId": "<string>",
      "executionId": "<string>",
      "storeRef": "<string>",
      "validations": [
        {
          "conditional": true,
          "conditionalFormula": "<string>",
          "description": "<string>",
          "detailFormula": "<string>",
          "disabled": true,
          "exceptionId": "<string>",
          "messageFormula": "<string>",
          "name": "<string>",
          "overridable": true,
          "ruleFormula": "<string>",
          "supportArticleId": "<string>"
        }
      ]
    },
    "path": "<string>",
    "sourceOrdering": "<string>",
    "storeRef": "<string>",
    "taxonomyRef": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "dataObjectId": "<string>",
  "documentFamily": {
    "activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
    "changeSequence": 123,
    "created": "2023-11-07T05:31:56Z",
    "createdOn": "2023-11-07T05:31:56Z",
    "deleteUserEmail": "<string>",
    "deleted": true,
    "deletedDate": "2023-11-07T05:31:56Z",
    "documentStatus": "<string>",
    "documentTaxonValidations": [
      {
        "taxonPath": "<string>",
        "taxonomyRef": "<string>",
        "validation": {
          "conditional": true,
          "conditionalFormula": "<string>",
          "description": "<string>",
          "detailFormula": "<string>",
          "disabled": true,
          "exceptionId": "<string>",
          "messageFormula": "<string>",
          "name": "<string>",
          "overridable": true,
          "ruleFormula": "<string>",
          "supportArticleId": "<string>"
        }
      }
    ],
    "executionTargets": {
      "instances": [
        {
          "actor": {
            "actorId": "<string>",
            "actorType": "<string>"
          },
          "contentObjectId": "<string>",
          "documentFamilyId": "<string>",
          "labelsToApply": [
            "<string>"
          ],
          "ref": "<string>",
          "taxonomyRefs": [
            "<string>"
          ],
          "type": "<string>"
        }
      ]
    },
    "id": "<string>",
    "labelStatistics": {
      "averageLabelConfidence": {},
      "labelCounts": {},
      "maxLabelConfidence": {},
      "minLabelConfidence": {}
    },
    "locked": true,
    "metadata": {},
    "metadataSource": {},
    "modified": "2023-11-07T05:31:56Z",
    "numberOfContentExceptions": 123,
    "numberOfInsights": 123,
    "numberOfNotes": 123,
    "originalPath": "<string>",
    "path": "<string>",
    "pendingProcessing": true,
    "size": 123,
    "storeRef": "<string>",
    "summary": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "documentFamilyId": "<string>",
  "id": "<string>",
  "noteType": "<string>",
  "properties": {},
  "slug": "<string>",
  "task": {
    "assignee": "aSDinaTvuI8gbWludGxpZnk=",
    "assigneeId": "<string>",
    "changeSequence": 123,
    "completedDate": "2023-11-07T05:31:56Z",
    "createdOn": "2023-11-07T05:31:56Z",
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deleted": true,
    "deletedDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "locked": true,
    "metadata": {
      "dataProperties": {}
    },
    "parentTask": {},
    "parentTaskId": "<string>",
    "priority": 123,
    "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>",
    "properties": {},
    "searchText": "<string>",
    "signal": {
      "metadata": {},
      "notes": "<string>",
      "outcome": "<string>",
      "requestedItems": [
        {}
      ]
    },
    "status": "<string>",
    "statusId": "<string>",
    "taskActivities": [
      {
        "changeSequence": 123,
        "content": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "detail": {
          "interpolatedValues": {},
          "type": "<string>"
        },
        "id": "<string>",
        "searchText": "<string>",
        "task": {},
        "taskId": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "user": "aSDinaTvuI8gbWludGxpZnk=",
        "userId": "<string>",
        "uuid": "<string>"
      }
    ],
    "template": {
      "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>"
    },
    "templateId": "<string>",
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "taskId": "<string>",
  "title": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "attribute": "aSDinaTvuI8gbWludGxpZnk=",
  "author": "aSDinaTvuI8gbWludGxpZnk=",
  "changeSequence": 123,
  "content": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "dataObject": {
    "cellIndex": 123,
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "dateTime": "2023-11-07T05:31:56Z",
    "deleted": true,
    "documentFamily": {
      "activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
      "changeSequence": 123,
      "created": "2023-11-07T05:31:56Z",
      "createdOn": "2023-11-07T05:31:56Z",
      "deleteUserEmail": "<string>",
      "deleted": true,
      "deletedDate": "2023-11-07T05:31:56Z",
      "documentStatus": "<string>",
      "documentTaxonValidations": [
        {
          "taxonPath": "<string>",
          "taxonomyRef": "<string>",
          "validation": {
            "conditional": true,
            "conditionalFormula": "<string>",
            "description": "<string>",
            "detailFormula": "<string>",
            "disabled": true,
            "exceptionId": "<string>",
            "messageFormula": "<string>",
            "name": "<string>",
            "overridable": true,
            "ruleFormula": "<string>",
            "supportArticleId": "<string>"
          }
        }
      ],
      "executionTargets": {
        "instances": [
          {
            "actor": {
              "actorId": "<string>",
              "actorType": "<string>"
            },
            "contentObjectId": "<string>",
            "documentFamilyId": "<string>",
            "labelsToApply": [
              "<string>"
            ],
            "ref": "<string>",
            "taxonomyRefs": [
              "<string>"
            ],
            "type": "<string>"
          }
        ]
      },
      "id": "<string>",
      "labelStatistics": {
        "averageLabelConfidence": {},
        "labelCounts": {},
        "maxLabelConfidence": {},
        "minLabelConfidence": {}
      },
      "locked": true,
      "metadata": {},
      "metadataSource": {},
      "modified": "2023-11-07T05:31:56Z",
      "numberOfContentExceptions": 123,
      "numberOfInsights": 123,
      "numberOfNotes": 123,
      "originalPath": "<string>",
      "path": "<string>",
      "pendingProcessing": true,
      "size": 123,
      "storeRef": "<string>",
      "summary": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "documentFamilyId": "<string>",
    "groupUuid": "<string>",
    "id": "<string>",
    "lineage": {
      "attributeValidations": {},
      "contentObjectId": "<string>",
      "documentFamilyId": "<string>",
      "executionId": "<string>",
      "storeRef": "<string>",
      "validations": [
        {
          "conditional": true,
          "conditionalFormula": "<string>",
          "description": "<string>",
          "detailFormula": "<string>",
          "disabled": true,
          "exceptionId": "<string>",
          "messageFormula": "<string>",
          "name": "<string>",
          "overridable": true,
          "ruleFormula": "<string>",
          "supportArticleId": "<string>"
        }
      ]
    },
    "path": "<string>",
    "sourceOrdering": "<string>",
    "storeRef": "<string>",
    "taxonomyRef": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "dataObjectId": "<string>",
  "documentFamily": {
    "activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
    "changeSequence": 123,
    "created": "2023-11-07T05:31:56Z",
    "createdOn": "2023-11-07T05:31:56Z",
    "deleteUserEmail": "<string>",
    "deleted": true,
    "deletedDate": "2023-11-07T05:31:56Z",
    "documentStatus": "<string>",
    "documentTaxonValidations": [
      {
        "taxonPath": "<string>",
        "taxonomyRef": "<string>",
        "validation": {
          "conditional": true,
          "conditionalFormula": "<string>",
          "description": "<string>",
          "detailFormula": "<string>",
          "disabled": true,
          "exceptionId": "<string>",
          "messageFormula": "<string>",
          "name": "<string>",
          "overridable": true,
          "ruleFormula": "<string>",
          "supportArticleId": "<string>"
        }
      }
    ],
    "executionTargets": {
      "instances": [
        {
          "actor": {
            "actorId": "<string>",
            "actorType": "<string>"
          },
          "contentObjectId": "<string>",
          "documentFamilyId": "<string>",
          "labelsToApply": [
            "<string>"
          ],
          "ref": "<string>",
          "taxonomyRefs": [
            "<string>"
          ],
          "type": "<string>"
        }
      ]
    },
    "id": "<string>",
    "labelStatistics": {
      "averageLabelConfidence": {},
      "labelCounts": {},
      "maxLabelConfidence": {},
      "minLabelConfidence": {}
    },
    "locked": true,
    "metadata": {},
    "metadataSource": {},
    "modified": "2023-11-07T05:31:56Z",
    "numberOfContentExceptions": 123,
    "numberOfInsights": 123,
    "numberOfNotes": 123,
    "originalPath": "<string>",
    "path": "<string>",
    "pendingProcessing": true,
    "size": 123,
    "storeRef": "<string>",
    "summary": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "documentFamilyId": "<string>",
  "id": "<string>",
  "noteType": "<string>",
  "properties": {},
  "slug": "<string>",
  "task": {
    "assignee": "aSDinaTvuI8gbWludGxpZnk=",
    "assigneeId": "<string>",
    "changeSequence": 123,
    "completedDate": "2023-11-07T05:31:56Z",
    "createdOn": "2023-11-07T05:31:56Z",
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deleted": true,
    "deletedDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "locked": true,
    "metadata": {
      "dataProperties": {}
    },
    "parentTask": {},
    "parentTaskId": "<string>",
    "priority": 123,
    "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>",
    "properties": {},
    "searchText": "<string>",
    "signal": {
      "metadata": {},
      "notes": "<string>",
      "outcome": "<string>",
      "requestedItems": [
        {}
      ]
    },
    "status": "<string>",
    "statusId": "<string>",
    "taskActivities": [
      {
        "changeSequence": 123,
        "content": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "detail": {
          "interpolatedValues": {},
          "type": "<string>"
        },
        "id": "<string>",
        "searchText": "<string>",
        "task": {},
        "taskId": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "user": "aSDinaTvuI8gbWludGxpZnk=",
        "userId": "<string>",
        "uuid": "<string>"
      }
    ],
    "template": {
      "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>"
    },
    "templateId": "<string>",
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "taskId": "<string>",
  "title": "<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 note is a comment attached to a document family for collaboration and review.

attribute
string<byte>
author
string<byte>
changeSequence
integer<int32>

Optimistic locking version number.

content
string
createdOn
string<date-time>

Timestamp when the note was created.

dataObject
object
dataObjectId
string | null
documentFamily
object
documentFamilyId
string | null
id
string

Unique identifier (UUID) for the note.

noteType
string
properties
object
slug
string
task
object
taskId
string | null
title
string
updatedOn
string<date-time>

Timestamp when the note was last updated.

uuid
string

Secondary UUID identifier.

Response

Updated Note

A note is a comment attached to a document family for collaboration and review.

attribute
string<byte>
author
string<byte>
changeSequence
integer<int32>

Optimistic locking version number.

content
string
createdOn
string<date-time>

Timestamp when the note was created.

dataObject
object
dataObjectId
string | null
documentFamily
object
documentFamilyId
string | null
id
string

Unique identifier (UUID) for the note.

noteType
string
properties
object
slug
string
task
object
taskId
string | null
title
string
updatedOn
string<date-time>

Timestamp when the note was last updated.

uuid
string

Secondary UUID identifier.