Alert

Find the job-tracking alerts that are currently raised, on job operations and work-order operations, based on search parameters. An alert raised on a job operation that is grouped into a work order is stored against the work-order operation, so it is a `workOrder` alert: filter on `workOrderIds`, not `jobIds`, to find it. Cleared alerts are not returned, nor are alerts on a deleted job or work order, or on an operation, job or work order that is Complete or Cancelled. Sort by `raisedAtUtc` or `id`, ignoring case. Alerts that tie on `raisedAtUtc` are ordered by `id` ascending. Without a sort field, results are ordered by `raisedAtUtc`, oldest first, and the sort direction is honored.

Changed on
post/api/alerts/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/alerts/list
  • Auth
    none declared

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

jobIdsstring[] nullable

Filter alerts to those raised on an operation of one of these jobs.

workOrderIdsstring[] nullable

Filter alerts to those raised on an operation of one of these work orders.

workCenterIdsstring[] nullable

Filter alerts to those raised on an operation scheduled to one of these work centers.

equipmentIdsstring[] nullable

Filter alerts to those raised on an operation scheduled to one of these pieces of equipment.

alertNamesstring[] nullable

Filter alerts to those with one of these alert names.

raisedAfterUtcstring date-time nullable

Filter alerts raised after (exclusive) this time in UTC. If no time component is passed, midnight UTC will be used.

raisedBeforeUtcstring date-time nullable

Filter alerts raised before (exclusive) this time in UTC. If no time component is passed, midnight UTC will be used.

Response

List of active alerts matching the filters

idinteger

Unique id of the alert.

alertNamestring nullable

The alert type's name, as configured in the job-tracking alert settings.

activeboolean

Whether the alert is raised. A cleared alert is removed and no longer listed.

raisedAtUtcstring date-time

When the alert was raised, in UTC.

source'job' | 'workOrder'

What a job-tracking alert was raised on.

Changes