ROrossum
Trigger

List triggers

Changed on

Retrieve all trigger objects.

get/api/v1/triggers

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

Filter by a list of ids, e.g. ?id=1,2,3

eventstring

Event filter

queueinteger[]

Queue ID(s) filter

ordering'id' | '-id' | 'event' | '-event'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 234,
      "url": "https://example.rossum.app/api/v1/triggers/234",
      "queue": "https://example.rossum.app/api/v1/queues/8198",
      "event": "annotation_imported",
      "condition": {},
      "email_templates": [
        "https://example.rossum.app/api/v1/email_templates/123",
        "https://example.rossum.app/api/v1/email_templates/321"
      ],
      "delete_recommendations": [
        "https://example.rossum.app/api/v1/delete_recommendations/123",
        "https://example.rossum.app/api/v1/delete_recommendations/321"
      ],
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z"
    }
  ]
}

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

    • 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