Monitoring

Integration monitoring. Message trace, exceptions, missing-feedback alerts and connected-system health. Available when monitoring is enabled for the tenant.

Operation	Endpoint
List missing-feedback alerts	GET /order-orchestration/alerts
Acknowledge an alert	POST /order-orchestration/alerts/{alertId}/acknowledge
Re-send the request an alert is waiting on	POST /order-orchestration/alerts/{alertId}/replay-request
Read one message with its mapping, chain and attempts	GET /order-orchestration/events/{seq}
Assign a message to a team	POST /order-orchestration/events/{seq}/assign
Dismiss a message	POST /order-orchestration/events/{seq}/dismiss
Reconcile a message by hand	POST /order-orchestration/events/{seq}/reconcile
List integration exceptions	GET /order-orchestration/exceptions
Mark expected feedback as received by hand	POST /order-orchestration/feedback/{expectationId}/reconcile
Raise alerts for overdue status feedback	POST /order-orchestration/feedback/sweep
List integration messages	GET /order-orchestration/messages
Read a connected system's health	GET /order-orchestration/systems/{id}/health
Read a connected system's health (monitoring)	GET /order-orchestration/systems/{systemId}/health
Read the health of every connected system	GET /order-orchestration/systems/health
Trace the messages of a trip or purchase order	GET /order-orchestration/trace

List missing-feedback alerts

GET/order-orchestration/alerts

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	not_enabled	Order orchestration is not enabled for the tenant.
500	internal	Unexpected failure. Retry with the same Idempotency-Key.

Acknowledge an alert

POST/order-orchestration/alerts/{alertId}/acknowledge

Parameters

Name	In	Required	Notes
alertId	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	not_enabled	Order orchestration is 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.

Re-send the request an alert is waiting on

POST/order-orchestration/alerts/{alertId}/replay-request

Parameters

Name	In	Required	Notes
alertId	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	not_enabled	Order orchestration is 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.

Read one message with its mapping, chain and attempts

GET/order-orchestration/events/{seq}

Parameters

Name	In	Required	Notes
seq	path	yes

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	not_enabled	Order orchestration is not enabled for the tenant.
500	internal	Unexpected failure. Retry with the same Idempotency-Key.

Assign a message to a team

POST/order-orchestration/events/{seq}/assign

Parameters

Name	In	Required	Notes
seq	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	not_enabled	Order orchestration is 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.

Dismiss a message

POST/order-orchestration/events/{seq}/dismiss

Parameters

Name	In	Required	Notes
seq	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	not_enabled	Order orchestration is 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.

Reconcile a message by hand

POST/order-orchestration/events/{seq}/reconcile

Parameters

Name	In	Required	Notes
seq	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	not_enabled	Order orchestration is 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 integration exceptions

GET/order-orchestration/exceptions

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	not_enabled	Order orchestration is not enabled for the tenant.
500	internal	Unexpected failure. Retry with the same Idempotency-Key.

Mark expected feedback as received by hand

POST/order-orchestration/feedback/{expectationId}/reconcile

Parameters

Name	In	Required	Notes
expectationId	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	not_enabled	Order orchestration is 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.

Raise alerts for overdue status feedback

POST/order-orchestration/feedback/sweep

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	not_enabled	Order orchestration is 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 integration messages

GET/order-orchestration/messages

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	not_enabled	Order orchestration is not enabled for the tenant.
500	internal	Unexpected failure. Retry with the same Idempotency-Key.

Read a connected system's health

GET/order-orchestration/systems/{id}/health

Parameters

Name	In	Required	Notes
id	path	yes
window	query		24h (default) or 7d.

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	not_found	The trip, purchase order, quotation or configuration item does not exist.
404	not_enabled	Order orchestration is not enabled for the tenant.
500	internal	Unexpected failure. Retry with the same Idempotency-Key.

Read a connected system's health (monitoring)

GET/order-orchestration/systems/{systemId}/health

Parameters

Name	In	Required	Notes
systemId	path	yes

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	not_enabled	Order orchestration is not enabled for the tenant.
500	internal	Unexpected failure. Retry with the same Idempotency-Key.

Read the health of every connected system

GET/order-orchestration/systems/health

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	not_enabled	Order orchestration is not enabled for the tenant.
500	internal	Unexpected failure. Retry with the same Idempotency-Key.

Trace the messages of a trip or purchase order

GET/order-orchestration/trace

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	not_enabled	Order orchestration is not enabled for the tenant.
500	internal	Unexpected failure. Retry with the same Idempotency-Key.