Event

Gets an event by ID.

Returns a reduced event status payload. The response includes status details for the event.

get/v1/event/{eventID}

Request

  • Base URL: https://api.actionstreamer.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.actionstreamer.com/v1/event/{eventID}
  • Auth: none declared

Path parameters

eventIDinteger required
Example:1

The ID of the event to retrieve.

Response

Success

eventIDinteger
eventStatusinteger
eventParametersstring nullable
resultstring nullable
percentCompletenumber double
priorityinteger
attemptNumberinteger
maxAttemptsinteger
tagStringstring nullable
tagNumberinteger

Example response

{
  "eventID": 501,
  "eventStatus": 1,
  "eventParameters": "{\"presetName\":\"Run Event Preset\"}",
  "result": "Example value",
  "percentComplete": 42.5,
  "priority": 1,
  "attemptNumber": 1,
  "maxAttempts": 3,
  "tagString": "Example value",
  "tagNumber": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.