Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchUpdateTableRows

The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.

You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").

Request Syntax


POST /workbooks/workbookId/tables/tableId/rows/batchupdate HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "rowsToUpdate": [ 
      { 
         "cellsToUpdate": { 
            "string" : { 
               "fact": "string",
               "facts": [ "string" ]
            }
         },
         "rowId": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

tableId

The ID of the table where the rows are being updated.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

workbookId

The ID of the workbook where the rows are being updated.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No

rowsToUpdate

The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

Type: Array of UpdateRowData objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "failedBatchItems": [ 
      { 
         "errorMessage": "string",
         "id": "string"
      }
   ],
   "workbookCursor": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failedBatchItems

The list of batch items in the request that could not be updated in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated.

Type: Array of FailedBatchItem objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

workbookCursor

The updated workbook cursor after adding the new rows at the end of the table.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403

InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500

RequestTimeoutException

The request timed out.

HTTP Status Code: 504

ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404

ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503

ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429

ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400