Operations
Operational work queues, exception work items and trip marks raised by mass changes.
| Operation | Endpoint |
|---|---|
| Assign, resolve or reopen a work item | POST /oms-ops/mass-changes/{changeId}/items/{tripId}/work-item |
| List price-protection rules | GET /oms-ops/protection-rules |
| List trips carrying a mark | GET /oms-ops/reports/marks |
| List a trip's marks | GET /oms-ops/trips/{tripId}/marks |
| List exception work items | GET /oms-ops/work-items |
| List work queues | GET /oms-ops/work-queues |
Assign, resolve or reopen a work item
POST
/oms-ops/mass-changes/{changeId}/items/{tripId}/work-itemParameters
| Name | In | Required | Notes |
|---|---|---|---|
changeId | path | yes | |
tripId | path | yes |
Headers: Idempotency-Key, plus X-Request-Id.
Response 200
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | The request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details. |
| 401 | unauthenticated | The bearer token is missing, invalid, expired or minted for another purpose. |
| 403 | scope_forbidden | The token is scoped to an agency or an access scope; this surface requires an unscoped tenant token. |
| 404 | item_not_found | The mass change has no item for this trip. |
| 404 | oms_ops_not_enabled | Order operations are not enabled for the tenant. |
| 409 | idempotency_in_progress | A request with this Idempotency-Key is still running. Retry after the Retry-After interval. |
| 422 | idempotency_key_reused | The Idempotency-Key was used for a different request. |
| 500 | internal | Unexpected failure. Retry with the same Idempotency-Key. |
List price-protection rules
GET
/oms-ops/protection-rulesResponse 200
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | The request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details. |
| 401 | unauthenticated | The bearer token is missing, invalid, expired or minted for another purpose. |
| 403 | scope_forbidden | The token is scoped to an agency or an access scope; this surface requires an unscoped tenant token. |
| 404 | oms_ops_not_enabled | Order operations are not enabled for the tenant. |
| 500 | internal | Unexpected failure. Retry with the same Idempotency-Key. |
List trips carrying a mark
GET
/oms-ops/reports/marksParameters
| Name | In | Required | Notes |
|---|---|---|---|
mark | query |
Response 200
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | The request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details. |
| 401 | unauthenticated | The bearer token is missing, invalid, expired or minted for another purpose. |
| 403 | scope_forbidden | The token is scoped to an agency or an access scope; this surface requires an unscoped tenant token. |
| 404 | oms_ops_not_enabled | Order operations are not enabled for the tenant. |
| 500 | internal | Unexpected failure. Retry with the same Idempotency-Key. |
List a trip's marks
GET
/oms-ops/trips/{tripId}/marksParameters
| Name | In | Required | Notes |
|---|---|---|---|
tripId | path | yes |
Response 200
{ marks }, including cleared marks: tripId, mark, sourceRef, detail, createdAt, clearedAt.
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | The request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details. |
| 401 | unauthenticated | The bearer token is missing, invalid, expired or minted for another purpose. |
| 403 | scope_forbidden | The token is scoped to an agency or an access scope; this surface requires an unscoped tenant token. |
| 404 | oms_ops_not_enabled | Order operations are not enabled for the tenant. |
| 500 | internal | Unexpected failure. Retry with the same Idempotency-Key. |
List exception work items
GET
/oms-ops/work-itemsParameters
| Name | In | Required | Notes |
|---|---|---|---|
team | query | ||
status | query | ||
reason | query | ||
changeId | query | ||
limit | query | Default 50, maximum 200.; integer | |
offset | query | integer |
Response 200
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | The request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details. |
| 401 | unauthenticated | The bearer token is missing, invalid, expired or minted for another purpose. |
| 403 | scope_forbidden | The token is scoped to an agency or an access scope; this surface requires an unscoped tenant token. |
| 404 | order_operations_not_enabled | The order operations policy section is not configured for the tenant. |
| 404 | oms_ops_not_enabled | Order operations are not enabled for the tenant. |
| 500 | internal | Unexpected failure. Retry with the same Idempotency-Key. |
List work queues
GET
/oms-ops/work-queuesResponse 200
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | The request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details. |
| 401 | unauthenticated | The bearer token is missing, invalid, expired or minted for another purpose. |
| 403 | scope_forbidden | The token is scoped to an agency or an access scope; this surface requires an unscoped tenant token. |
| 404 | oms_ops_not_enabled | Order operations are not enabled for the tenant. |
| 500 | internal | Unexpected failure. Retry with the same Idempotency-Key. |