ROrossum
Trigger

Retrieve trigger

Changed on

Get a trigger object.

get/api/v1/triggers/{triggerID}

Request

Path parameters

triggerIDinteger required

Trigger ID

Response

OK

idinteger required

ID of the trigger

urlstring url required

URL of the trigger

queuestring uri required

Queue URL.

eventstring required

Event that will trigger the trigger (see trigger event types)

conditionobject required

A subset of MongoDB Query Language (see trigger condition)

email_templatesstring[] required

URLs of the linked email templates

delete_recommendationsstring[] required

URLs of the linked delete recommendations

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

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

    • 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