ROrossum
Document Relation

Partial update document relation

Changed on

Update part of a document relation object.

patch/api/v1/document_relations/{documentRelationID}

Request

Path parameters

documentRelationIDinteger required

Document relation ID

Request body

idinteger

ID of the document relation

type'export' | 'einvoice'

Type of relationship. Possible values:

  • export - Related documents are exports of the annotation data (e.g. in XML or JSON formats).
  • einvoice - Related documents were created during import of an einvoice (e.g. validation report, visualisation, ...)
keystring nullable

Key used to distinguish several relationships of the same type. Note: The combination of type, key and annotation attribute values must be unique.

annotationstring uri

Annotation

documentsstring[]

List of related documents

urlstring uri

URL of the relation

Example request

{
  "id": 1,
  "type": "export",
  "annotation": "https://example.rossum.app/api/v1/annotations/314159",
  "documents": [
    "https://example.rossum.app/api/v1/documents/124",
    "https://example.rossum.app/api/v1/documents/125"
  ],
  "url": "https://example.rossum.app/api/v1/document_relations/1"
}

Response

OK

idinteger required

ID of the document relation

type'export' | 'einvoice' required

Type of relationship. Possible values:

  • export - Related documents are exports of the annotation data (e.g. in XML or JSON formats).
  • einvoice - Related documents were created during import of an einvoice (e.g. validation report, visualisation, ...)
keystring nullable required

Key used to distinguish several relationships of the same type. Note: The combination of type, key and annotation attribute values must be unique.

annotationstring uri required

Annotation

documentsstring[] required

List of related documents

urlstring uri required

URL of the relation

Example response

{
  "id": 1,
  "type": "export",
  "annotation": "https://example.rossum.app/api/v1/annotations/314159",
  "documents": [
    "https://example.rossum.app/api/v1/documents/124",
    "https://example.rossum.app/api/v1/documents/125"
  ],
  "url": "https://example.rossum.app/api/v1/document_relations/1"
}

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

    • 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