v51

OpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-01133591927.1 KB

OIAnalytics Commands

Search OIAnalytics commands

Searches OIAnalytics commands with optional filtering by type, status, and time range.

get/api/oianalytics/commands/search

Query parameters

typesstring required

Comma-separated list of command types to filter by (e.g. update-version,restart-engine).

statusstring required

Comma-separated list of statuses to filter by (e.g. COMPLETED,ERRORED). Valid values: RETRIEVED, RUNNING, ERRORED, CANCELLED, COMPLETED.

startstring required

Represents an instant in time as an ISO 8601 string.

Example:2023-10-31T12:34:56.789Z

ISO 8601 start of the time range.

endstring required

Represents an instant in time as an ISO 8601 string.

Example:2023-10-31T12:34:56.789Z

ISO 8601 end of the time range.

ackboolean required

Filter by acknowledgement status. true returns only acknowledged commands.

pagenumber double

Response

Paginated list of commands

totalElementsnumber double required

The total number of elements across all pages.

sizenumber double required

The size of the page, i.e., the maximum number of elements per page.

numbernumber double required

The number of the current page, starting at 0.

totalPagesnumber double required

The total number of pages (which can be 0 if there are no elements).

Example response

{
  "content": [
    {
      "id": "cmd123",
      "ack": true,
      "retrievedDate": "2023-10-31T12:34:56.789Z",
      "completedDate": "2023-10-31T12:34:56.789Z",
      "result": "Success",
      "commandContent": {
        "backupFolders": "/backup",
        "updateLauncher": true,
        "assetId": "asset123",
        "version": "3.7.0"
      }
    }
  ],
  "totalElements": 2,
  "size": 10,
  "totalPages": 1
}