{ "opencollection": "1.0.0", "info": { "name": "AI Service Actions Tables API", "version": "1.0.0" }, "items": [ { "info": { "name": "Tables", "type": "folder" }, "items": [ { "info": { "name": "Create columns in a table", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:id/columns", "headers": [ { "name": "X-KBC-Backend", "value": "" } ], "params": [ { "name": "branchId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds one or more columns to the specified table." }, { "info": { "name": "Create columns in a table", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/storage/tables/:id/columns", "headers": [ { "name": "X-KBC-Backend", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds one or more columns to the specified table." }, { "info": { "name": "List table snapshots", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:id/snapshots", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." }, { "name": "limit", "value": "", "type": "query", "description": "Number of snapshots to return. Omit to return all snapshots." }, { "name": "offset", "value": "", "type": "query", "description": "Pagination offset." }, { "name": "branchId", "value": "", "type": "path" } ] }, "docs": "List all snapshots created for a table." }, { "info": { "name": "Create table snapshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:id/snapshots", "headers": [ { "name": "X-KBC-Backend", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." }, { "name": "branchId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a snapshot of a table. Returns a storage job.\n\nInitial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [TableSnapshotCreateJobResult](#model-TableSnapshotCreateJobResult)." }, { "info": { "name": "List table snapshots", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/storage/tables/:id/snapshots", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." }, { "name": "limit", "value": "", "type": "query", "description": "Number of snapshots to return. Omit to return all snapshots." }, { "name": "offset", "value": "", "type": "query", "description": "Pagination offset." } ] }, "docs": "List all snapshots created for a table." }, { "info": { "name": "Create table snapshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/storage/tables/:id/snapshots", "headers": [ { "name": "X-KBC-Backend", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a snapshot of a table. Returns a storage job.\n\nInitial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [TableSnapshotCreateJobResult](#model-TableSnapshotCreateJobResult)." }, { "info": { "name": "List table metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:id/metadata", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." }, { "name": "branchId", "value": "", "type": "path" } ] }, "docs": "Returns all metadata records for the specified table." }, { "info": { "name": "Create or update table metadata", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:id/metadata", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." }, { "name": "branchId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates new metadata records or updates existing ones for the specified table and its columns." }, { "info": { "name": "List table metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/storage/tables/:id/metadata", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." } ] }, "docs": "Returns all metadata records for the specified table." }, { "info": { "name": "Create or update table metadata", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/storage/tables/:id/metadata", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates new metadata records or updates existing ones for the specified table and its columns." }, { "info": { "name": "Update table definition", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:tableId/definition", "headers": [ { "name": "X-KBC-Backend", "value": "" } ], "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table string id (e.g. `in.c-main.orders`)." }, { "name": "branchId", "value": "", "type": "path" } ] }, "docs": "Updates table and column definition metadata. Async-only - returns 202 with a storage job; poll it for completion. Backend DDL changes are not atomic across multiple column operations. If the async job fails after applying some changes, previously applied changes may remain applied. Re-read the table definition before retrying.\n\nInitial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job compl" }, { "info": { "name": "Update table definition", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/storage/tables/:tableId/definition", "headers": [ { "name": "X-KBC-Backend", "value": "" } ], "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table string id (e.g. `in.c-main.orders`)." } ] }, "docs": "Updates table and column definition metadata. Async-only - returns 202 with a storage job; poll it for completion. Backend DDL changes are not atomic across multiple column operations. If the async job fails after applying some changes, previously applied changes may remain applied. Re-read the table definition before retrying.\n\nInitial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job compl" }, { "info": { "name": "Get table detail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." }, { "name": "branchId", "value": "", "type": "path" } ] }, "docs": "Retrieve detailed information about a table including metadata and bucket info." }, { "info": { "name": "Get table detail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/storage/tables/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." } ] }, "docs": "Retrieve detailed information about a table including metadata and bucket info." }, { "info": { "name": "Delete table metadata", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:id/metadata/:metadataId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." }, { "name": "metadataId", "value": "", "type": "path", "description": "Identifier of the metadata record." }, { "name": "branchId", "value": "", "type": "path" } ] }, "docs": "Deletes a metadata record for the specified storage table." }, { "info": { "name": "Delete table metadata", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/storage/tables/:id/metadata/:metadataId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the table." }, { "name": "metadataId", "value": "", "type": "path", "description": "Identifier of the metadata record." } ] }, "docs": "Deletes a metadata record for the specified storage table." }, { "info": { "name": "Swap two tables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/storage/branch/:branchId/tables/:tableId/swap", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Source table string id (e.g. `in.c-main.orders`)." }, { "name": "branchId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exchanges the physical storage of two tables in the same bucket. Async-only — returns 202 with a storage job; poll it for completion. Aliases are not transferred with table identity: each alias keeps pointing at the same physical position, so after the swap aliases expose the data of the other table. Both tables must live in the same bucket on the same backend connection.\n\nInitial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched vi" } ] } ], "bundled": true }