Skip to main content
POST
/
v1
/
transaction
/
{id}
/
describe
Describe information about a transaction
curl --request POST \
  --url {scheme}://{host}:{port}/{basePath}/v1/transaction/{id}/describe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": [
    "<string>"
  ]
}
'
{
  "status": "<string>",
  "properties": {}
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
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

​
delimiter
string

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

Body

application/json
​
id
string[]

Response

Response of DescribeTransaction

​
status
string
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
​
properties
object