Schema
List schemas
Retrieve all schema objects.
get/api/v1/schemas
Query parameters
page_sizeinteger
Number of results per page
cursorstring
A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.
idinteger[]
Object ID(s) filter
namestring
Object name filter
queueinteger[]
Queue ID(s) filter
ordering'id' | '-id'
Result ordering.
Response
OK
Example response
{
"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
}
}
]
}
}
]
}
]
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.