API REFERENCE · SCHEMA
Monitor schema
Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.
idRequired- string
Format: uuid.
nameRequired- string
statusRequired- string
Values: "active", "paused".
last_screening_idRequired- string or null
May be null.
last_screening_id fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
next_run_atRequired- string
Format: date-time.
created_atRequired- string
Format: date-time.
revisionRequired- integer
Minimum: 0.
counterparty_idRequired- string or null
May be null.
counterparty_id fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
Use Monitor in a workflow
Used by
Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.
- GET /monitorsResponse · List retained monitoring subjects
- GET /monitors/{id}Response · Read one active or paused monitor