Saltar al contenido

Create an asset maintenance

Módulo Assets

POST/asset-maintenanceassetMaintenanceEvents.create

A maintenance event for an asset unit. Creates an asset maintenance. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad assets.maintenance.write.
  • Alcances de OAuth: assets.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: AssetMaintenanceCreate

assetMaintenanceEvents.create: AssetMaintenanceCreate
CampoTipoObligatorioDescripción
asset_unit_idstring (uuid)SíIdentifier of the asset unit.
performed_onstring (date)SíWhen the maintenance was done.
descriptionstringSíWhat was done.Restricciones: length 1 to 20000
cost_minorinteger (int64) | nullNoMaintenance cost. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullNoISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
{
  "asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "performed_on": "2026-10-08",
  "description": "Replaced the spigots.",
  "cost_minor": 12000,
  "currency_code": "USD"
}

Respuesta 201: AssetMaintenance

assetMaintenanceEvents.create: AssetMaintenance
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the asset maintenance.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
asset_unit_idstring (uuid)SíIdentifier of the asset unit.
performed_onstring (date)SíWhen the maintenance was done.
descriptionstringSíWhat was done.Restricciones: length 1 to 20000
cost_minorinteger (int64) | nullSíMaintenance cost. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "performed_on": "2026-10-08",
  "description": "Replaced the spigots.",
  "cost_minor": 12000,
  "currency_code": "USD"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/asset-maintenance" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"asset_unit_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","performed_on":"2026-10-08","description":"Replaced the spigots.","cost_minor":12000,"currency_code":"USD"}'
const { data } = await xos.assetMaintenanceEvents.create({
    "asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "performed_on": "2026-10-08",
    "description": "Replaced the spigots.",
    "cost_minor": 12000,
    "currency_code": "USD"
  });
response = xos.asset_maintenance_events.create({"asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "performed_on": "2026-10-08", "description": "Replaced the spigots.", "cost_minor": 12000, "currency_code": "USD"})
xos asset-maintenance-events create --data '{"asset_unit_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","performed_on":"2026-10-08","description":"Replaced the spigots.","cost_minor":12000,"currency_code":"USD"}'