v52

latestOpenAPI 3.1.1Apache 2.0raw.githubusercontent.com2026-08-0354155395.9 KB

Transaction

Metadata

Alter information of a transaction.

Alter a transaction with a list of actions such as setting status or properties. The server should either succeed and apply all actions, or fail and apply no action.

post/v1/transaction/{id}/alter

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

{"stackTrail":"components:schemas:AlterTransactionRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

idstring[]

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "actions": [
    {
      "setStatusAction": {
        "status": "status"
      },
      "unsetPropertyAction": {
        "mode": "mode",
        "key": "key"
      },
      "setPropertyAction": {
        "mode": "mode",
        "value": "value",
        "key": "key"
      }
    },
    {
      "setStatusAction": {
        "status": "status"
      },
      "unsetPropertyAction": {
        "mode": "mode",
        "key": "key"
      },
      "setPropertyAction": {
        "mode": "mode",
        "value": "value",
        "key": "key"
      }
    }
  ]
}

Response

Response of AlterTransaction

{"stackTrail":"components:schemas:AlterTransactionResponse:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

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

{"stackTrail":"components:schemas:AlterTransactionResponse:properties:properties","oasType":"schema","type":"unknown"}

Example response

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