Gets an event by ID

GET /v1/event/{eventID}

Summary

Gets an event by ID.

Details

Returns a reduced event status payload.

The response includes status details for the event.

Authentication

No operation-level security requirement is documented here.

Parameters

Name	In	Type	Required	Description	Example
eventID	path	integer (int64)	Yes	The ID of the event to retrieve.	1

Request Body

No request body is documented here.

Responses

200

Success

application/json

• eventID (integer (int64), optional)
• eventStatus (integer (int64), optional)
• eventParameters (string, optional)
• result (string, optional)
• percentComplete (number (double), optional)
• priority (integer (int64), optional)
• attemptNumber (integer (int64), optional)
• maxAttempts (integer (int64), optional)
• tagString (string, optional)
• tagNumber (integer (int64), optional)

Example

{
  "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
}