Class AppElementApi

Hierarchy

BaseAPI
- AppElementApi

Index

Constructors

Properties

Methods

abortTransaction abortTransactionRaw bulkCreateElement bulkCreateElementRaw commitTransactions commitTransactionsRaw compareAppElementJson compareAppElementJsonRaw createElement createElementRaw createReference createReferenceRaw deleteAppElementContent deleteAppElementContentRaw deleteBlobSubelement deleteBlobSubelementRaw deleteReference deleteReferenceRaw downloadBlobSubelement downloadBlobSubelementRaw downloadBlobSubelementWorkspace downloadBlobSubelementWorkspaceRaw getAppElementHistory getAppElementHistoryRaw getBlobSubelementIds getBlobSubelementIdsRaw getElementTransactions getElementTransactionsRaw getJson getJsonPaths getJsonPathsRaw getJsonRaw getSubElementContent getSubElementContentRaw getSubelementIds getSubelementIdsRaw request resolveReference resolveReferenceRaw resolveReferences resolveReferencesRaw startTransaction startTransactionRaw updateAppElement updateAppElementRaw updateReference updateReferenceRaw uploadBlobSubelement uploadBlobSubelementRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new AppElementApi(configuration?: Configuration): AppElementApi
Parameters
- configuration: Configuration = DefaultConfig
Returns AppElementApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

abortTransaction

abortTransaction(requestParameters: AbortTransactionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Abort transaction by document ID, workspace ID, tab ID, and transaction ID.
Parameters
- requestParameters: AbortTransactionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/AppElementApi.ts:360

abortTransactionRaw

abortTransactionRaw(requestParameters: AbortTransactionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Abort transaction by document ID, workspace ID, tab ID, and transaction ID.
Parameters
- requestParameters: AbortTransactionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/AppElementApi.ts:314

bulkCreateElement

bulkCreateElement(requestParameters: BulkCreateElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementBulkCreateInfo>
Creates several new empty application elements in the document. Create multiple empty application tabs by document ID and workspace ID.
Parameters
- requestParameters: BulkCreateElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementBulkCreateInfo>
- Defined in apis/AppElementApi.ts:415

bulkCreateElementRaw

bulkCreateElementRaw(requestParameters: BulkCreateElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementBulkCreateInfo>>
Creates several new empty application elements in the document. Create multiple empty application tabs by document ID and workspace ID.
Parameters
- requestParameters: BulkCreateElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementBulkCreateInfo>>
- Defined in apis/AppElementApi.ts:369

commitTransactions

commitTransactions(requestParameters: CommitTransactionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementModifyInfo>
Commit transactions by document ID and workspace ID.
Parameters
- requestParameters: CommitTransactionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementModifyInfo>
- Defined in apis/AppElementApi.ts:468

commitTransactionsRaw

commitTransactionsRaw(requestParameters: CommitTransactionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementModifyInfo>>
Commit transactions by document ID and workspace ID.
Parameters
- requestParameters: CommitTransactionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementModifyInfo>>
- Defined in apis/AppElementApi.ts:423

compareAppElementJson

compareAppElementJson(requestParameters: CompareAppElementJsonRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDiffJsonResponse2725>
Compare JSON by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: CompareAppElementJsonRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDiffJsonResponse2725>
- Defined in apis/AppElementApi.ts:538

compareAppElementJsonRaw

compareAppElementJsonRaw(requestParameters: CompareAppElementJsonRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDiffJsonResponse2725>>
Compare JSON by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: CompareAppElementJsonRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDiffJsonResponse2725>>
- Defined in apis/AppElementApi.ts:476

createElement

createElement(requestParameters: CreateElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementModifyInfo>
Create application tab by document ID and workspace ID.
Parameters
- requestParameters: CreateElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementModifyInfo>
- Defined in apis/AppElementApi.ts:591

createElementRaw

createElementRaw(requestParameters: CreateElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementModifyInfo>>
Create application tab by document ID and workspace ID.
Parameters
- requestParameters: CreateElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementModifyInfo>>
- Defined in apis/AppElementApi.ts:546

createReference

createReference(requestParameters: CreateReferenceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementReferenceInfo>
Create referencesby document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: CreateReferenceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementReferenceInfo>
- Defined in apis/AppElementApi.ts:648

createReferenceRaw

createReferenceRaw(requestParameters: CreateReferenceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementReferenceInfo>>
Create referencesby document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: CreateReferenceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementReferenceInfo>>
- Defined in apis/AppElementApi.ts:599

deleteAppElementContent

deleteAppElementContent(requestParameters: DeleteAppElementContentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementModifyInfo>
Delete subelement array by document ID, workspace or version or microversion ID, tab ID, and subelement ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: DeleteAppElementContentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementModifyInfo>
- Defined in apis/AppElementApi.ts:714

deleteAppElementContentRaw

deleteAppElementContentRaw(requestParameters: DeleteAppElementContentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementModifyInfo>>
Delete subelement array by document ID, workspace or version or microversion ID, tab ID, and subelement ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: DeleteAppElementContentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementModifyInfo>>
- Defined in apis/AppElementApi.ts:656

deleteBlobSubelement

deleteBlobSubelement(requestParameters: DeleteBlobSubelementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementModifyInfo>
Delete blob subelement file by document ID, workspace ID, tab ID, and blob ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: DeleteBlobSubelementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementModifyInfo>
- Defined in apis/AppElementApi.ts:772

deleteBlobSubelementRaw

deleteBlobSubelementRaw(requestParameters: DeleteBlobSubelementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementModifyInfo>>
Delete blob subelement file by document ID, workspace ID, tab ID, and blob ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: DeleteBlobSubelementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementModifyInfo>>
- Defined in apis/AppElementApi.ts:722

deleteReference

deleteReference(requestParameters: DeleteReferenceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementReferenceInfo>
Delete references by document ID, workspace or version or microversion ID, tab ID, and resolve ID.
Parameters
- requestParameters: DeleteReferenceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementReferenceInfo>
- Defined in apis/AppElementApi.ts:838

deleteReferenceRaw

deleteReferenceRaw(requestParameters: DeleteReferenceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementReferenceInfo>>
Delete references by document ID, workspace or version or microversion ID, tab ID, and resolve ID.
Parameters
- requestParameters: DeleteReferenceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementReferenceInfo>>
- Defined in apis/AppElementApi.ts:780

downloadBlobSubelement

downloadBlobSubelement(requestParameters: DownloadBlobSubelementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Blob>
Download blob subelement file by document ID, version or microversion ID, tab ID, and blob ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: DownloadBlobSubelementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Blob>
- Defined in apis/AppElementApi.ts:912

downloadBlobSubelementRaw

downloadBlobSubelementRaw(requestParameters: DownloadBlobSubelementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Blob>>
Download blob subelement file by document ID, version or microversion ID, tab ID, and blob ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: DownloadBlobSubelementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Blob>>
- Defined in apis/AppElementApi.ts:846

downloadBlobSubelementWorkspace

downloadBlobSubelementWorkspace(requestParameters: DownloadBlobSubelementWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Blob>
Download blob subelement as a file by document ID, workspace ID, tab ID, and blob ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: DownloadBlobSubelementWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Blob>
- Defined in apis/AppElementApi.ts:978

downloadBlobSubelementWorkspaceRaw

downloadBlobSubelementWorkspaceRaw(requestParameters: DownloadBlobSubelementWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Blob>>
Download blob subelement as a file by document ID, workspace ID, tab ID, and blob ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: DownloadBlobSubelementWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Blob>>
- Defined in apis/AppElementApi.ts:920

getAppElementHistory

getAppElementHistory(requestParameters: GetAppElementHistoryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementHistoryInfo>
Retrieve history by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetAppElementHistoryRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementHistoryInfo>
- Defined in apis/AppElementApi.ts:1028

getAppElementHistoryRaw

getAppElementHistoryRaw(requestParameters: GetAppElementHistoryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementHistoryInfo>>
Retrieve history by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetAppElementHistoryRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementHistoryInfo>>
- Defined in apis/AppElementApi.ts:986

getBlobSubelementIds

getBlobSubelementIds(requestParameters: GetBlobSubelementIdsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementIdsInfo>
Retrieve an array of blob subelement IDs by document ID and workspace or microversion ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: GetBlobSubelementIdsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementIdsInfo>
- Defined in apis/AppElementApi.ts:1086

getBlobSubelementIdsRaw

getBlobSubelementIdsRaw(requestParameters: GetBlobSubelementIdsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementIdsInfo>>
Retrieve an array of blob subelement IDs by document ID and workspace or microversion ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: GetBlobSubelementIdsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementIdsInfo>>
- Defined in apis/AppElementApi.ts:1036

getElementTransactions

getElementTransactions(requestParameters: GetElementTransactionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementTransactionsInfo>
Retrieve an array of tab transactions by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: GetElementTransactionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementTransactionsInfo>
- Defined in apis/AppElementApi.ts:1132

getElementTransactionsRaw

getElementTransactionsRaw(requestParameters: GetElementTransactionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementTransactionsInfo>>
Retrieve an array of tab transactions by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: GetElementTransactionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementTransactionsInfo>>
- Defined in apis/AppElementApi.ts:1094

getJson

getJson(requestParameters: GetJsonRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTGetJsonResponse2137>
Retrieve JSON by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetJsonRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTGetJsonResponse2137>
- Defined in apis/AppElementApi.ts:1194

getJsonPaths

getJsonPaths(requestParameters: GetJsonPathsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTGetJsonPathsResponse1544>
Retrieve JSON paths by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetJsonPathsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTGetJsonPathsResponse1544>
- Defined in apis/AppElementApi.ts:1255

getJsonPathsRaw

getJsonPathsRaw(requestParameters: GetJsonPathsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTGetJsonPathsResponse1544>>
Retrieve JSON paths by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetJsonPathsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTGetJsonPathsResponse1544>>
- Defined in apis/AppElementApi.ts:1202

getJsonRaw

getJsonRaw(requestParameters: GetJsonRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTGetJsonResponse2137>>
Retrieve JSON by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetJsonRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTGetJsonResponse2137>>
- Defined in apis/AppElementApi.ts:1140

getSubElementContent

getSubElementContent(requestParameters: GetSubElementContentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementContentInfo>
Retrieve subelement content by document ID, tab ID, and workspace or version or microversion ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: GetSubElementContentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementContentInfo>
- Defined in apis/AppElementApi.ts:1325

getSubElementContentRaw

getSubElementContentRaw(requestParameters: GetSubElementContentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementContentInfo>>
Retrieve subelement content by document ID, tab ID, and workspace or version or microversion ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: GetSubElementContentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementContentInfo>>
- Defined in apis/AppElementApi.ts:1263

getSubelementIds

getSubelementIds(requestParameters: GetSubelementIdsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementIdsInfo>
Retrieve subelement IDs by document ID, workspace or version or microversion ID, and tab ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: GetSubelementIdsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementIdsInfo>
- Defined in apis/AppElementApi.ts:1383

getSubelementIdsRaw

getSubelementIdsRaw(requestParameters: GetSubelementIdsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementIdsInfo>>
Retrieve subelement IDs by document ID, workspace or version or microversion ID, and tab ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: GetSubelementIdsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementIdsInfo>>
- Defined in apis/AppElementApi.ts:1333

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

resolveReference

resolveReference(requestParameters: ResolveReferenceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementReferenceResolveInfo>
Resolve references by document ID, workspace or version or microversion ID, tab ID and resolve ID.
Parameters
- requestParameters: ResolveReferenceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementReferenceResolveInfo>
- Defined in apis/AppElementApi.ts:1453

resolveReferenceRaw

resolveReferenceRaw(requestParameters: ResolveReferenceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementReferenceResolveInfo>>
Resolve references by document ID, workspace or version or microversion ID, tab ID and resolve ID.
Parameters
- requestParameters: ResolveReferenceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementReferenceResolveInfo>>
- Defined in apis/AppElementApi.ts:1391

resolveReferences

resolveReferences(requestParameters: ResolveReferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementReferencesResolveInfo>
Resolve references by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ResolveReferencesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementReferencesResolveInfo>
- Defined in apis/AppElementApi.ts:1523

resolveReferencesRaw

resolveReferencesRaw(requestParameters: ResolveReferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementReferencesResolveInfo>>
Resolve references by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ResolveReferencesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementReferencesResolveInfo>>
- Defined in apis/AppElementApi.ts:1461

startTransaction

startTransaction(requestParameters: StartTransactionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementModifyInfo>
Start application tab transaction by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: StartTransactionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementModifyInfo>
- Defined in apis/AppElementApi.ts:1576

startTransactionRaw

startTransactionRaw(requestParameters: StartTransactionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementModifyInfo>>
Start application tab transaction by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: StartTransactionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementModifyInfo>>
- Defined in apis/AppElementApi.ts:1531

updateAppElement

updateAppElement(requestParameters: UpdateAppElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementModifyInfo>
Update application tab by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: UpdateAppElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementModifyInfo>
- Defined in apis/AppElementApi.ts:1629

updateAppElementRaw

updateAppElementRaw(requestParameters: UpdateAppElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementModifyInfo>>
Update application tab by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: UpdateAppElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementModifyInfo>>
- Defined in apis/AppElementApi.ts:1584

updateReference

updateReference(requestParameters: UpdateReferenceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementReferenceInfo>
Update references by document ID, workspace or version or microversion ID, tab ID, and resolve ID.
Parameters
- requestParameters: UpdateReferenceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementReferenceInfo>
- Defined in apis/AppElementApi.ts:1690

updateReferenceRaw

updateReferenceRaw(requestParameters: UpdateReferenceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementReferenceInfo>>
Update references by document ID, workspace or version or microversion ID, tab ID, and resolve ID.
Parameters
- requestParameters: UpdateReferenceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementReferenceInfo>>
- Defined in apis/AppElementApi.ts:1637

uploadBlobSubelement

uploadBlobSubelement(requestParameters: UploadBlobSubelementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAppElementModifyInfo>
Upload blob subelement file by document ID, workspace ID, tab ID, and blob ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: UploadBlobSubelementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAppElementModifyInfo>
- Defined in apis/AppElementApi.ts:1777

uploadBlobSubelementRaw

uploadBlobSubelementRaw(requestParameters: UploadBlobSubelementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAppElementModifyInfo>>
Upload blob subelement file by document ID, workspace ID, tab ID, and blob ID. A Subelement is used to store and organize data.
Parameters
- requestParameters: UploadBlobSubelementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAppElementModifyInfo>>
- Defined in apis/AppElementApi.ts:1698

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Class AppElementApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns AppElementApi

Properties

Protected configuration

Methods

abortTransaction

Parameters

requestParameters: AbortTransactionRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

abortTransactionRaw

Parameters

requestParameters: AbortTransactionRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

bulkCreateElement

Parameters

requestParameters: BulkCreateElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTAppElementBulkCreateInfo>

bulkCreateElementRaw

Parameters

requestParameters: BulkCreateElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTAppElementBulkCreateInfo>>

commitTransactions

Parameters

requestParameters: CommitTransactionsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTAppElementModifyInfo>

commitTransactionsRaw

Parameters

requestParameters: CommitTransactionsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTAppElementModifyInfo>>

compareAppElementJson

Parameters

requestParameters: CompareAppElementJsonRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDiffJsonResponse2725>

compareAppElementJsonRaw

Parameters

requestParameters: CompareAppElementJsonRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDiffJsonResponse2725>>

createElement

Parameters

requestParameters: CreateElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTAppElementModifyInfo>

createElementRaw

Parameters

requestParameters: CreateElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTAppElementModifyInfo>>

createReference

Parameters

requestParameters: CreateReferenceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTAppElementReferenceInfo>

createReferenceRaw

Parameters

requestParameters: CreateReferenceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTAppElementReferenceInfo>>

deleteAppElementContent

Parameters

requestParameters: DeleteAppElementContentRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTAppElementModifyInfo>

deleteAppElementContentRaw

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction