ROrossum
Annotation Content

Grid operations

Changed on

This endpoint applies multiple operations on multiple grids for one multivalue and performs OCR if required, and updates the multivalue with the resulting grid.

For update operation the position of the grid and its rows and columns can be changed, the column layout can be changed, but the row structure must be unchanged.

The operations are applied sequentially. The grid_index corresponds to the index of the grid parts when the operation is applied. Combining different types of operations is not supported.

post/api/v1/annotations/{annotationID}/content/{multivalueID}/grid_operations

Request

Path parameters

annotationIDinteger required

Annotation ID

multivalueIDinteger required

ID of the multivalue

Request body

Response

OK - Returns updated multivalue content as a tree, with only updated datapoints

idinteger required

A unique ID of a given object.

urlstring uri required

URL of a given object.

schema_idstring required

Reference mapping the object to the schema tree.

category'multivalue' required

Type of the object.

hiddenboolean

If set to true, the datapoint is not visible in the user interface, but remains stored in the database.

time_spentnumber float required

Time spent while actively working on a given node, in seconds.

time_spent_overallnumber float required

Total time spent while validating a given node, in seconds. Only for internal purposes.

time_spent_gridnumber float required

Total time spent while actively working on a grid, in seconds. Only for internal purposes.

time_spent_grid_overallnumber float required

Total time spent while validating a given grid, in seconds. Only for internal purposes.

Example response

{
  "id": 27801933,
  "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
  "schema_id": "some_id",
  "children": [
    {
      "id": 27801933,
      "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
      "schema_id": "some_id",
      "children": [
        {
          "id": 27801933,
          "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
          "schema_id": "some_id",
          "content": {
            "value": "8/12/24",
            "normalized_value": "12-08-2024",
            "page": 1,
            "position": [
              202.3,
              100.1,
              110.442,
              110
            ],
            "rir_text": "8/12/24",
            "rir_raw_text": "8/I2/24",
            "rir_page": 1,
            "rir_position": [
              202.3,
              100.1,
              110.442,
              110
            ],
            "rir_confidence": 0.954233451,
            "connector_text": "8/I2/24",
            "connector_position": [
              200,
              100,
              110,
              110
            ],
            "ocr_text": null,
            "ocr_raw_text": null,
            "ocr_position": null
          },
          "validation_sources": [
            "score"
          ]
        }
      ]
    }
  ],
  "grid": {
    "parts": [
      {
        "page": 1,
        "columns": [
          {
            "left_position": 12.1,
            "schema_id": "item_description",
            "header_texts": [
              "Item description"
            ]
          }
        ],
        "rows": [
          {
            "top_position": 112.29,
            "tuple_id": 1,
            "type": "data"
          }
        ],
        "width": 123.2,
        "height": 513.2
      }
    ]
  }
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status