Skip to content
aimrack

Tank Condition Alarm

The tank condition alarm resource.

Base/tankConditionAlarm
GET/tankConditionAlarm

List tank condition alarms

Retrieve a paginated list of tank condition alarms. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/tankConditionAlarm
curl --request GET \
  --url '<your-host>/tankConditionAlarm?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "tankId": "xyz789",
    "kind": "string",
    "title": "string",
    "message": "string",
    "severity": "string",
    "source": "string"
  }
]
GET/tankConditionAlarm

Retrieve a tank condition alarm

Fetch a single tank condition alarm by filtering on `id`.

Query parameters

idstring

Match on the tank condition alarm's `id`, e.g. `eq.{id}`.

GET/tankConditionAlarm
curl --request GET \
  --url '<your-host>/tankConditionAlarm?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "kind": "string",
  "title": "string",
  "message": "string",
  "severity": "string",
  "source": "string"
}
POST/tankConditionAlarm

Create a tank condition alarm

Create a new tank condition alarm.

Body parameters

tankIdstringrequired
tankMonitorIdstring
kindstringrequired
titlestringrequired
messagestringrequired
severitystringrequired
sourcestringrequired
raisedAttimestamprequired
resolvedAttimestamp
POST/tankConditionAlarm
curl --request POST \
  --url <your-host>/tankConditionAlarm \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"tankId":"xyz789","kind":"string","title":"string","message":"string","severity":"string","source":"string","raisedAt":"2026-01-01T00:00:00Z"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "kind": "string",
  "title": "string",
  "message": "string",
  "severity": "string",
  "source": "string"
}
PATCH/tankConditionAlarm

Update a tank condition alarm

Update an existing tank condition alarm, matched on `id`.

Body parameters

tankIdstringrequired
tankMonitorIdstring
kindstringrequired
titlestringrequired
messagestringrequired
severitystringrequired
sourcestringrequired
raisedAttimestamprequired
resolvedAttimestamp
PATCH/tankConditionAlarm
curl --request PATCH \
  --url '<your-host>/tankConditionAlarm?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"tankId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "kind": "string",
  "title": "string",
  "message": "string",
  "severity": "string",
  "source": "string"
}
DELETE/tankConditionAlarm

Delete a tank condition alarm

Delete a tank condition alarm, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the tank condition alarm to delete, e.g. `eq.{id}`.

DELETE/tankConditionAlarm
curl --request DELETE \
  --url '<your-host>/tankConditionAlarm?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content