Incident programs: list, update, delete

Reference for Incident, one group of Incident programs.

Incident.list

Returns Incidents, newest first, one page at a time. Verb page.

Text

do: return await $.Incident.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`incidents`	list of Incident	required	One page of Incidents.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Incident.list({ limit: 20 })"
  }
}

Changes the given properties of an Incident. Verb page.

Text

do: return await $.Incident.update(input)

Emits Incident.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Incident.
`by`	Worker		The Worker that performed it.
`for`	Party		The Party it was done on behalf of.
`via`	`string`		The Interface or request it arrived through.
`on`	`string`		The Action or Event that caused it, such as the failed attempt a retry follows.
`thing`	`string`		The record, at the Version the Action was decided against.
`input`	`json`		The input it was called with.
`createdAt`	`datetime`		When it was called.
`reserved`	`money`		The most this Action may cost, held against its Limits from the check until it settles, billed misses included.
`due`	`datetime`		When the Task is due.
`priority`	`integer`		Its rank in the inbox, highest first.
`recurrence`	`string`		The schedule a recurring duty repeats on.
`kind`	`string`		One of `bug`, `request`, or `question`.
`advisory`	`string`		For a vulnerability: the public advisory it matches, with the affected package and range.
`severity`	`string`		One of `minor`, `major`, or `critical`.
`detectedAt`	`datetime`		When monitoring or a Customer first reported it.
`resolvedAt`	`datetime`		When service was restored.
`personalData`	`boolean`		True when the Incident exposed personal data, which starts the breach-notice clock.

Returns

Output	Type	Required	Description
`incident`	Incident	required	The Incident.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Incident.update({ id: 'incident_2XOYkIEno0', severity: 'minor' })"
  }
}

Deletes an Incident: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text

do: return await $.Incident.delete(input)

Emits Incident.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Incident.

Returns

Output	Type	Required	Description
`incident`	Incident	required	The Incident.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Incident.delete({ id: 'incident_2XOYkIEno0' })"
  }
}