OpenAPI SpecificationJSON
API Reference

Automation Blocker

Automation blocker stores reason why annotation was not automated

Automation blocker types

  • automation_disabled
    • automation is disabled due to queue settings
    • level: annotation only
    • occurs when automation level on queue is set to never or automation_enabled queue settings is false
  • is_duplicate
    • annotation is a duplicate of another one (there exists a relation of duplicate type) and automate_duplicate queue settings is set to false
    • level: annotation only
  • suggested_edit_present
  • low_score
  • failed_checks
    • schema field constraint or connector validation failed
    • only for level: datapoint
  • no_validation_sources
    • validation source list was reset e.g. by hook, so automation was blocked
    • only for level: datapoint
  • error_message
    • for both levels, annotation and datapoint
    • error type messages received from connector
  • Delete recommendation based on validation trigger match for the document
    • delete_recommendation_filename, delete_recommendation_page_count
      • level: annotation only
      • deletion was recommended based on filename/page count condition of the trigger
    • delete_recommendation_field
      • only for level: datapoint
      • deletion recommended based on a value of given field (defined in the condition of trigger)
  • extension
    • automation blocker created by an extension
    • for both levels - annotation and datapoint
  • human_confirmation_required
    • Annotation was randomly marked for human confirmation
    • level: annotation

Automation blocker

Attribute
Type
Description
id*
read-only
integer

AutomationBlocker object ID

url*
read-only
URL

AutomationBlocker object URL

annotation*
read-only
URL

URL of related Annotation object

content*
list[object]

List of reasons why automation is blocked

level
"datapoint" | "annotation"

Designates whether automation blocker relates to specific datapoint or to the whole annotation

type
"automation_disabled" | "is_duplicate" | "suggested_edit_present" | "low_score" | "failed_checks" | "no_validation_sources" | "error_message" | "delete_recommendation_filename" | "delete_recommendation_page_count" | "delete_recommendation_field" | "extension" | "human_confirmation_required"

Type of automation blocker

schema_id
string | null

Only for datapoint level objects

samples
list[object]
datapoint_id
integer

ID of the datapoint

details
object

Additional details specific to the blocker type

samples_truncated
boolean | null

Whether number samples were truncated to 10, or contains all of them

details
object | null

Only for level: annotation with type: error_message.

List automation blockers

GET api / v1 / automation_blockers

List all automation blocker objects.

GET
/api/v1/automation_blockers
curl -X GET "https://example.rossum.app/api/v1/automation_blockers"
{
  "pagination": {
    "next": null,
    "previous": null
  },
  "results": [
    {
      "id": 1,
      "url": "https://example.rossum.app/api/v1/automation_blockers/1",
      "annotation": "https://example.rossum.app/api/v1/annotations/4",
      "content": [
        {
          "level": "datapoint",
          "type": "low_score",
          "schema_id": "invoice_id",
          "samples_truncated": false,
          "samples": [
            {
              "datapoint_id": 1234,
              "details": {
                "score": 0.901,
                "threshold": 0.975
              }
            },
            {
              "datapoint_id": 1235,
              "details": {
                "score": 0.968,
                "threshold": 0.975
              }
            }
          ]
        },
        {
          "level": "datapoint",
          "type": "failed_checks",
          "schema_id": "schema_id",
          "samples_truncated": false,
          "samples": [
            {
              "datapoint_id": 43,
              "details": {
                "validation": "bad"
              }
            }
          ]
        },
        {
          "level": "datapoint",
          "type": "no_validation_sources",
          "schema_id": "schema_id",
          "samples_truncated": false,
          "samples": [
            {
              "datapoint_id": 412
            }
          ]
        },
        {
          "level": "annotation",
          "type": "error_message",
          "details": {
            "message_content": [
              "annotation error"
            ]
          }
        },
        {
          "level": "datapoint",
          "type": "error_message",
          "schema_id": "schema_id",
          "samples_truncated": false,
          "samples": [
            {
              "datapoint_id": 45,
              "details": {
                "message_content": [
                  "longer than 3 characters"
                ]
              }
            }
          ]
        },
        {
          "level": "annotation",
          "type": "delete_recommendation_filename",
          "details": {
            "message_content": [
              "annotation error"
            ]
          }
        },
        {
          "level": "datapoint",
          "type": "delete_recommendation_field",
          "schema_id": "document_type",
          "samples_truncated": false,
          "samples": [
            {
              "datapoint_id": 45
            }
          ]
        },
        {
          "level": "annotation",
          "type": "extension",
          "details": {
            "content": [
              "PO not found in the master data!"
            ]
          }
        },
        {
          "level": "datapoint",
          "type": "extension",
          "schema_id": "sender_name",
          "samples_truncated": false,
          "samples": [
            {
              "datapoint_id": 1357,
              "details": {
                "content": [
                  "Unregistered vendor"
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}
{
  "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

200OK

OK

Attribute
Type
Description
pagination*
pagination
next
URL

URL for the next page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.

previous
URL

URL for the previous page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.

results*
list[automation_blocker]
id*
read-only
integer

AutomationBlocker object ID

url*
read-only
URL

AutomationBlocker object URL

annotation*
read-only
URL

URL of related Annotation object

content*
list[object]

List of reasons why automation is blocked

level
"datapoint" | "annotation"

Designates whether automation blocker relates to specific datapoint or to the whole annotation

type
"automation_disabled" | "is_duplicate" | "suggested_edit_present" | "low_score" | "failed_checks" | "no_validation_sources" | "error_message" | "delete_recommendation_filename" | "delete_recommendation_page_count" | "delete_recommendation_field" | "extension" | "human_confirmation_required"

Type of automation blocker

schema_id
string | null

Only for datapoint level objects

samples
list[object]
datapoint_id
integer

ID of the datapoint

details
object

Additional details specific to the blocker type

samples_truncated
boolean | null

Whether number samples were truncated to 10, or contains all of them

details
object | null

Only for level: annotation with type: error_message.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Retrieve automation blocker

GET api / v1 / automation_blockers / {id}

Retrieve a specific automation blocker object.

GET
/api/v1/automation_blockers/{id}
curl -X GET "https://example.rossum.app/api/v1/automation_blockers/0"
{
  "id": 1,
  "url": "https://example.rossum.app/api/v1/automation_blockers/1",
  "annotation": "https://example.rossum.app/api/v1/annotations/4",
  "content": [
    {
      "level": "datapoint",
      "type": "low_score",
      "schema_id": "invoice_id",
      "samples_truncated": false,
      "samples": [
        {
          "datapoint_id": 1234,
          "details": {
            "score": 0.901,
            "threshold": 0.975
          }
        },
        {
          "datapoint_id": 1235,
          "details": {
            "score": 0.968,
            "threshold": 0.975
          }
        }
      ]
    },
    {
      "level": "datapoint",
      "type": "failed_checks",
      "schema_id": "schema_id",
      "samples_truncated": false,
      "samples": [
        {
          "datapoint_id": 43,
          "details": {
            "validation": "bad"
          }
        }
      ]
    },
    {
      "level": "datapoint",
      "type": "no_validation_sources",
      "schema_id": "schema_id",
      "samples_truncated": false,
      "samples": [
        {
          "datapoint_id": 412
        }
      ]
    },
    {
      "level": "annotation",
      "type": "error_message",
      "details": {
        "message_content": [
          "annotation error"
        ]
      }
    },
    {
      "level": "datapoint",
      "type": "error_message",
      "schema_id": "schema_id",
      "samples_truncated": false,
      "samples": [
        {
          "datapoint_id": 45,
          "details": {
            "message_content": [
              "longer than 3 characters"
            ]
          }
        }
      ]
    },
    {
      "level": "annotation",
      "type": "delete_recommendation_filename",
      "details": {
        "message_content": [
          "annotation error"
        ]
      }
    },
    {
      "level": "datapoint",
      "type": "delete_recommendation_field",
      "schema_id": "document_type",
      "samples_truncated": false,
      "samples": [
        {
          "datapoint_id": 45
        }
      ]
    },
    {
      "level": "annotation",
      "type": "extension",
      "details": {
        "content": [
          "PO not found in the master data!"
        ]
      }
    },
    {
      "level": "datapoint",
      "type": "extension",
      "schema_id": "sender_name",
      "samples_truncated": false,
      "samples": [
        {
          "datapoint_id": 1357,
          "details": {
            "content": [
              "Unregistered vendor"
            ]
          }
        }
      ]
    }
  ]
}
{
  "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

200OK

OK

Attribute
Type
Description
id*
read-only
integer

AutomationBlocker object ID

url*
read-only
URL

AutomationBlocker object URL

annotation*
read-only
URL

URL of related Annotation object

content*
list[object]

List of reasons why automation is blocked

level
"datapoint" | "annotation"

Designates whether automation blocker relates to specific datapoint or to the whole annotation

type
"automation_disabled" | "is_duplicate" | "suggested_edit_present" | "low_score" | "failed_checks" | "no_validation_sources" | "error_message" | "delete_recommendation_filename" | "delete_recommendation_page_count" | "delete_recommendation_field" | "extension" | "human_confirmation_required"

Type of automation blocker

schema_id
string | null

Only for datapoint level objects

samples
list[object]
datapoint_id
integer

ID of the datapoint

details
object

Additional details specific to the blocker type

samples_truncated
boolean | null

Whether number samples were truncated to 10, or contains all of them

details
object | null

Only for level: annotation with type: error_message.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

GETList audit logs

Previous Page

GETList automation blockers

Next Page