Skip to main content

OperationResponsePagedResponse

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

items object[]nullable

The items on this page.

  • Array [
  • idstring<uuid>

    Id of the operation.

    typeOperationType (string)

    Type discriminator of the resource.

    Possible values: [VmDeprovision, VmProvision, VmRebuild]

    statusApiOperationStatus (string)

    Current status of the resource.

    Possible values: [Queued, InProgress, Compensation, Succeeded, Failed]

    projectIdstring<uuid>

    Id of the project the operation belongs to.

    createdAtstring<date-time>

    When the operation was created (accepted).

    updatedAtstring<date-time>

    When the operation was last updated.

    startedAtstring<date-time>nullable

    When the operation started executing, if it has started.

    finishedAtstring<date-time>nullable

    When the operation finished (succeeded or failed), if it has finished.

    lastErrorstringnullable

    The last error message recorded for the operation, if any.

    currentStatestringnullable

    Optional diagnostic label describing the operation's current step. The set of possible values is not stable and should not be relied on programmatically — use Status for logic.

  • ]
  • 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.

    OperationResponsePagedResponse
    {
    "items": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "VmDeprovision",
    "status": "Queued",
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "startedAt": "2024-07-29T15:51:28.071Z",
    "finishedAt": "2024-07-29T15:51:28.071Z",
    "lastError": "string",
    "currentState": "string"
    }
    ],
    "total": 0,
    "page": 0,
    "pageSize": 0,
    "totalPages": 0,
    "hasNextPage": true
    }