ROrossum
Suggested Edit

Partial update suggested edit

Changed on

Update part of suggested edit object.

patch/api/v1/suggested_edits/{suggestedEditID}

Request

Path parameters

suggestedEditIDinteger required

ID of the suggested edit

Request body

idinteger

ID of the suggested edit.

urlstring url

URL of the suggested edit.

annotationstring url

Annotation that suggested edit is related to.

Example request

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

Response

OK

idinteger required

ID of the suggested edit.

urlstring url required

URL of the suggested edit.

annotationstring url required

Annotation that suggested edit is related to.

Example response

{
  "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 body 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 body allOf list for the response status