Models

AnnotationSchema

{
  "identifier": "string (UUID)",
  "createdAt": "string (ISO 8601 date-time)",
  "updatedAt": "string (ISO 8601 date-time or null)",
  "name": "string (nullable)",
  "description": "string (nullable)",
  "specification": "string (nullable)",
  "context": "string (nullable)"
}

Fields

• identifier: schema unique identifier
• createdAt: schema creation date-time
• updatedAt: schema last update date-time
• name: schema name (Note: this field is used by automatic classification of documents, it should also be unique in your superset of schemas, i.e. public + private)
• description: schema description (Note: this field is used by automatic classification of documents, to understand what it is about)
• specification: schema specification, must be a valid JSON schema stringified and including additionalProperties: false in every object
• context: schema context. Ex. 'financial documents used in Portugal', 'bank accounting used in USA' (Note: this field is used by automatic classification of documents, to understand in what kind of context it is used)

ProblemDetails

{
  "type": "string (nullable)",
  "title": "string (nullable)",
  "status": "integer (nullable)",
  "detail": "string (nullable)",
  "instance": "string (nullable)"
}