ROrossum
Suggested Edit

List suggested edits

Changed on

Retrieve all suggested edit objects.

get/api/v1/suggested_edits

Request

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[]

Annotation ID(s) filter

ordering'annotation' | '-annotation'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 314528,
      "url": "https://example.rossum.app/api/v1/suggested_edits/314528",
      "annotation": "https://example.rossum.app/api/v1/annotations/314528",
      "documents": [
        {
          "pages": [
            {
              "page": "https://example.rossum.app/api/v1/pages/314554"
            }
          ],
          "target_queue": "https://example.rossum.app/api/v1/queues/314528",
          "values": {
            "edit:document_type": "invoice"
          }
        }
      ]
    }
  ]
}

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

    • info

      added subschema #2 to the / response property allOf list for the response status