Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Organization

Get service hierarchical state machines for an organization

Return a list of service hierarchical state machines for the organization.

Permissions

This endpoint may be impacted by the following permissions:

  • Only state machines that the authenticated user has the Organization:GetServiceHierarchicalStateMachine permission on will be returned.
get/v1/{organization}/organization/service_hierarchical_state_machine

Path parameters

organizationstring required

Query parameters

deprecatedboolean nullable

Whether the state machine is deprecated.

Whether the state machine is deprecated.

idstring[]

The IDs of the state machines to filter for.

The IDs of the state machines to filter for.

limitinteger

The maximum number of service hierarchical state machines to return.

The maximum number of service hierarchical state machines to return.

continuation_tokeninteger

The continuation token from the previous request used to retrieve the next page of state machines.

The continuation token from the previous request used to retrieve the next page of state machines.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

has_moreboolean required

Whether there are more state machines to fetch.

continuation_tokeninteger nullable required

A token to supply to the next request to retrieve the next page of state machines. Only populated if has_more is True.