Automation Blocker

List automation blockers

List all automation blocker objects.

get/api/v1/automation_blockers

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

annotationinteger

ID of an annotation to filter automation blockers by

ordering'id' | '-id'

Result ordering.

Response

OK

Example response

{
  "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"
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.