AXaxle
4. Assets

Event Handling Status Update

Changed on

Provide an update on the handling of a given event by a given asset.

This endpoint allows asset controllers to report back the status of event handling. The asset_id can be either the Axle UUID or an external ID if asset_id_is_external is true.

Note: This will not work for non-UUID external asset IDs.

post/entities/asset/{asset_id}/callback/{event_id}

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/asset/{asset_id}/callback/{event_id}
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Path parameters

asset_idstring uuid required
event_idstring required

Query parameters

asset_id_is_externalboolean

Request body

timestampstring date-time required

Timestamp for the response (UTC)

status'RECEIVED' | 'ACCEPTED' | 'REJECTED' | 'FAILED' | 'EXECUTED' required

Status values for asset event handling.

  • RECEIVED: Event was received by the system
  • ACCEPTED: Event was accepted for processing
  • REJECTED: Event was rejected (invalid or not applicable)
  • FAILED: Event processing failed
  • EXECUTED: Event was successfully executed

Response

Status update successfully recorded

unknown required

Changes

  • b0b07b1dbf12Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value ACCEPTED of the request property

    • breaking

      removed the enum value EXECUTED of the request property

    • breaking

      removed the enum value FAILED of the request property

    • breaking

      removed the enum value RECEIVED of the request property

    • breaking

      removed the enum value REJECTED of the request property

    • breaking

      the request property type changed from string to no type