ROrossum
Relation

List relations

Changed on

Retrieve all relation objects (annotations from queues not with active status are excluded).

get/api/v1/relations

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

type'edit' | 'attachment' | 'duplicate'

Relation type. Multiple values may be separated using a comma.

parentinteger

ID of parent annotation. Multiple values may be separated using a comma.

keystring

Relation key

annotationinteger[]

Annotation ID(s) filter

ordering'type' | '-type' | 'parent' | '-parent' | 'key' | '-key'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1,
      "type": "edit",
      "parent": "https://example.rossum.app/api/v1/annotations/123",
      "annotations": [
        "https://example.rossum.app/api/v1/annotations/124",
        "https://example.rossum.app/api/v1/annotations/125"
      ],
      "url": "https://example.rossum.app/api/v1/relations/1"
    }
  ]
}

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

    • info

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