Schema
A schema object specifies the set of datapoints that are extracted from the annotation. For more information see Schema
Schema content consists of a list of section objects. Each section represents a logical part of the document, such as amounts or vendor info. Schema allows multiple sections, and there should be at least one section in the schema.
Rossum schema supports data fields with single values (datapoint), fields with multiple values (multivalue) or tuples of fields (tuple). At the topmost level, each schema consists of sections, which may either directly contain actual data fields (datapoints) or use nested multivalues and tuples as containers for single datapoints.
The supported shapes are:
- simple: atomic datapoints of type number, string, date or enum
- list: simple datapoint within a multivalue
- tabular: simple datapoint within a "multivalue tuple" (a multivalue list containing a tuple for every row)
All schema objects use discriminators based on the 'category' field for proper type identification.
This resource supports ETag HTTP header handling. Use If-None-Match for conditional retrieval and If-Match for conditional updates and deletes.
Schema
ID of the schema.
Name of the schema (not visible in UI).
URL of the schema.
List of queues that use schema object.
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}User that last modified the object.
Timestamp of last modification.
contentlist[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
childrenlist[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]childrenobjectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
childrenlist[object]Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
List schemas
Retrieve all schema objects.
curl -X GET "https://example.rossum.app/api/v1/schemas?id=1%2C2%2C3&queue=1%2C2%2C3"{
"pagination": {
"total": 1,
"total_pages": 1,
"next": null,
"previous": null
},
"results": [
{
"id": 31336,
"name": "Basic Schema",
"url": "https://example.rossum.app/api/v1/schemas/31336",
"queues": [
"https://example.rossum.app/api/v1/queues/8236"
],
"metadata": {
"some_key": "some_value"
},
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"content": [
{
"category": "section",
"id": "invoice_info_section",
"label": "Basic information",
"icon": null,
"children": [
{
"category": "datapoint",
"id": "document_id",
"label": "Invoice number",
"type": "string",
"rir_field_names": [
"document_id"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "date_issue",
"label": "Issue date",
"type": "date",
"format": "YYYY-MM-DD",
"rir_field_names": [
"date_issue"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "document_type",
"label": "Document type",
"type": "enum",
"options": [
{
"label": "Invoice Received",
"value": "21"
},
{
"label": "Invoice Sent",
"value": "22"
},
{
"label": "Receipt",
"value": "23"
}
],
"enum_value_type": "number",
"default_value": "21",
"rir_field_names": []
}
]
},
{
"category": "section",
"id": "line_items_section",
"label": "Line items",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "line_items",
"label": "Line items",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"line_items"
],
"children": {
"category": "tuple",
"id": "line_item",
"label": "Line item",
"children": [
{
"category": "datapoint",
"id": "item_desc",
"label": "Description",
"type": "string",
"rir_field_names": [
"table_column_description"
],
"constraints": {
"required": true
},
"stretch": true
},
{
"category": "datapoint",
"id": "item_quantity",
"label": "Quantity",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_quantity"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "item_amount_total",
"label": "Price w tax",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_amount_total"
],
"constraints": {
"required": false
},
"aggregations": {
"sum": {
"label": "Total"
}
}
}
]
}
}
]
},
{
"category": "section",
"id": "tax_details_section",
"label": "Tax details",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "tax_details",
"label": "Tax details",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"tax_details"
],
"children": {
"category": "tuple",
"id": "tax_detail",
"label": "Tax detail",
"children": [
{
"category": "datapoint",
"id": "tax_detail_rate",
"label": "Tax rate",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_rate"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "tax_detail_base",
"label": "Tax base",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_base"
],
"constraints": {
"required": false
}
},
{
"category": "datapoint",
"id": "tax_detail_tax",
"label": "Tax amount",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_tax"
],
"constraints": {
"required": false
}
}
]
}
}
]
}
]
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
paginationpagination
Total number of items.
Total number of pages.
URL for the next page of results.
URL for the previous page of results.
results
ID of the schema.
Name of the schema (not visible in UI).
URL of the schema.
List of queues that use schema object.
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}User that last modified the object.
Timestamp of last modification.
contentlist[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
childrenlist[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]childrenobjectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
childrenlist[object]Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Create schema
Create a new schema object.
curl -X POST "https://example.rossum.app/api/v1/schemas" \ -H "Content-Type: application/json" \ -d '{}'{
"id": 31336,
"name": "Basic Schema",
"url": "https://example.rossum.app/api/v1/schemas/31336",
"queues": [
"https://example.rossum.app/api/v1/queues/8236"
],
"metadata": {
"some_key": "some_value"
},
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"content": [
{
"category": "section",
"id": "invoice_info_section",
"label": "Basic information",
"icon": null,
"children": [
{
"category": "datapoint",
"id": "document_id",
"label": "Invoice number",
"type": "string",
"rir_field_names": [
"document_id"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "date_issue",
"label": "Issue date",
"type": "date",
"format": "YYYY-MM-DD",
"rir_field_names": [
"date_issue"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "document_type",
"label": "Document type",
"type": "enum",
"options": [
{
"label": "Invoice Received",
"value": "21"
},
{
"label": "Invoice Sent",
"value": "22"
},
{
"label": "Receipt",
"value": "23"
}
],
"enum_value_type": "number",
"default_value": "21",
"rir_field_names": []
}
]
},
{
"category": "section",
"id": "line_items_section",
"label": "Line items",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "line_items",
"label": "Line items",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"line_items"
],
"children": {
"category": "tuple",
"id": "line_item",
"label": "Line item",
"children": [
{
"category": "datapoint",
"id": "item_desc",
"label": "Description",
"type": "string",
"rir_field_names": [
"table_column_description"
],
"constraints": {
"required": true
},
"stretch": true
},
{
"category": "datapoint",
"id": "item_quantity",
"label": "Quantity",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_quantity"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "item_amount_total",
"label": "Price w tax",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_amount_total"
],
"constraints": {
"required": false
},
"aggregations": {
"sum": {
"label": "Total"
}
}
}
]
}
}
]
},
{
"category": "section",
"id": "tax_details_section",
"label": "Tax details",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "tax_details",
"label": "Tax details",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"tax_details"
],
"children": {
"category": "tuple",
"id": "tax_detail",
"label": "Tax detail",
"children": [
{
"category": "datapoint",
"id": "tax_detail_rate",
"label": "Tax rate",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_rate"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "tax_detail_base",
"label": "Tax base",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_base"
],
"constraints": {
"required": false
}
},
{
"category": "datapoint",
"id": "tax_detail_tax",
"label": "Tax amount",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_tax"
],
"constraints": {
"required": false
}
}
]
}
}
]
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of the schema (not visible in UI).
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}content*list[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
children*list[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]children*objectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
children*list[object]Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
options*list[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
options*list[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
options*list[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Response
Created
ID of the schema.
Name of the schema (not visible in UI).
URL of the schema.
List of queues that use schema object.
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}User that last modified the object.
Timestamp of last modification.
contentlist[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
childrenlist[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]childrenobjectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
childrenlist[object]Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve schema
Get a schema object.
curl -X GET "https://example.rossum.app/api/v1/schemas/31336"{
"id": 31336,
"name": "Basic Schema",
"url": "https://example.rossum.app/api/v1/schemas/31336",
"queues": [
"https://example.rossum.app/api/v1/queues/8236"
],
"metadata": {
"some_key": "some_value"
},
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"content": [
{
"category": "section",
"id": "invoice_info_section",
"label": "Basic information",
"icon": null,
"children": [
{
"category": "datapoint",
"id": "document_id",
"label": "Invoice number",
"type": "string",
"rir_field_names": [
"document_id"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "date_issue",
"label": "Issue date",
"type": "date",
"format": "YYYY-MM-DD",
"rir_field_names": [
"date_issue"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "document_type",
"label": "Document type",
"type": "enum",
"options": [
{
"label": "Invoice Received",
"value": "21"
},
{
"label": "Invoice Sent",
"value": "22"
},
{
"label": "Receipt",
"value": "23"
}
],
"enum_value_type": "number",
"default_value": "21",
"rir_field_names": []
}
]
},
{
"category": "section",
"id": "line_items_section",
"label": "Line items",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "line_items",
"label": "Line items",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"line_items"
],
"children": {
"category": "tuple",
"id": "line_item",
"label": "Line item",
"children": [
{
"category": "datapoint",
"id": "item_desc",
"label": "Description",
"type": "string",
"rir_field_names": [
"table_column_description"
],
"constraints": {
"required": true
},
"stretch": true
},
{
"category": "datapoint",
"id": "item_quantity",
"label": "Quantity",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_quantity"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "item_amount_total",
"label": "Price w tax",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_amount_total"
],
"constraints": {
"required": false
},
"aggregations": {
"sum": {
"label": "Total"
}
}
}
]
}
}
]
},
{
"category": "section",
"id": "tax_details_section",
"label": "Tax details",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "tax_details",
"label": "Tax details",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"tax_details"
],
"children": {
"category": "tuple",
"id": "tax_detail",
"label": "Tax detail",
"children": [
{
"category": "datapoint",
"id": "tax_detail_rate",
"label": "Tax rate",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_rate"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "tax_detail_base",
"label": "Tax base",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_base"
],
"constraints": {
"required": false
}
},
{
"category": "datapoint",
"id": "tax_detail_tax",
"label": "Tax amount",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_tax"
],
"constraints": {
"required": false
}
}
]
}
}
]
}
]
}{
"detail": "Object was not modified",
"code": "not_modified"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the schema.
Name of the schema (not visible in UI).
URL of the schema.
List of queues that use schema object.
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}User that last modified the object.
Timestamp of last modification.
contentlist[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
childrenlist[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]childrenobjectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
childrenlist[object]Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Object was not modified (e.g. ETag matches If-None-Match header).
Detail of the error
Code of the error
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Partial update schema
Update part of schema object. See Updating schema for more details about consequences of schema update.
This request can only change top-level properties of the schema object. Partial update of schema content is not available. To update a part of the schema content, send the whole schema content in the request, containing the new changes you would like to apply to the original schema.
curl -X PATCH "https://example.rossum.app/api/v1/schemas/31336" \ -H "Content-Type: application/json" \ -d '{}'{
"id": 31336,
"name": "Basic Schema",
"url": "https://example.rossum.app/api/v1/schemas/31336",
"queues": [
"https://example.rossum.app/api/v1/queues/8236"
],
"metadata": {
"some_key": "some_value"
},
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"content": [
{
"category": "section",
"id": "invoice_info_section",
"label": "Basic information",
"icon": null,
"children": [
{
"category": "datapoint",
"id": "document_id",
"label": "Invoice number",
"type": "string",
"rir_field_names": [
"document_id"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "date_issue",
"label": "Issue date",
"type": "date",
"format": "YYYY-MM-DD",
"rir_field_names": [
"date_issue"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "document_type",
"label": "Document type",
"type": "enum",
"options": [
{
"label": "Invoice Received",
"value": "21"
},
{
"label": "Invoice Sent",
"value": "22"
},
{
"label": "Receipt",
"value": "23"
}
],
"enum_value_type": "number",
"default_value": "21",
"rir_field_names": []
}
]
},
{
"category": "section",
"id": "line_items_section",
"label": "Line items",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "line_items",
"label": "Line items",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"line_items"
],
"children": {
"category": "tuple",
"id": "line_item",
"label": "Line item",
"children": [
{
"category": "datapoint",
"id": "item_desc",
"label": "Description",
"type": "string",
"rir_field_names": [
"table_column_description"
],
"constraints": {
"required": true
},
"stretch": true
},
{
"category": "datapoint",
"id": "item_quantity",
"label": "Quantity",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_quantity"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "item_amount_total",
"label": "Price w tax",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_amount_total"
],
"constraints": {
"required": false
},
"aggregations": {
"sum": {
"label": "Total"
}
}
}
]
}
}
]
},
{
"category": "section",
"id": "tax_details_section",
"label": "Tax details",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "tax_details",
"label": "Tax details",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"tax_details"
],
"children": {
"category": "tuple",
"id": "tax_detail",
"label": "Tax detail",
"children": [
{
"category": "datapoint",
"id": "tax_detail_rate",
"label": "Tax rate",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_rate"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "tax_detail_base",
"label": "Tax base",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_base"
],
"constraints": {
"required": false
}
},
{
"category": "datapoint",
"id": "tax_detail_tax",
"label": "Tax amount",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_tax"
],
"constraints": {
"required": false
}
}
]
}
}
]
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Precondition failed.",
"code": "precondition_failed"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of the schema (not visible in UI).
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}contentlist[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
childrenlist[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]childrenobjectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
childrenlist[object]Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Response
OK
ID of the schema.
Name of the schema (not visible in UI).
URL of the schema.
List of queues that use schema object.
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}User that last modified the object.
Timestamp of last modification.
contentlist[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
childrenlist[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]childrenobjectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
childrenlist[object]Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Precondition failed (e.g. ETag does not match).
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Delete schema
Delete schema object.
In case the schema is linked to some objects, like queue or annotation, the deletion is not possible and the request will fail with 409 status code.
curl -X DELETE "https://example.rossum.app/api/v1/schemas/31336"{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Precondition failed.",
"code": "precondition_failed"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
No Content
No response body.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
The deletion is not possible because the schema is linked to some objects, like queue or annotation.
Detail of the error
Code of the error
Precondition failed (e.g. ETag does not match).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Update schema
Update schema object. See Updating schema for more details about consequences of schema update.
curl -X PUT "https://example.rossum.app/api/v1/schemas/31336" \ -H "Content-Type: application/json" \ -d '{}'{
"id": 31336,
"name": "Basic Schema",
"url": "https://example.rossum.app/api/v1/schemas/31336",
"queues": [
"https://example.rossum.app/api/v1/queues/8236"
],
"metadata": {
"some_key": "some_value"
},
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"content": [
{
"category": "section",
"id": "invoice_info_section",
"label": "Basic information",
"icon": null,
"children": [
{
"category": "datapoint",
"id": "document_id",
"label": "Invoice number",
"type": "string",
"rir_field_names": [
"document_id"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "date_issue",
"label": "Issue date",
"type": "date",
"format": "YYYY-MM-DD",
"rir_field_names": [
"date_issue"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "document_type",
"label": "Document type",
"type": "enum",
"options": [
{
"label": "Invoice Received",
"value": "21"
},
{
"label": "Invoice Sent",
"value": "22"
},
{
"label": "Receipt",
"value": "23"
}
],
"enum_value_type": "number",
"default_value": "21",
"rir_field_names": []
}
]
},
{
"category": "section",
"id": "line_items_section",
"label": "Line items",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "line_items",
"label": "Line items",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"line_items"
],
"children": {
"category": "tuple",
"id": "line_item",
"label": "Line item",
"children": [
{
"category": "datapoint",
"id": "item_desc",
"label": "Description",
"type": "string",
"rir_field_names": [
"table_column_description"
],
"constraints": {
"required": true
},
"stretch": true
},
{
"category": "datapoint",
"id": "item_quantity",
"label": "Quantity",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_quantity"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "item_amount_total",
"label": "Price w tax",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_amount_total"
],
"constraints": {
"required": false
},
"aggregations": {
"sum": {
"label": "Total"
}
}
}
]
}
}
]
},
{
"category": "section",
"id": "tax_details_section",
"label": "Tax details",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "tax_details",
"label": "Tax details",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"tax_details"
],
"children": {
"category": "tuple",
"id": "tax_detail",
"label": "Tax detail",
"children": [
{
"category": "datapoint",
"id": "tax_detail_rate",
"label": "Tax rate",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_rate"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "tax_detail_base",
"label": "Tax base",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_base"
],
"constraints": {
"required": false
}
},
{
"category": "datapoint",
"id": "tax_detail_tax",
"label": "Tax amount",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_tax"
],
"constraints": {
"required": false
}
}
]
}
}
]
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Precondition failed.",
"code": "precondition_failed"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of the schema (not visible in UI).
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}content*list[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
children*list[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]children*objectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
children*list[object]Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It may contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
options*list[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
options*list[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
options*list[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Response
OK
ID of the schema.
Name of the schema (not visible in UI).
URL of the schema.
List of queues that use schema object.
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}User that last modified the object.
Timestamp of last modification.
contentlist[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
childrenlist[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]childrenobjectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
childrenlist[object]Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Precondition failed (e.g. ETag does not match).
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Create schema from template
Create new schema object from template organization, see available templates in organization
curl -X POST "https://example.rossum.app/api/v1/schemas/from_template" \ -H "Content-Type: application/json" \ -d '{ "name": "ACME Corp Invoice Schema", "template_name": "EU Invoice Template" }'{
"id": 31336,
"name": "Basic Schema",
"url": "https://example.rossum.app/api/v1/schemas/31336",
"queues": [
"https://example.rossum.app/api/v1/queues/8236"
],
"metadata": {
"some_key": "some_value"
},
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"content": [
{
"category": "section",
"id": "invoice_info_section",
"label": "Basic information",
"icon": null,
"children": [
{
"category": "datapoint",
"id": "document_id",
"label": "Invoice number",
"type": "string",
"rir_field_names": [
"document_id"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "date_issue",
"label": "Issue date",
"type": "date",
"format": "YYYY-MM-DD",
"rir_field_names": [
"date_issue"
],
"constraints": {
"required": false
},
"default_value": null
},
{
"category": "datapoint",
"id": "document_type",
"label": "Document type",
"type": "enum",
"options": [
{
"label": "Invoice Received",
"value": "21"
},
{
"label": "Invoice Sent",
"value": "22"
},
{
"label": "Receipt",
"value": "23"
}
],
"enum_value_type": "number",
"default_value": "21",
"rir_field_names": []
}
]
},
{
"category": "section",
"id": "line_items_section",
"label": "Line items",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "line_items",
"label": "Line items",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"line_items"
],
"children": {
"category": "tuple",
"id": "line_item",
"label": "Line item",
"children": [
{
"category": "datapoint",
"id": "item_desc",
"label": "Description",
"type": "string",
"rir_field_names": [
"table_column_description"
],
"constraints": {
"required": true
},
"stretch": true
},
{
"category": "datapoint",
"id": "item_quantity",
"label": "Quantity",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_quantity"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "item_amount_total",
"label": "Price w tax",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"table_column_amount_total"
],
"constraints": {
"required": false
},
"aggregations": {
"sum": {
"label": "Total"
}
}
}
]
}
}
]
},
{
"category": "section",
"id": "tax_details_section",
"label": "Tax details",
"icon": null,
"children": [
{
"category": "multivalue",
"id": "tax_details",
"label": "Tax details",
"min_occurrences": null,
"max_occurrences": null,
"rir_field_names": [
"tax_details"
],
"children": {
"category": "tuple",
"id": "tax_detail",
"label": "Tax detail",
"children": [
{
"category": "datapoint",
"id": "tax_detail_rate",
"label": "Tax rate",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_rate"
],
"constraints": {
"required": false
},
"width": 15
},
{
"category": "datapoint",
"id": "tax_detail_base",
"label": "Tax base",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_base"
],
"constraints": {
"required": false
}
},
{
"category": "datapoint",
"id": "tax_detail_tax",
"label": "Tax amount",
"type": "number",
"format": "# ##0.#",
"rir_field_names": [
"tax_detail_tax"
],
"constraints": {
"required": false
}
}
]
}
}
]
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of the new schema
Name of the template to use
Response
Created
ID of the schema.
Name of the schema (not visible in UI).
URL of the schema.
List of queues that use schema object.
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}User that last modified the object.
Timestamp of last modification.
contentlist[object]Schema content: list of sections.
Schema content: list of sections.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseThe icon that appears on the left panel in the UI for a given section (not yet supported on UI).
childrenlist[object]Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseMinimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
min: 0Default:0Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
min: 1Default:1000If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
gridobjectMultivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
List of allowed row type values.
Default:["data"]Row type to be used by default.
Default:"data"Types of rows to be extracted to related table.
Default:["data"]childrenobjectObject specifying type of children. It may contain only objects with categories tuple or datapoint.
Object specifying type of children. It may contain only objects with categories tuple or datapoint.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseList of names used to initialize content from the AI engine predictions. If specified, the value of the first extracted field from the array is used, otherwise, no AI engine initialization is done for the object.
childrenlist[object]Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Array specifying objects that belong to a given tuple. It can contain only objects with category datapoint.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Number format.
Default:"# ##0.#"aggregationsobjectAggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples).
sumobjectSum of values in a column. Default label is "Sum".
Sum of values in a column. Default label is "Sum".
Label that will be shown in the UI for the sum aggregation.
Default:"Sum"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Enforces a format for date datapoint on the UI.
Default:"YYY-MM-DD"constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
Data type of the option's value attribute. Must be one of string, number, date.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
optionslist[object]Options for enum datapoint.
Options for enum datapoint.
Value of the option.
User-friendly label for the option, shown in the UI.
Data type of the object.
Unique identifier of an object. Maximum length is 50 characters.
maxLength: 50User-friendly label for an object, shown in the user interface.
If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
Default:falseCan be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
Default:falseIf set to false, datapoint is not exported through export endpoint. Default is true.
Default:trueIf set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false.
Default:falseList of references used to initialize an object value.
Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field.
ui_configurationobjectUI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API.
Logical type of the datapoint. Possible values are captured, data, manual, formula, reasoning or null. Default value is null.
Default:nullWhen set to disabled, value of the datapoint is not editable via UI. When set to enabled_without_warning, no warnings are displayed in the UI regarding this fields editing behaviour. Default value is enabled, this option enables field editing, but user receives dismissible warnings when doing so.
Default:"enabled"Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints.
If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints.
(Deprecated) Use width and stretch properties instead.
Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used.
min: 0, max: 1Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields.
maxLength: 2000Prompt definition, required only for fields of type reasoning.
maxLength: 2000Context for the prompt, required only for fields of type reasoning.
URL of a popup window to be opened when button is pressed.
If set to true the popup window is allowed to ask the main Rossum window for authorization token.
constraintsobject
lengthobjectDefines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Defines minimum, maximum or exact length for the datapoint value. By default, minimum and maximum are 0 and infinity, respectively.
Minimum length for the datapoint value.
min: 0Maximum length for the datapoint value.
min: 0Exact length for the datapoint value.
min: 0Specifies if the datapoint is required by the schema. Default value is true.
Default:trueregexobjectWhen specified, content must match a regular expression.
When specified, content must match a regular expression.
Regular expression pattern that the content must match. To ensure that entire value matches, surround your regular expression with ^ and $.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Validate schema
Validate schema object, check for errors.
curl -X POST "https://example.rossum.app/api/v1/schemas/validate" \ -H "Content-Type: application/json" \ -d '{ "content": [ { "category": "section", "id": "invoice_details", "label": "Invoice Details", "children": [ { "category": "datapoint", "id": "document_id", "label": "Document ID", "type": "string" }, { "category": "datapoint", "id": "date_issue", "label": "Invoice Date", "type": "date" } ] } ], "id": 12345, "url": "https://example.rossum.app/api/v1/schemas/12345" }'{}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Schema content to validate
Schema ID (required for Aurora engines)
Schema URL (required for Aurora engines)
Response
Validation result (An error description in case of validation failure).
responseobjectInvalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error