Skip to main content

SagaAdminResponsePagedResponse

A generic page of results, used by list endpoints across this API.

items object[]nullable

The items on this page.

  • Array [
  • sagaTypestringnullable

    Value of saga type.

    correlationIdstring<uuid>

    Unique identifier of the correlation in UUID format.

    currentStatestringnullable

    Value of current state.

    currentClusterCommandIdstring<uuid>nullable

    Unique identifier of the current cluster command in UUID format.

    isCompensatingboolean

    Boolean flag that controls is compensating.

    compensationStartedAtUtcstring<date-time>nullable

    Value of compensation started at utc.

    compensationStackstring[]nullable

    List of values for compensation stacks.

    lastErrorstringnullable

    Value of last error.

    operationVersioninteger<int64>

    Value of operation version.

    sagaData objectnullable

    Value of saga data.

    property name*stringnullable
  • ]
  • totalinteger<int32>

    Total number of items across all pages.

    pageinteger<int32>

    The current page number, starting at 1.

    pageSizeinteger<int32>

    Number of items per page.

    totalPagesinteger<int32>

    Total number of pages available.

    hasNextPageboolean

    Whether a next page is available.

    SagaAdminResponsePagedResponse
    {
    "items": [
    {
    "sagaType": "string",
    "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "currentState": "string",
    "currentClusterCommandId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isCompensating": true,
    "compensationStartedAtUtc": "2024-07-29T15:51:28.071Z",
    "compensationStack": [
    "string"
    ],
    "lastError": "string",
    "operationVersion": 0,
    "sagaData": {}
    }
    ],
    "total": 0,
    "page": 0,
    "pageSize": 0,
    "totalPages": 0,
    "hasNextPage": true
    }