LAlance-format
Transaction
Metadata

Describe information about a transaction

Changed on

Return a detailed information for a given transaction

post/v1/transaction/{id}/describe

Request

  • Base URL
    http://localhost:2333
  • Auth
    • OAuth 2
      Client credentials
      Token URL: /oauth/token
    • or HTTP bearer
    • or API key in header x-api-key

Path parameters

idstring required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

Query parameters

delimiterstring

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Request body

contextunknown
idstring[]

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ]
}

Response

Response of DescribeTransaction

contextunknown
statusstring required

The status of a transaction. Case insensitive, supports both PascalCase and snake_case. Valid values are:

  • Queued: the transaction is queued and not yet started
  • Running: the transaction is currently running
  • Succeeded: the transaction has completed successfully
  • Failed: the transaction has failed
  • Canceled: the transaction was canceled
propertiesunknown

Example response

{
  "context": {
    "key": "context"
  },
  "properties": {
    "key": "properties"
  },
  "status": "status"
}

Changes

  • 591cd95574b0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 83f8516f0507Revision changes
    • info

      added the new optional request property