Class RowsBatchApi

Index

Constructors

Methods

cloneDraftTableRows cloneDraftTableRowsWithHttpInfo createDraftTableRows createDraftTableRowsWithHttpInfo purgeDraftTableRows purgeDraftTableRowsWithHttpInfo readDraftTableRows readDraftTableRowsWithHttpInfo readTableRows readTableRowsWithHttpInfo replaceDraftTableRows replaceDraftTableRowsWithHttpInfo updateDraftTableRows updateDraftTableRowsWithHttpInfo

Constructors

constructor

new RowsBatchApi(configuration, requestFactory?, responseProcessor?): RowsBatchApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: RowsBatchApiRequestFactory
- OptionalresponseProcessor: RowsBatchApiResponseProcessor
Returns RowsBatchApi
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:271

Methods

cloneDraftTableRows

cloneDraftTableRows(tableIdOrName, batchInputHubDbTableRowBatchCloneRequest, _options?): Promise<BatchResponseHubDbTableRowV3>
Clones rows in the draft version of the specified table, given a set of row ids. Maximum of 100 row ids per call. Clone rows in batch
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputHubDbTableRowBatchCloneRequest: BatchInputHubDbTableRowBatchCloneRequest
- Optional_options: Configuration
Returns Promise<BatchResponseHubDbTableRowV3>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:296

cloneDraftTableRowsWithHttpInfo

cloneDraftTableRowsWithHttpInfo(tableIdOrName, batchInputHubDbTableRowBatchCloneRequest, _options?): Promise<HttpInfo<BatchResponseHubDbTableRowV3>>
Clones rows in the draft version of the specified table, given a set of row ids. Maximum of 100 row ids per call. Clone rows in batch
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputHubDbTableRowBatchCloneRequest: BatchInputHubDbTableRowBatchCloneRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3>>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:285

createDraftTableRows

createDraftTableRows(tableIdOrName, batchInputHubDbTableRowV3Request, _options?): Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
Creates rows in the draft version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example. Create rows in batch
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputHubDbTableRowV3Request: BatchInputHubDbTableRowV3Request
- Optional_options: Configuration
Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:318

createDraftTableRowsWithHttpInfo

createDraftTableRowsWithHttpInfo(tableIdOrName, batchInputHubDbTableRowV3Request, _options?): Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
Creates rows in the draft version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example. Create rows in batch
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputHubDbTableRowV3Request: BatchInputHubDbTableRowV3Request
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:307

purgeDraftTableRows

purgeDraftTableRows(tableIdOrName, batchInputString, _options?): Promise<void>
Permanently deletes rows from the draft version of the table, given a set of row IDs. Maximum of 100 row IDs per call. Permanently deletes rows
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputString: BatchInputString
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:340

purgeDraftTableRowsWithHttpInfo

purgeDraftTableRowsWithHttpInfo(tableIdOrName, batchInputString, _options?): Promise<HttpInfo<void>>
Permanently deletes rows from the draft version of the table, given a set of row IDs. Maximum of 100 row IDs per call. Permanently deletes rows
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputString: BatchInputString
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:329

readDraftTableRows

readDraftTableRows(tableIdOrName, batchInputString, _options?): Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
Returns rows in the draft version of the specified table, given a set of row IDs. Get a set of rows from draft table
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputString: BatchInputString
- Optional_options: Configuration
Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:362

readDraftTableRowsWithHttpInfo

readDraftTableRowsWithHttpInfo(tableIdOrName, batchInputString, _options?): Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
Returns rows in the draft version of the specified table, given a set of row IDs. Get a set of rows from draft table
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputString: BatchInputString
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:351

readTableRows

readTableRows(tableIdOrName, batchInputString, _options?): Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
Returns rows in the published version of the specified table, given a set of row IDs. Note: This endpoint can be accessed without any authentication if the table is set to be allowed for public access. Get a set of rows
Parameters
- tableIdOrName: string
  The ID or name of the table to query.
- batchInputString: BatchInputString
- Optional_options: Configuration
Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:384

readTableRowsWithHttpInfo

readTableRowsWithHttpInfo(tableIdOrName, batchInputString, _options?): Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
Returns rows in the published version of the specified table, given a set of row IDs. Note: This endpoint can be accessed without any authentication if the table is set to be allowed for public access. Get a set of rows
Parameters
- tableIdOrName: string
  The ID or name of the table to query.
- batchInputString: BatchInputString
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:373

replaceDraftTableRows

replaceDraftTableRows(tableIdOrName, batchInputHubDbTableRowV3BatchUpdateRequest, _options?): Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
Replaces multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint PUT /tables/{tableIdOrName}/rows/{rowId}/draft for details on updating a single row. Replace rows in batch in draft table
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputHubDbTableRowV3BatchUpdateRequest: BatchInputHubDbTableRowV3BatchUpdateRequest
- Optional_options: Configuration
Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:406

replaceDraftTableRowsWithHttpInfo

replaceDraftTableRowsWithHttpInfo(tableIdOrName, batchInputHubDbTableRowV3BatchUpdateRequest, _options?): Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
Replaces multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint PUT /tables/{tableIdOrName}/rows/{rowId}/draft for details on updating a single row. Replace rows in batch in draft table
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputHubDbTableRowV3BatchUpdateRequest: BatchInputHubDbTableRowV3BatchUpdateRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:395

updateDraftTableRows

updateDraftTableRows(tableIdOrName, batchInputHubDbTableRowV3BatchUpdateRequest, _options?): Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
Updates multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint PATCH /tables/{tableIdOrName}/rows/{rowId}/draft for details on updating a single row. Update rows in batch in draft table
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputHubDbTableRowV3BatchUpdateRequest: BatchInputHubDbTableRowV3BatchUpdateRequest
- Optional_options: Configuration
Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:428

updateDraftTableRowsWithHttpInfo

updateDraftTableRowsWithHttpInfo(tableIdOrName, batchInputHubDbTableRowV3BatchUpdateRequest, _options?): Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
Updates multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint PATCH /tables/{tableIdOrName}/rows/{rowId}/draft for details on updating a single row. Update rows in batch in draft table
Parameters
- tableIdOrName: string
  The ID or name of the table
- batchInputHubDbTableRowV3BatchUpdateRequest: BatchInputHubDbTableRowV3BatchUpdateRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>
- Defined in codegen/cms/hubdb/types/PromiseAPI.ts:417

Class RowsBatchApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RowsBatchApi

Methods

cloneDraftTableRows

Parameters

Returns Promise<BatchResponseHubDbTableRowV3>

cloneDraftTableRowsWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3>>

createDraftTableRows

Parameters

Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>

createDraftTableRowsWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>

purgeDraftTableRows

Parameters

Returns Promise<void>

purgeDraftTableRowsWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

readDraftTableRows

Parameters

Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>

readDraftTableRowsWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>

readTableRows

Parameters

Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>

readTableRowsWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>

replaceDraftTableRows

Parameters

Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>

replaceDraftTableRowsWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>

updateDraftTableRows

Parameters

Returns Promise<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>

updateDraftTableRowsWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseHubDbTableRowV3 | BatchResponseHubDbTableRowV3WithErrors>>

Settings

On This Page