Order Management System REST API - Order Controller
The order URI provides access to known Orders.
Retrieve all known Orders
Section titled “Retrieve all known Orders”GET /order
Retrieves all Orders known to OMS.
Requires the Operator or Admin feature permissions.
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| asAt | Optional | An ISO8601 date and time. The results returned will be those at the given timestamp. If omitted, returns the latest results. |
| onlyActive | Optional | Boolean. When true, only returns orders that remain active. Orders with a status marked IsComplete will be omitted. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | Content is an array of OrderState objects. |
| 403 | Failure | The authenticated identity does not have the Admin permission. |