Skip to main content
GET
/
api
/
documentFamilies
/
{id}
cURL
curl --request GET \
  --url http://localhost/api/documentFamilies/{id}
{
  "uuid": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "changeSequence": 123,
  "documentStatus": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "color": "<string>",
    "icon": "<string>",
    "status": "<string>",
    "slug": "<string>",
    "statusType": "UNRESOLVED",
    "id": "<string>"
  },
  "deleted": true,
  "assignment": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "user": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "bio": "<string>",
      "userStorage": {
        "favoriteLinks": "<any>"
      },
      "showDeveloperTools": true,
      "image": "<string>",
      "userHash": "<string>",
      "acceptedTerms": true,
      "userType": "HUMAN",
      "active": true,
      "fullName": "<string>",
      "externallyManaged": true,
      "hasAcceptedTerms": true,
      "id": "<string>",
      "security": {
        "roles": "<any>"
      },
      "preferences": {
        "showWelcomeMessage": "<any>",
        "showOnboarding": "<any>",
        "showScrollbars": "<any>"
      }
    },
    "assignedAt": "2023-11-07T05:31:56Z",
    "releaseAt": "2023-11-07T05:31:56Z",
    "id": "<string>"
  },
  "storeRef": "<string>",
  "path": "<string>",
  "locked": true,
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "size": 123,
  "numberOfNotes": 123,
  "numberOfInsights": 123,
  "numberOfContentExceptions": 123,
  "contentObjects": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "contentType": "DOCUMENT",
      "documentVersion": "<string>",
      "index": 123,
      "metadata": {},
      "mixins": [
        "<any>"
      ],
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "size": 123,
      "storeRef": "<string>",
      "documentTaxonValidations": [
        "<any>"
      ],
      "documentFamilyId": "<string>",
      "id": "<string>"
    }
  ],
  "contentExceptions": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "tag": "<string>",
      "message": "<string>",
      "exceptionType": "<string>",
      "severity": "<string>",
      "exceptionDetails": "<string>",
      "groupUuid": "<string>",
      "tagUuid": "<string>",
      "id": "<string>"
    }
  ],
  "transitions": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "transitionType": "DERIVED",
      "index": 123,
      "dateTime": "2023-11-07T05:31:56Z",
      "actor": {
        "actorId": "<string>",
        "actorType": "USER"
      },
      "label": "<string>",
      "sourceContentObjectId": "<string>",
      "destinationContentObjectId": "<string>",
      "ignoredValues": {},
      "id": "<string>"
    }
  ],
  "taxonomies": [
    {
      "template": true,
      "deprecated": true,
      "ref": "<string>",
      "changeSequence": 123,
      "organization": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "name": "<string>",
        "slug": "<string>",
        "publicAccess": true,
        "description": "<string>",
        "organizationStatus": "ACTIVE",
        "hasImage": true,
        "defaultToPrivateTemplates": true,
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "stripeCustomerId": "<string>",
        "enterpriseOrganization": true,
        "id": "<string>"
      },
      "slug": "<string>",
      "extensionPackRef": "<string>",
      "id": "<string>",
      "uuid": "<string>",
      "version": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "publicAccess": true,
      "projects": [
        {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "organization": {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "name": "<string>",
            "slug": "<string>",
            "publicAccess": true,
            "description": "<string>",
            "organizationStatus": "ACTIVE",
            "hasImage": true,
            "defaultToPrivateTemplates": true,
            "supportAccess": true,
            "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
            "stripeCustomerId": "<string>",
            "enterpriseOrganization": true,
            "id": "<string>"
          },
          "name": "<string>",
          "description": "<string>",
          "owner": {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "email": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "bio": "<string>",
            "userStorage": {
              "favoriteLinks": "<any>"
            },
            "showDeveloperTools": true,
            "image": "<string>",
            "userHash": "<string>",
            "acceptedTerms": true,
            "userType": "HUMAN",
            "active": true,
            "fullName": "<string>",
            "externallyManaged": true,
            "hasAcceptedTerms": true,
            "id": "<string>",
            "security": {
              "roles": "<any>"
            },
            "preferences": {
              "showWelcomeMessage": "<any>",
              "showOnboarding": "<any>",
              "showScrollbars": "<any>"
            }
          },
          "status": {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "organization": {
              "uuid": "<any>",
              "createdOn": "<any>",
              "updatedOn": "<any>",
              "changeSequence": "<any>",
              "name": "<any>",
              "slug": "<any>",
              "publicAccess": "<any>",
              "description": "<any>",
              "organizationStatus": "<any>",
              "hasImage": "<any>",
              "defaultToPrivateTemplates": "<any>",
              "supportAccess": "<any>",
              "supportAccessExpiresAt": "<any>",
              "stripeCustomerId": "<any>",
              "enterpriseOrganization": "<any>",
              "id": "<any>"
            },
            "color": "<string>",
            "icon": "<string>",
            "status": "<string>",
            "production": true,
            "id": "<string>"
          },
          "templateArticleId": "<string>",
          "projectTemplateRef": "<string>",
          "notes": "<string>",
          "color": "<string>",
          "tags": [
            {
              "uuid": "<any>",
              "createdOn": "<any>",
              "updatedOn": "<any>",
              "changeSequence": "<any>",
              "organization": "<any>",
              "name": "<any>",
              "color": "<any>",
              "id": "<any>"
            }
          ],
          "dataFlow": {
            "viewPort": {
              "x": "<any>",
              "y": "<any>",
              "zoom": "<any>"
            },
            "nodes": [
              "<any>"
            ],
            "edges": [
              "<any>"
            ]
          },
          "options": {
            "options": [
              "<any>"
            ],
            "properties": {},
            "groupTaxonTypeFeatures": {},
            "taxonTypeFeatures": {},
            "taskOptions": {
              "showTakeNext": "<any>",
              "showNewTask": "<any>"
            }
          },
          "documentStatuses": [
            {
              "uuid": "<any>",
              "createdOn": "<any>",
              "updatedOn": "<any>",
              "changeSequence": "<any>",
              "color": "<any>",
              "icon": "<any>",
              "status": "<any>",
              "slug": "<any>",
              "statusType": "<any>",
              "id": "<any>"
            }
          ],
          "statusType": "ACTIVE",
          "taskStatuses": [
            {
              "uuid": "<any>",
              "createdOn": "<any>",
              "updatedOn": "<any>",
              "changeSequence": "<any>",
              "color": "<any>",
              "icon": "<any>",
              "label": "<any>",
              "slug": "<any>",
              "statusType": "<any>",
              "id": "<any>"
            }
          ],
          "id": "<string>"
        }
      ],
      "metadata": {
        "ref": "<string>",
        "template": true,
        "orgSlug": "<string>",
        "slug": "<string>",
        "type": "<string>",
        "name": "<string>",
        "description": "<string>",
        "version": "<string>",
        "get_id": "<string>",
        "publicAccess": true,
        "imageUrl": "<string>",
        "icon": "<string>",
        "overviewMarkdown": "<string>",
        "provider": "<string>",
        "providerUrl": "<string>",
        "providerImageUrl": "<string>",
        "deleteProtection": true,
        "checksum": "<string>",
        "deprecated": true,
        "extensionPackRef": "<string>",
        "taxonomyType": "CONTENT",
        "enabled": true,
        "externalDataTaxonomyRefs": [
          "<string>"
        ],
        "taxons": [
          {
            "id": "<string>",
            "label": "<string>",
            "order": 123,
            "generateName": true,
            "group": true,
            "name": "<string>",
            "selectWeight": 123,
            "externalName": "<string>",
            "valuePath": "VALUE_OR_ALL_CONTENT",
            "metadataValue": "FILENAME",
            "dataPath": "<string>",
            "expression": "<string>",
            "enableFallbackExpression": true,
            "fallbackExpression": "<string>",
            "enableSerializationExpression": true,
            "serializationExpression": "<string>",
            "nullable": true,
            "nullValue": "<string>",
            "denormalizeToChildren": true,
            "notUserLabelled": true,
            "description": "<string>",
            "overviewMarkdown": "<string>",
            "semanticDefinition": "<string>",
            "synonyms": [
              "<string>"
            ],
            "lexicalRelations": [
              {
                "type": "<any>",
                "value": "<any>",
                "weight": "<any>"
              }
            ],
            "additionContexts": [
              {
                "type": "RECORD_DEFINITION",
                "context": "<string>",
                "weight": 123,
                "negative": true
              }
            ],
            "guideProperties": {
              "guidanceKey": true,
              "guidanceKeyExpression": "<string>",
              "useGuidanceForClassification": true,
              "ifPresentRequired": true
            },
            "enabled": true,
            "color": "<string>",
            "children": [
              {}
            ],
            "options": [
              {
                "groupOptions": "<any>",
                "properties": "<any>",
                "tabName": "<any>",
                "name": "<any>",
                "aliases": "<any>",
                "label": "<any>",
                "falseLabel": "<any>",
                "hint": "<any>",
                "required": "<any>",
                "type": "<any>",
                "subType": "<any>",
                "listType": "<any>",
                "displayProperties": "<any>",
                "listLabel": "<any>",
                "listDescription": "<any>",
                "featureFlag": "<any>",
                "default": "<any>",
                "description": "<any>",
                "supportArticle": "<any>",
                "overviewMarkdown": "<any>",
                "showIf": "<any>",
                "developerOnly": "<any>",
                "showOnPopup": "<any>",
                "possibleValues": "<any>"
              }
            ],
            "nodeTypes": [
              "<string>"
            ],
            "taxonType": "STRING",
            "selectionOptions": [
              {
                "label": "<string>",
                "id": "<string>",
                "description": "<string>",
                "isConditional": true,
                "conditionalFormula": "<string>",
                "lexicalRelations": [
                  {
                    "type": "<any>",
                    "value": "<any>",
                    "weight": "<any>"
                  }
                ]
              }
            ],
            "typeFeatures": {},
            "properties": {},
            "conditionalFormats": [
              {
                "type": "<string>",
                "condition": "<string>",
                "properties": {}
              }
            ],
            "validationRules": [
              {
                "name": "<string>",
                "disabled": true,
                "description": "<string>",
                "conditional": true,
                "conditionalFormula": "<string>",
                "ruleFormula": "<string>",
                "messageFormula": "<string>",
                "detailFormula": "<string>",
                "exceptionId": "<string>",
                "supportArticleId": "<string>",
                "overridable": true
              }
            ],
            "cardinality": "ONCE_PER_DOCUMENT",
            "path": "<string>",
            "multiValue": true,
            "userEditable": true,
            "usePostExpression": true,
            "postExpression": "<string>"
          }
        ],
        "totalTaxons": 123
      }
    }
  ],
  "labels": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "organization": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "name": "<string>",
        "slug": "<string>",
        "publicAccess": true,
        "description": "<string>",
        "organizationStatus": "ACTIVE",
        "hasImage": true,
        "defaultToPrivateTemplates": true,
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "stripeCustomerId": "<string>",
        "enterpriseOrganization": true,
        "id": "<string>"
      },
      "name": "<string>",
      "color": "<string>",
      "label": "<string>",
      "id": "<string>"
    }
  ],
  "activeAssistant": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "subscription": "<string>",
    "slug": "<string>",
    "schedules": [
      {
        "type": "<string>",
        "cronExpression": "<string>",
        "lastEvent": "2023-11-07T05:31:56Z",
        "nextEvent": "2023-11-07T05:31:56Z",
        "id": "<string>"
      }
    ],
    "project": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "organization": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "name": "<string>",
        "slug": "<string>",
        "publicAccess": true,
        "description": "<string>",
        "organizationStatus": "ACTIVE",
        "hasImage": true,
        "defaultToPrivateTemplates": true,
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "stripeCustomerId": "<string>",
        "enterpriseOrganization": true,
        "id": "<string>"
      },
      "name": "<string>",
      "description": "<string>",
      "owner": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "bio": "<string>",
        "userStorage": {
          "favoriteLinks": "<any>"
        },
        "showDeveloperTools": true,
        "image": "<string>",
        "userHash": "<string>",
        "acceptedTerms": true,
        "userType": "HUMAN",
        "active": true,
        "fullName": "<string>",
        "externallyManaged": true,
        "hasAcceptedTerms": true,
        "id": "<string>",
        "security": {
          "roles": "<any>"
        },
        "preferences": {
          "showWelcomeMessage": "<any>",
          "showOnboarding": "<any>",
          "showScrollbars": "<any>"
        }
      },
      "status": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "organization": {
          "uuid": "<any>",
          "createdOn": "<any>",
          "updatedOn": "<any>",
          "changeSequence": "<any>",
          "name": "<any>",
          "slug": "<any>",
          "publicAccess": "<any>",
          "description": "<any>",
          "organizationStatus": "<any>",
          "hasImage": "<any>",
          "defaultToPrivateTemplates": "<any>",
          "supportAccess": "<any>",
          "supportAccessExpiresAt": "<any>",
          "stripeCustomerId": "<any>",
          "enterpriseOrganization": "<any>",
          "id": "<any>"
        },
        "color": "<string>",
        "icon": "<string>",
        "status": "<string>",
        "production": true,
        "id": "<string>"
      },
      "templateArticleId": "<string>",
      "projectTemplateRef": "<string>",
      "notes": "<string>",
      "color": "<string>",
      "tags": [
        {
          "uuid": "<any>",
          "createdOn": "<any>",
          "updatedOn": "<any>",
          "changeSequence": "<any>",
          "organization": "<any>",
          "name": "<any>",
          "color": "<any>",
          "id": "<any>"
        }
      ],
      "dataFlow": {
        "viewPort": {
          "x": "<any>",
          "y": "<any>",
          "zoom": "<any>"
        },
        "nodes": [
          "<any>"
        ],
        "edges": [
          "<any>"
        ]
      },
      "options": {
        "options": [
          "<any>"
        ],
        "properties": {},
        "groupTaxonTypeFeatures": {},
        "taxonTypeFeatures": {},
        "taskOptions": {
          "showTakeNext": "<any>",
          "showNewTask": "<any>"
        }
      },
      "documentStatuses": [
        {
          "uuid": "<any>",
          "createdOn": "<any>",
          "updatedOn": "<any>",
          "changeSequence": "<any>",
          "color": "<any>",
          "icon": "<any>",
          "status": "<any>",
          "slug": "<any>",
          "statusType": "<any>",
          "id": "<any>"
        }
      ],
      "statusType": "ACTIVE",
      "taskStatuses": [
        {
          "uuid": "<any>",
          "createdOn": "<any>",
          "updatedOn": "<any>",
          "changeSequence": "<any>",
          "color": "<any>",
          "icon": "<any>",
          "label": "<any>",
          "slug": "<any>",
          "statusType": "<any>",
          "id": "<any>"
        }
      ],
      "id": "<string>"
    },
    "name": "<string>",
    "description": "<string>",
    "deleted": true,
    "assistantDefinitionRef": "<string>",
    "loggingEnabled": true,
    "deleteLoggingOnSuccess": true,
    "showInTraining": true,
    "chatEnabled": true,
    "assistantRole": "<string>",
    "active": true,
    "runOnExistingContent": true,
    "priorityHint": 123,
    "options": {},
    "color": "<string>",
    "testOptions": {},
    "validationErrors": {
      "instances": [
        {
          "message": "<any>",
          "option": "<any>",
          "description": "<any>"
        }
      ]
    },
    "id": "<string>",
    "definition": {
      "ref": "<string>",
      "template": true,
      "orgSlug": "<string>",
      "slug": "<string>",
      "type": "<string>",
      "name": "<string>",
      "description": "<string>",
      "version": "<string>",
      "get_id": "<string>",
      "publicAccess": true,
      "imageUrl": "<string>",
      "icon": "<string>",
      "overviewMarkdown": "<string>",
      "provider": "<string>",
      "providerUrl": "<string>",
      "providerImageUrl": "<string>",
      "deleteProtection": true,
      "checksum": "<string>",
      "deprecated": true,
      "extensionPackRef": "<string>",
      "schedulable": true,
      "reactive": true,
      "assistant": {
        "package": "<string>",
        "class": "<string>"
      },
      "services": [
        {
          "ref": "<any>",
          "template": "<any>",
          "orgSlug": "<any>",
          "slug": "<any>",
          "type": "<any>",
          "name": "<any>",
          "description": "<any>",
          "version": "<any>",
          "get_id": "<any>",
          "publicAccess": "<any>",
          "imageUrl": "<any>",
          "icon": "<any>",
          "overviewMarkdown": "<any>",
          "provider": "<any>",
          "providerUrl": "<any>",
          "providerImageUrl": "<any>",
          "deleteProtection": "<any>",
          "checksum": "<any>",
          "deprecated": "<any>"
        }
      ],
      "processingTaxonomies": [
        {
          "ref": "<any>"
        }
      ],
      "options": [
        {
          "groupOptions": "<any>",
          "properties": "<any>",
          "tabName": "<any>",
          "name": "<any>",
          "aliases": "<any>",
          "label": "<any>",
          "falseLabel": "<any>",
          "hint": "<any>",
          "required": "<any>",
          "type": "<any>",
          "subType": "<any>",
          "listType": "<any>",
          "displayProperties": "<any>",
          "listLabel": "<any>",
          "listDescription": "<any>",
          "featureFlag": "<any>",
          "default": "<any>",
          "description": "<any>",
          "supportArticle": "<any>",
          "overviewMarkdown": "<any>",
          "showIf": "<any>",
          "developerOnly": "<any>",
          "showOnPopup": "<any>",
          "possibleValues": "<any>"
        }
      ],
      "optionTabs": [
        {
          "name": "<any>",
          "description": "<any>",
          "icon": "<any>",
          "optionNames": "<any>",
          "showInTraining": "<any>",
          "showIf": "<any>"
        }
      ],
      "additionalTaxonOptions": [
        {
          "groupOptions": "<any>",
          "properties": "<any>",
          "tabName": "<any>",
          "name": "<any>",
          "aliases": "<any>",
          "label": "<any>",
          "falseLabel": "<any>",
          "hint": "<any>",
          "required": "<any>",
          "type": "<any>",
          "subType": "<any>",
          "listType": "<any>",
          "displayProperties": "<any>",
          "listLabel": "<any>",
          "listDescription": "<any>",
          "featureFlag": "<any>",
          "default": "<any>",
          "description": "<any>",
          "supportArticle": "<any>",
          "overviewMarkdown": "<any>",
          "showIf": "<any>",
          "developerOnly": "<any>",
          "showOnPopup": "<any>",
          "possibleValues": "<any>"
        }
      ],
      "taxonFeatures": [
        {
          "taxonPath": "<any>",
          "groupOnly": "<any>",
          "options": "<any>"
        }
      ],
      "eventTypes": [
        {
          "name": "<any>",
          "icon": "<any>",
          "label": "<any>",
          "description": "<any>",
          "contentObject": "<any>",
          "entryPoints": "<any>",
          "optionTabs": "<any>",
          "options": "<any>"
        }
      ],
      "defaultSchedules": [
        {
          "type": "<any>",
          "cronExpression": "<any>",
          "lastEvent": "<any>",
          "nextEvent": "<any>"
        }
      ],
      "subscription": "<string>"
    }
  },
  "mixins": [
    "<string>"
  ],
  "metadata": {},
  "guidance": true,
  "labelStatistics": {
    "labelCounts": {},
    "averageLabelConfidence": {},
    "maxLabelConfidence": {},
    "minLabelConfidence": {}
  },
  "metadataSource": {},
  "statistics": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "pathCounts": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "taxonomyId": "<string>",
        "path": "<string>",
        "label": "<string>",
        "count": 123,
        "exceptionCount": 123,
        "id": "<string>"
      }
    ],
    "recentExecutions": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "assistant": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "subscription": "<string>",
          "slug": "<string>",
          "schedules": [
            {
              "type": "<string>",
              "cronExpression": "<string>",
              "lastEvent": "2023-11-07T05:31:56Z",
              "nextEvent": "2023-11-07T05:31:56Z",
              "id": "<string>"
            }
          ],
          "project": {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "organization": {
              "uuid": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "changeSequence": 123,
              "name": "<string>",
              "slug": "<string>",
              "publicAccess": true,
              "description": "<string>",
              "organizationStatus": "ACTIVE",
              "hasImage": true,
              "defaultToPrivateTemplates": true,
              "supportAccess": true,
              "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
              "stripeCustomerId": "<string>",
              "enterpriseOrganization": true,
              "id": "<string>"
            },
            "name": "<string>",
            "description": "<string>",
            "owner": {
              "uuid": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "changeSequence": 123,
              "email": "<string>",
              "firstName": "<string>",
              "lastName": "<string>",
              "bio": "<string>",
              "userStorage": {
                "favoriteLinks": "<any>"
              },
              "showDeveloperTools": true,
              "image": "<string>",
              "userHash": "<string>",
              "acceptedTerms": true,
              "userType": "HUMAN",
              "active": true,
              "fullName": "<string>",
              "externallyManaged": true,
              "hasAcceptedTerms": true,
              "id": "<string>",
              "security": {
                "roles": "<any>"
              },
              "preferences": {
                "showWelcomeMessage": "<any>",
                "showOnboarding": "<any>",
                "showScrollbars": "<any>"
              }
            },
            "status": {
              "uuid": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "changeSequence": 123,
              "organization": {
                "uuid": "<any>",
                "createdOn": "<any>",
                "updatedOn": "<any>",
                "changeSequence": "<any>",
                "name": "<any>",
                "slug": "<any>",
                "publicAccess": "<any>",
                "description": "<any>",
                "organizationStatus": "<any>",
                "hasImage": "<any>",
                "defaultToPrivateTemplates": "<any>",
                "supportAccess": "<any>",
                "supportAccessExpiresAt": "<any>",
                "stripeCustomerId": "<any>",
                "enterpriseOrganization": "<any>",
                "id": "<any>"
              },
              "color": "<string>",
              "icon": "<string>",
              "status": "<string>",
              "production": true,
              "id": "<string>"
            },
            "templateArticleId": "<string>",
            "projectTemplateRef": "<string>",
            "notes": "<string>",
            "color": "<string>",
            "tags": [
              {
                "uuid": "<any>",
                "createdOn": "<any>",
                "updatedOn": "<any>",
                "changeSequence": "<any>",
                "organization": "<any>",
                "name": "<any>",
                "color": "<any>",
                "id": "<any>"
              }
            ],
            "dataFlow": {
              "viewPort": {
                "x": "<any>",
                "y": "<any>",
                "zoom": "<any>"
              },
              "nodes": [
                "<any>"
              ],
              "edges": [
                "<any>"
              ]
            },
            "options": {
              "options": [
                "<any>"
              ],
              "properties": {},
              "groupTaxonTypeFeatures": {},
              "taxonTypeFeatures": {},
              "taskOptions": {
                "showTakeNext": "<any>",
                "showNewTask": "<any>"
              }
            },
            "documentStatuses": [
              {
                "uuid": "<any>",
                "createdOn": "<any>",
                "updatedOn": "<any>",
                "changeSequence": "<any>",
                "color": "<any>",
                "icon": "<any>",
                "status": "<any>",
                "slug": "<any>",
                "statusType": "<any>",
                "id": "<any>"
              }
            ],
            "statusType": "ACTIVE",
            "taskStatuses": [
              {
                "uuid": "<any>",
                "createdOn": "<any>",
                "updatedOn": "<any>",
                "changeSequence": "<any>",
                "color": "<any>",
                "icon": "<any>",
                "label": "<any>",
                "slug": "<any>",
                "statusType": "<any>",
                "id": "<any>"
              }
            ],
            "id": "<string>"
          },
          "name": "<string>",
          "description": "<string>",
          "deleted": true,
          "assistantDefinitionRef": "<string>",
          "loggingEnabled": true,
          "deleteLoggingOnSuccess": true,
          "showInTraining": true,
          "chatEnabled": true,
          "assistantRole": "<string>",
          "active": true,
          "runOnExistingContent": true,
          "priorityHint": 123,
          "options": {},
          "color": "<string>",
          "testOptions": {},
          "validationErrors": {
            "instances": [
              {
                "message": "<any>",
                "option": "<any>",
                "description": "<any>"
              }
            ]
          },
          "id": "<string>",
          "definition": {
            "ref": "<string>",
            "template": true,
            "orgSlug": "<string>",
            "slug": "<string>",
            "type": "<string>",
            "name": "<string>",
            "description": "<string>",
            "version": "<string>",
            "get_id": "<string>",
            "publicAccess": true,
            "imageUrl": "<string>",
            "icon": "<string>",
            "overviewMarkdown": "<string>",
            "provider": "<string>",
            "providerUrl": "<string>",
            "providerImageUrl": "<string>",
            "deleteProtection": true,
            "checksum": "<string>",
            "deprecated": true,
            "extensionPackRef": "<string>",
            "schedulable": true,
            "reactive": true,
            "assistant": {
              "package": "<string>",
              "class": "<string>"
            },
            "services": [
              {
                "ref": "<any>",
                "template": "<any>",
                "orgSlug": "<any>",
                "slug": "<any>",
                "type": "<any>",
                "name": "<any>",
                "description": "<any>",
                "version": "<any>",
                "get_id": "<any>",
                "publicAccess": "<any>",
                "imageUrl": "<any>",
                "icon": "<any>",
                "overviewMarkdown": "<any>",
                "provider": "<any>",
                "providerUrl": "<any>",
                "providerImageUrl": "<any>",
                "deleteProtection": "<any>",
                "checksum": "<any>",
                "deprecated": "<any>"
              }
            ],
            "processingTaxonomies": [
              {
                "ref": "<any>"
              }
            ],
            "options": [
              {
                "groupOptions": "<any>",
                "properties": "<any>",
                "tabName": "<any>",
                "name": "<any>",
                "aliases": "<any>",
                "label": "<any>",
                "falseLabel": "<any>",
                "hint": "<any>",
                "required": "<any>",
                "type": "<any>",
                "subType": "<any>",
                "listType": "<any>",
                "displayProperties": "<any>",
                "listLabel": "<any>",
                "listDescription": "<any>",
                "featureFlag": "<any>",
                "default": "<any>",
                "description": "<any>",
                "supportArticle": "<any>",
                "overviewMarkdown": "<any>",
                "showIf": "<any>",
                "developerOnly": "<any>",
                "showOnPopup": "<any>",
                "possibleValues": "<any>"
              }
            ],
            "optionTabs": [
              {
                "name": "<any>",
                "description": "<any>",
                "icon": "<any>",
                "optionNames": "<any>",
                "showInTraining": "<any>",
                "showIf": "<any>"
              }
            ],
            "additionalTaxonOptions": [
              {
                "groupOptions": "<any>",
                "properties": "<any>",
                "tabName": "<any>",
                "name": "<any>",
                "aliases": "<any>",
                "label": "<any>",
                "falseLabel": "<any>",
                "hint": "<any>",
                "required": "<any>",
                "type": "<any>",
                "subType": "<any>",
                "listType": "<any>",
                "displayProperties": "<any>",
                "listLabel": "<any>",
                "listDescription": "<any>",
                "featureFlag": "<any>",
                "default": "<any>",
                "description": "<any>",
                "supportArticle": "<any>",
                "overviewMarkdown": "<any>",
                "showIf": "<any>",
                "developerOnly": "<any>",
                "showOnPopup": "<any>",
                "possibleValues": "<any>"
              }
            ],
            "taxonFeatures": [
              {
                "taxonPath": "<any>",
                "groupOnly": "<any>",
                "options": "<any>"
              }
            ],
            "eventTypes": [
              {
                "name": "<any>",
                "icon": "<any>",
                "label": "<any>",
                "description": "<any>",
                "contentObject": "<any>",
                "entryPoints": "<any>",
                "optionTabs": "<any>",
                "options": "<any>"
              }
            ],
            "defaultSchedules": [
              {
                "type": "<any>",
                "cronExpression": "<any>",
                "lastEvent": "<any>",
                "nextEvent": "<any>"
              }
            ],
            "subscription": "<string>"
          }
        },
        "execution": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "assistantId": "<string>",
          "description": "<string>",
          "priority": 123,
          "targets": {
            "instances": [
              {
                "type": "DOCUMENT_STORE",
                "ref": "<string>",
                "documentFamilyId": "<string>",
                "contentObjectId": "<string>",
                "actor": {
                  "actorId": "<string>",
                  "actorType": "USER"
                },
                "taxonomyRefs": [
                  "<string>"
                ],
                "labelsToApply": [
                  "<string>"
                ]
              }
            ]
          },
          "session": {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "organization": {
              "uuid": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "changeSequence": 123,
              "name": "<string>",
              "slug": "<string>",
              "publicAccess": true,
              "description": "<string>",
              "organizationStatus": "ACTIVE",
              "hasImage": true,
              "defaultToPrivateTemplates": true,
              "supportAccess": true,
              "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
              "stripeCustomerId": "<string>",
              "enterpriseOrganization": true,
              "id": "<string>"
            },
            "state": "OPEN",
            "token": "<string>",
            "id": "<string>"
          },
          "startDate": "2023-11-07T05:31:56Z",
          "endDate": "2023-11-07T05:31:56Z",
          "processingTime": 123,
          "loggingEnabled": true,
          "deleteLoggingOnSuccess": true,
          "status": "PENDING",
          "exceptionDetails": {
            "message": "<string>",
            "statusCode": 123,
            "errorMessage": "<string>",
            "errorType": "<string>",
            "executedVersion": "<string>",
            "advice": "<string>",
            "description": "<string>",
            "cause": {},
            "documentationUrl": "<string>",
            "stackTrace": [
              "<any>"
            ],
            "help": "<string>",
            "optionErrors": {},
            "validationErrors": [
              "<any>"
            ]
          },
          "statusDetails": {
            "message": "<string>",
            "detail": "<string>",
            "progressMax": 123,
            "progress": 123,
            "stepStatus": {
              "stepId": "<string>",
              "status": "PENDING",
              "statusMessage": "<string>",
              "progressMax": 123,
              "progress": 123
            }
          },
          "pipeline": {
            "valid": true,
            "ref": "<string>",
            "id": "<string>",
            "exceptions": [
              {
                "message": "<string>",
                "statusCode": 123,
                "errorMessage": "<string>",
                "errorType": "<string>",
                "executedVersion": "<string>",
                "advice": "<string>",
                "description": "<string>",
                "cause": {},
                "documentationUrl": "<string>",
                "stackTrace": [
                  "<any>"
                ],
                "help": "<string>",
                "optionErrors": {},
                "validationErrors": [
                  "<any>"
                ]
              }
            ],
            "steps": [
              {
                "id": "<string>",
                "status": "PENDING",
                "exceptionDetails": {
                  "message": "<string>",
                  "statusCode": 123,
                  "errorMessage": "<string>",
                  "errorType": "<string>",
                  "executedVersion": "<string>",
                  "advice": "<string>",
                  "description": "<string>",
                  "cause": {},
                  "documentationUrl": "<string>",
                  "stackTrace": [
                    "<any>"
                  ],
                  "help": "<string>",
                  "optionErrors": {},
                  "validationErrors": [
                    "<any>"
                  ]
                },
                "name": "<string>",
                "statusMessage": "<string>",
                "progressMax": 123,
                "progress": 123,
                "start": "2023-11-07T05:31:56Z",
                "end": "2023-11-07T05:31:56Z",
                "processingTime": 123,
                "options": {},
                "optionTypes": {},
                "context": {},
                "conditional": "<string>",
                "contentObjects": [
                  {
                    "uuid": "<string>",
                    "createdOn": "2023-11-07T05:31:56Z",
                    "updatedOn": "2023-11-07T05:31:56Z",
                    "changeSequence": 123,
                    "contentType": "DOCUMENT",
                    "documentVersion": "<string>",
                    "index": 123,
                    "metadata": {},
                    "mixins": [
                      "<any>"
                    ],
                    "created": "2023-11-07T05:31:56Z",
                    "modified": "2023-11-07T05:31:56Z",
                    "size": 123,
                    "storeRef": "<string>",
                    "documentTaxonValidations": [
                      "<any>"
                    ],
                    "documentFamilyId": "<string>",
                    "id": "<string>"
                  }
                ],
                "inputId": "<string>",
                "outputId": "<string>",
                "outputIds": "<string>",
                "ref": "<string>",
                "extensionPackRef": "<string>",
                "stepType": "ACTION"
              }
            ]
          },
          "parameters": {},
          "customOptions": {},
          "context": {},
          "childExecutions": [
            {}
          ],
          "contentObjects": [
            {
              "uuid": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "changeSequence": 123,
              "contentType": "DOCUMENT",
              "documentVersion": "<string>",
              "index": 123,
              "metadata": {},
              "mixins": [
                "<any>"
              ],
              "created": "2023-11-07T05:31:56Z",
              "modified": "2023-11-07T05:31:56Z",
              "size": 123,
              "storeRef": "<string>",
              "documentTaxonValidations": [
                "<any>"
              ],
              "documentFamilyId": "<string>",
              "id": "<string>"
            }
          ],
          "documentFamily": {},
          "id": "<string>"
        },
        "id": "<string>"
      }
    ],
    "id": "<string>"
  },
  "executionTargets": {
    "instances": [
      {
        "type": "DOCUMENT_STORE",
        "ref": "<string>",
        "documentFamilyId": "<string>",
        "contentObjectId": "<string>",
        "actor": {
          "actorId": "<string>",
          "actorType": "USER"
        },
        "taxonomyRefs": [
          "<string>"
        ],
        "labelsToApply": [
          "<string>"
        ]
      }
    ]
  },
  "summary": "<string>",
  "documentTaxonValidations": [
    {
      "taxonomyRef": "<string>",
      "taxonPath": "<string>",
      "validation": {
        "name": "<string>",
        "disabled": true,
        "description": "<string>",
        "conditional": true,
        "conditionalFormula": "<string>",
        "ruleFormula": "<string>",
        "messageFormula": "<string>",
        "detailFormula": "<string>",
        "exceptionId": "<string>",
        "supportArticleId": "<string>",
        "overridable": true
      }
    }
  ],
  "features": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "featureType": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "organization": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "name": "<string>",
          "slug": "<string>",
          "publicAccess": true,
          "description": "<string>",
          "organizationStatus": "ACTIVE",
          "hasImage": true,
          "defaultToPrivateTemplates": true,
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "stripeCustomerId": "<string>",
          "enterpriseOrganization": true,
          "id": "<string>"
        },
        "name": "<string>",
        "slug": "<string>",
        "description": "<string>",
        "color": "<string>",
        "icon": "<string>",
        "active": true,
        "labelJsonPath": "<string>",
        "options": [
          {
            "groupOptions": "<any>",
            "properties": "<any>",
            "tabName": "<any>",
            "name": "<any>",
            "aliases": "<any>",
            "label": "<any>",
            "falseLabel": "<any>",
            "hint": "<any>",
            "required": "<any>",
            "type": "<any>",
            "subType": "<any>",
            "listType": "<any>",
            "displayProperties": "<any>",
            "listLabel": "<any>",
            "listDescription": "<any>",
            "featureFlag": "<any>",
            "default": "<any>",
            "description": "<any>",
            "supportArticle": "<any>",
            "overviewMarkdown": "<any>",
            "showIf": "<any>",
            "developerOnly": "<any>",
            "showOnPopup": "<any>",
            "possibleValues": "<any>"
          }
        ],
        "id": "<string>"
      },
      "organization": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "name": "<string>",
        "slug": "<string>",
        "publicAccess": true,
        "description": "<string>",
        "organizationStatus": "ACTIVE",
        "hasImage": true,
        "defaultToPrivateTemplates": true,
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "stripeCustomerId": "<string>",
        "enterpriseOrganization": true,
        "id": "<string>"
      },
      "properties": {},
      "active": true,
      "id": "<string>"
    }
  ],
  "id": "<string>"
}

Path Parameters

​
id
string
required

Response

OK

A document family is the representation of a single piece of external content (ie. a PDF) and all the related document representations of that file

​
path
string
required

The path to the document family in the store

​
uuid
string

The UUID of the object

​
createdOn
string<date-time>
​
updatedOn
string<date-time>
​
changeSequence
integer

The change sequence of the object, which can be used to track modications

​
documentStatus
object
​
deleted
boolean

Has the document family been deleted

​
assignment
object

The assignment of the document to a user

​
storeRef
string

The reference to the store that is holding this document family

​
locked
boolean

Is the document family locked. If locked then you can no longer modify or add any new document transitions

​
created
string<date-time>

Date/Time Created

​
modified
string<date-time>

Date/Time Modified

​
size
integer

Size of the original native content in bytes

​
numberOfNotes
integer

The number of notes associated with this document family

​
numberOfInsights
integer

The number of notes associated with this document family

​
numberOfContentExceptions
integer

The number of notes associated with this document family

​
contentObjects
object[]

An ordered list of the content objects in the document family

​
contentExceptions
object[]

A list of the content exceptions from the content objects

​
transitions
object[]

An ordered list of the transitions in the document family

​
taxonomies
object[]

The Taxonomies associated with the document family

​
labels
object[]

The labels from the latest content object in the family

​
activeAssistant
object
​
mixins
string[]

The mixins from the latest content object in the family

The mixins from the latest content object in the family

​
metadata
object

The metadata from the latest document content object

​
guidance
boolean

Use this document family for guidance if applicable

​
labelStatistics
object

The label statistics from the latest document content object

​
metadataSource
object

This identified the content object ID that added each of the metadata keys

​
statistics
object

A collection of statistics about the document family

​
executionTargets
object

This is a list of the targets from executions for the document family, this is used when we want to understand where data from this document can go

​
summary
string

The summary of the document family

​
documentTaxonValidations
object[]

Document taxon validations for this document family

​
features
object[]
​
id
string

The ID of the object

⌘I