Inhaltsverzeichnis

eam

Maintenance (EAM)

Enterprise asset management: the equipment register, corrective and preventive work orders, meter readings, spare parts and recurring maintenance schedules. The physical assets you run and the maintenance history against them. Feed readings from IoT/SCADA, or drive work orders from an external CMMS.

GET/v1/eam/assetsScope: eam:read

List assets

Returns a cursor-paginated list of assets. Use updated_since for incremental sync.

Query parameters

statusoptional	stringFilter by status: running \| idle \| maintenance \| retired.
locationoptional	stringFilter by location code.
limitoptional	integerPage size, 1–200 (default 50).
cursoroptional	stringPagination cursor from a previous response.
updated_sinceoptional	stringRFC 3339 timestamp; return assets changed after it.

Request

curl "https://api.apusplatform.com/v1/eam/assets" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "ast_4a2c",
      "code": "PUMP-042",
      "name": "Coolant pump 042",
      "location": "plant-1/line-a",
      "status": "running",
      "criticality": "high",
      "updated_at": "2026-07-16T08:14:22Z"
    }
  ],
  "has_more": true,
  "next_cursor": "crsr_as21"
}

POST/v1/eam/assetsScope: eam:write

Create an asset

Registers a new asset in the equipment register. code must be unique.

Body

coderequired	stringUnique asset code / tag number.
namerequired	stringDisplay name.
locationoptional	stringLocation code where the asset is installed.

Request

curl -X POST "https://api.apusplatform.com/v1/eam/assets" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "PUMP-042",
    "name": "Coolant pump 042",
    "location": "plant-1/line-a"
  }'

Response

{
  "id": "ast_4a2c",
  "code": "PUMP-042",
  "created_at": "2026-07-20T02:10:00Z"
}

GET/v1/eam/assets/{id}Scope: eam:read

Retrieve an asset

Returns a single asset by its id, or by code (prefix the value with code_).

Path parameters

idrequired

stringAsset id.

Request

curl "https://api.apusplatform.com/v1/eam/assets/ast_4a2c" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "id": "ast_4a2c",
  "code": "PUMP-042",
  "name": "Coolant pump 042",
  "location": "plant-1/line-a",
  "status": "running",
  "criticality": "high",
  "installed_at": "2023-11-04",
  "updated_at": "2026-07-16T08:14:22Z"
}

PATCH/v1/eam/assets/{id}Scope: eam:write

Update an asset

Updates mutable fields of an asset. Only supplied fields change.

Path parameters

idrequired

stringAsset id.

Body

nameoptional	stringDisplay name.
locationoptional	stringLocation code where the asset is installed.
statusoptional	stringLifecycle status: running \| idle \| maintenance \| retired.
criticalityoptional	stringCriticality rating: low \| medium \| high.

Request

curl -X PATCH "https://api.apusplatform.com/v1/eam/assets/ast_4a2c" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "maintenance"
  }'

Response

{
  "id": "ast_4a2c",
  "code": "PUMP-042",
  "updated_at": "2026-07-20T02:12:00Z"
}

GET/v1/eam/maintenance-ordersScope: eam:read

List maintenance orders

Returns a cursor-paginated list of maintenance (work) orders, filterable by asset and status.

Query parameters

asset_idoptional	stringFilter by asset.
statusoptional	stringFilter by status: open \| scheduled \| done.
limitoptional	integerPage size, 1–200 (default 50).
cursoroptional	stringPagination cursor from a previous response.

Request

curl "https://api.apusplatform.com/v1/eam/maintenance-orders" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "mo_8801",
      "number": "WO-2026-8801",
      "asset_id": "ast_4a2c",
      "type": "corrective",
      "status": "open",
      "description": "Seal leak on discharge side.",
      "scheduled_at": "2026-07-22T01:00:00Z",
      "updated_at": "2026-07-18T09:12:04Z"
    }
  ],
  "has_more": true,
  "next_cursor": "crsr_mo44"
}

POST/v1/eam/maintenance-ordersScope: eam:write

Create a maintenance order

Raises a corrective or preventive maintenance order against an asset.

Body

asset_idrequired	stringAsset the work is performed on.
typerequired	stringOrder type: corrective \| preventive.
descriptionrequired	stringWhat needs to be done.
scheduled_atoptional	stringPlanned start (RFC 3339).

Request

curl -X POST "https://api.apusplatform.com/v1/eam/maintenance-orders" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "asset_id": "ast_4a2c",
    "type": "corrective",
    "description": "Seal leak on discharge side.",
    "scheduled_at": "2026-07-22T01:00:00Z"
  }'

Response

{
  "id": "mo_8802",
  "number": "WO-2026-8802",
  "status": "open",
  "created_at": "2026-07-20T02:10:00Z"
}

GET/v1/eam/maintenance-orders/{id}Scope: eam:read

Retrieve a maintenance order

Returns a single maintenance order by its id, including its completion record if closed.

Path parameters

idrequired

stringMaintenance order id.

Request

curl "https://api.apusplatform.com/v1/eam/maintenance-orders/mo_8801" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "id": "mo_8801",
  "number": "WO-2026-8801",
  "asset_id": "ast_4a2c",
  "type": "corrective",
  "status": "open",
  "description": "Seal leak on discharge side.",
  "scheduled_at": "2026-07-22T01:00:00Z",
  "updated_at": "2026-07-18T09:12:04Z"
}

POST/v1/eam/maintenance-orders/{id}/completionScope: eam:write

Complete a maintenance order

Closes a maintenance order, recording labour hours and any spare parts consumed. Consumed parts decrement stock.

Path parameters

idrequired

stringMaintenance order id.

Body

labor_hoursoptional	numberTotal labour hours spent.
partsoptional	arrayParts consumed: [{ sku, quantity }].

Request

curl -X POST "https://api.apusplatform.com/v1/eam/maintenance-orders/mo_8802/completion" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "labor_hours": 2.5,
    "parts": [
      {
        "sku": "SEAL-KIT-42",
        "quantity": 1
      }
    ]
  }'

Response

{
  "id": "mo_8802",
  "status": "done",
  "completed_at": "2026-07-22T03:30:00Z"
}

GET/v1/eam/assets/{id}/meter-readingsScope: eam:read

List meter readings

Returns the recorded meter readings for an asset, newest first.

Path parameters

idrequired

stringAsset id.

Request

curl "https://api.apusplatform.com/v1/eam/assets/{id}/meter-readings" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "mtr_5501",
      "asset_id": "ast_4a2c",
      "reading": 18420,
      "unit": "hours",
      "recorded_at": "2026-07-19T22:00:00Z"
    }
  ]
}

POST/v1/eam/assets/{id}/meter-readingsScope: eam:write

Record a meter reading

Records a meter reading for an asset. Readings can trigger meter-based preventive schedules.

Path parameters

idrequired

stringAsset id.

Body

readingrequired	numberMeter value.
unitoptional	stringUnit of measure, e.g. hours, km, cycles.

Request

curl -X POST "https://api.apusplatform.com/v1/eam/assets/mtr_5502/meter-readings" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "reading": 18500,
    "unit": "hours"
  }'

Response

{
  "id": "mtr_5502",
  "asset_id": "ast_4a2c",
  "reading": 18500,
  "recorded_at": "2026-07-20T02:15:00Z"
}

GET/v1/eam/spare-partsScope: eam:read

List spare parts

Returns spare parts, optionally filtered to those linked to an asset (its bill of materials).

Query parameters

asset_idoptional

stringFilter to parts linked to this asset.

Request

curl "https://api.apusplatform.com/v1/eam/spare-parts" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "sku": "SEAL-KIT-42",
      "name": "Mechanical seal kit 42mm",
      "on_hand": 6,
      "reorder_point": 4,
      "unit": "pcs"
    }
  ]
}

GET/v1/eam/preventive-schedulesScope: eam:read

List preventive schedules

Returns recurring preventive-maintenance schedules, optionally filtered by asset.

Query parameters

asset_idoptional

stringFilter by asset.

Request

curl "https://api.apusplatform.com/v1/eam/preventive-schedules" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "pms_331",
      "asset_id": "ast_4a2c",
      "task": "Inspect and lubricate bearings",
      "interval_days": 90,
      "next_due_at": "2026-09-01",
      "active": true
    }
  ]
}

POST/v1/eam/preventive-schedulesScope: eam:write

Create a preventive schedule

Creates a recurring preventive-maintenance schedule that auto-generates maintenance orders when due.

Body

asset_idrequired	stringAsset the schedule applies to.
interval_daysrequired	integerRecurrence interval in days.
taskrequired	stringTask to perform each cycle.

Request

curl -X POST "https://api.apusplatform.com/v1/eam/preventive-schedules" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "asset_id": "ast_4a2c",
    "interval_days": 90,
    "task": "Inspect and lubricate bearings"
  }'

Response

{
  "id": "pms_332",
  "asset_id": "ast_4a2c",
  "interval_days": 90,
  "next_due_at": "2026-10-18",
  "created_at": "2026-07-20T02:20:00Z"
}

Bereit zur Integration?

Erstellen Sie einen API-Client in der Account-Konsole, um Ihre Zugangsdaten zu erhalten, oder sprechen Sie mit einem Integrationsingenieur über Ihren Anwendungsfall.

API-Zugangsdaten erhalten Mit einem Integrationsingenieur sprechen

← PrevQMS – Quality Next →EDM – Documents