Class DocumentApi

Hierarchy

BaseAPI
- DocumentApi

Index

Constructors

Properties

Methods

copyWorkspace copyWorkspaceRaw createDocument createDocumentRaw createVersion createVersionRaw createWorkspace createWorkspaceRaw deleteDocument deleteDocumentRaw deleteWorkspace deleteWorkspaceRaw downloadExternalData downloadExternalDataRaw export2Json export2JsonRaw getCurrentMicroversion getCurrentMicroversionRaw getDocument getDocumentAcl getDocumentAclRaw getDocumentHistory getDocumentHistoryRaw getDocumentPermissionSet getDocumentPermissionSetRaw getDocumentRaw getDocumentVersions getDocumentVersionsRaw getDocumentWorkspaces getDocumentWorkspacesRaw getDocuments getDocumentsRaw getElementsInDocument getElementsInDocumentRaw getInsertables getInsertablesRaw getUnitInfo getUnitInfoRaw getVersion getVersionRaw mergeIntoWorkspace mergeIntoWorkspaceRaw mergePreview mergePreviewRaw moveElementsToDocument moveElementsToDocumentRaw request restoreFromHistory restoreFromHistoryRaw revertUnchangedToRevisions revertUnchangedToRevisionsRaw search searchRaw shareDocument shareDocumentRaw shareWithSupport shareWithSupportRaw syncApplicationElements syncApplicationElementsRaw unShareDocument unShareDocumentRaw unshareFromSupport unshareFromSupportRaw updateDocumentAttributes updateDocumentAttributesRaw updateExternalReferencesToLatestDocuments updateExternalReferencesToLatestDocumentsRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

copyWorkspace

copyWorkspace(requestParameters: CopyWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTCopyDocumentInfo>
Copy workspace by document ID and workspace ID.
Parameters
- requestParameters: CopyWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTCopyDocumentInfo>
- Defined in apis/DocumentApi.ts:379

copyWorkspaceRaw

copyWorkspaceRaw(requestParameters: CopyWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTCopyDocumentInfo>>
Copy workspace by document ID and workspace ID.
Parameters
- requestParameters: CopyWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTCopyDocumentInfo>>
- Defined in apis/DocumentApi.ts:338

createDocument

createDocument(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentInfo>
Create and upload a document.
Parameters
- requestParameters: CreateDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentInfo>
- Defined in apis/DocumentApi.ts:420

createDocumentRaw

createDocumentRaw(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentInfo>>
Create and upload a document.
Parameters
- requestParameters: CreateDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentInfo>>
- Defined in apis/DocumentApi.ts:387

createVersion

createVersion(requestParameters: CreateVersionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTVersionInfo>
Create version by document ID.
Parameters
- requestParameters: CreateVersionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTVersionInfo>
- Defined in apis/DocumentApi.ts:465

createVersionRaw

createVersionRaw(requestParameters: CreateVersionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTVersionInfo>>
Create version by document ID.
Parameters
- requestParameters: CreateVersionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTVersionInfo>>
- Defined in apis/DocumentApi.ts:428

createWorkspace

createWorkspace(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTWorkspaceInfo>
Create workspace by document ID.
Parameters
- requestParameters: CreateWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTWorkspaceInfo>
- Defined in apis/DocumentApi.ts:506

createWorkspaceRaw

createWorkspaceRaw(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTWorkspaceInfo>>
Create workspace by document ID.
Parameters
- requestParameters: CreateWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTWorkspaceInfo>>
- Defined in apis/DocumentApi.ts:473

deleteDocument

deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete document by document ID.
Parameters
- requestParameters: DeleteDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:548

deleteDocumentRaw

deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete document by document ID.
Parameters
- requestParameters: DeleteDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:514

deleteWorkspace

deleteWorkspace(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete workspace by document ID and workspace ID.
Parameters
- requestParameters: DeleteWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:590

deleteWorkspaceRaw

deleteWorkspaceRaw(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete workspace by document ID and workspace ID.
Parameters
- requestParameters: DeleteWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:556

downloadExternalData

downloadExternalData(requestParameters: DownloadExternalDataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Blob>
Retrieve external data by document ID and foreign ID.
Parameters
- requestParameters: DownloadExternalDataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Blob>
- Defined in apis/DocumentApi.ts:636

downloadExternalDataRaw

downloadExternalDataRaw(requestParameters: DownloadExternalDataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Blob>>
Retrieve external data by document ID and foreign ID.
Parameters
- requestParameters: DownloadExternalDataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Blob>>
- Defined in apis/DocumentApi.ts:598

export2Json

export2Json(requestParameters: Export2JsonRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Export document by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: Export2JsonRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:693

export2JsonRaw

export2JsonRaw(requestParameters: Export2JsonRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Export document by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: Export2JsonRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:644

getCurrentMicroversion

getCurrentMicroversion(requestParameters: GetCurrentMicroversionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMicroversionInfo>
Retrieve current microversion by document ID and workspace or version ID.
Parameters
- requestParameters: GetCurrentMicroversionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMicroversionInfo>
- Defined in apis/DocumentApi.ts:739

getCurrentMicroversionRaw

getCurrentMicroversionRaw(requestParameters: GetCurrentMicroversionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMicroversionInfo>>
Retrieve current microversion by document ID and workspace or version ID.
Parameters
- requestParameters: GetCurrentMicroversionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMicroversionInfo>>
- Defined in apis/DocumentApi.ts:701

getDocument

getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentInfo>
Retrieve document by document ID.
Parameters
- requestParameters: GetDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentInfo>
- Defined in apis/DocumentApi.ts:777

getDocumentAcl

getDocumentAcl(requestParameters: GetDocumentAclRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAclInfo>
Retrieve access control list by document ID.
Parameters
- requestParameters: GetDocumentAclRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAclInfo>
- Defined in apis/DocumentApi.ts:815

getDocumentAclRaw

getDocumentAclRaw(requestParameters: GetDocumentAclRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAclInfo>>
Retrieve access control list by document ID.
Parameters
- requestParameters: GetDocumentAclRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAclInfo>>
- Defined in apis/DocumentApi.ts:785

getDocumentHistory

getDocumentHistory(requestParameters: GetDocumentHistoryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentHistoryInfo[]>
Retrieve document history by document ID and workspace or microversion ID.
Parameters
- requestParameters: GetDocumentHistoryRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentHistoryInfo[]>
- Defined in apis/DocumentApi.ts:861

getDocumentHistoryRaw

getDocumentHistoryRaw(requestParameters: GetDocumentHistoryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentHistoryInfo[]>>
Retrieve document history by document ID and workspace or microversion ID.
Parameters
- requestParameters: GetDocumentHistoryRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentHistoryInfo[]>>
- Defined in apis/DocumentApi.ts:823

getDocumentPermissionSet

getDocumentPermissionSet(requestParameters: GetDocumentPermissionSetRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<string[]>
Retrieve Document permissions by document ID.
Parameters
- requestParameters: GetDocumentPermissionSetRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<string[]>
- Defined in apis/DocumentApi.ts:899

getDocumentPermissionSetRaw

getDocumentPermissionSetRaw(requestParameters: GetDocumentPermissionSetRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<string[]>>
Retrieve Document permissions by document ID.
Parameters
- requestParameters: GetDocumentPermissionSetRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<string[]>>
- Defined in apis/DocumentApi.ts:869

getDocumentRaw

getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentInfo>>
Retrieve document by document ID.
Parameters
- requestParameters: GetDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentInfo>>
- Defined in apis/DocumentApi.ts:747

getDocumentVersions

getDocumentVersions(requestParameters: GetDocumentVersionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTVersionInfo[]>
Retrieve versions by document ID.
Parameters
- requestParameters: GetDocumentVersionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTVersionInfo[]>
- Defined in apis/DocumentApi.ts:945

getDocumentVersionsRaw

getDocumentVersionsRaw(requestParameters: GetDocumentVersionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTVersionInfo[]>>
Retrieve versions by document ID.
Parameters
- requestParameters: GetDocumentVersionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTVersionInfo[]>>
- Defined in apis/DocumentApi.ts:907

getDocumentWorkspaces

getDocumentWorkspaces(requestParameters: GetDocumentWorkspacesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTWorkspaceInfo[]>
Retrieve workspaces by document ID.
Parameters
- requestParameters: GetDocumentWorkspacesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTWorkspaceInfo[]>
- Defined in apis/DocumentApi.ts:983

getDocumentWorkspacesRaw

getDocumentWorkspacesRaw(requestParameters: GetDocumentWorkspacesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTWorkspaceInfo[]>>
Retrieve workspaces by document ID.
Parameters
- requestParameters: GetDocumentWorkspacesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTWorkspaceInfo[]>>
- Defined in apis/DocumentApi.ts:953

getDocuments

getDocuments(requestParameters?: GetDocumentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTGlobalTreeNodeListResponse>
Retrieve a document.
Parameters
- requestParameters: GetDocumentsRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTGlobalTreeNodeListResponse>
- Defined in apis/DocumentApi.ts:1061

getDocumentsRaw

getDocumentsRaw(requestParameters: GetDocumentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTGlobalTreeNodeListResponse>>
Retrieve a document.
Parameters
- requestParameters: GetDocumentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTGlobalTreeNodeListResponse>>
- Defined in apis/DocumentApi.ts:991

getElementsInDocument

getElementsInDocument(requestParameters: GetElementsInDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentElementInfo[]>
Retrieve tabs by document ID and workspace or version or microversion ID.
Parameters
- requestParameters: GetElementsInDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentElementInfo[]>
- Defined in apis/DocumentApi.ts:1123

getElementsInDocumentRaw

getElementsInDocumentRaw(requestParameters: GetElementsInDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentElementInfo[]>>
Retrieve tabs by document ID and workspace or version or microversion ID.
Parameters
- requestParameters: GetElementsInDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentElementInfo[]>>
- Defined in apis/DocumentApi.ts:1069

getInsertables

getInsertables(requestParameters: GetInsertablesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTInsertablesListResponse>
Retrieve insertables by document ID and workspace or version ID.
Parameters
- requestParameters: GetInsertablesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTInsertablesListResponse>
- Defined in apis/DocumentApi.ts:1273

getInsertablesRaw

getInsertablesRaw(requestParameters: GetInsertablesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTInsertablesListResponse>>
Retrieve insertables by document ID and workspace or version ID.
Parameters
- requestParameters: GetInsertablesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTInsertablesListResponse>>
- Defined in apis/DocumentApi.ts:1131

getUnitInfo

getUnitInfo(requestParameters: GetUnitInfoRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTUnitInfo>
Get the selected units and precision by document ID and workspace or version or microversion ID.
Parameters
- requestParameters: GetUnitInfoRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTUnitInfo>
- Defined in apis/DocumentApi.ts:1318

getUnitInfoRaw

getUnitInfoRaw(requestParameters: GetUnitInfoRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTUnitInfo>>
Get the selected units and precision by document ID and workspace or version or microversion ID.
Parameters
- requestParameters: GetUnitInfoRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTUnitInfo>>
- Defined in apis/DocumentApi.ts:1281

getVersion

getVersion(requestParameters: GetVersionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTVersionInfo>
Retrieve version by document ID and version ID.
Parameters
- requestParameters: GetVersionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTVersionInfo>
- Defined in apis/DocumentApi.ts:1368

getVersionRaw

getVersionRaw(requestParameters: GetVersionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTVersionInfo>>
Retrieve version by document ID and version ID.
Parameters
- requestParameters: GetVersionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTVersionInfo>>
- Defined in apis/DocumentApi.ts:1326

mergeIntoWorkspace

mergeIntoWorkspace(requestParameters: MergeIntoWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentMergeInfo>
Merge into workspace by document ID and workspace ID.
Parameters
- requestParameters: MergeIntoWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentMergeInfo>
- Defined in apis/DocumentApi.ts:1417

mergeIntoWorkspaceRaw

mergeIntoWorkspaceRaw(requestParameters: MergeIntoWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentMergeInfo>>
Merge into workspace by document ID and workspace ID.
Parameters
- requestParameters: MergeIntoWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentMergeInfo>>
- Defined in apis/DocumentApi.ts:1376

mergePreview

mergePreview(requestParameters: MergePreviewRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMergePreviewInfo>
Merge preview of changes that will occur based on document ID, workspace ID and source workspace/version ID
Parameters
- requestParameters: MergePreviewRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMergePreviewInfo>
- Defined in apis/DocumentApi.ts:1479

mergePreviewRaw

mergePreviewRaw(requestParameters: MergePreviewRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMergePreviewInfo>>
Merge preview of changes that will occur based on document ID, workspace ID and source workspace/version ID
Parameters
- requestParameters: MergePreviewRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMergePreviewInfo>>
- Defined in apis/DocumentApi.ts:1425

moveElementsToDocument

moveElementsToDocument(requestParameters: MoveElementsToDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMoveElementInfo>
Move tab by document ID and workspace ID.
Parameters
- requestParameters: MoveElementsToDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMoveElementInfo>
- Defined in apis/DocumentApi.ts:1528

moveElementsToDocumentRaw

moveElementsToDocumentRaw(requestParameters: MoveElementsToDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMoveElementInfo>>
Move tab by document ID and workspace ID.
Parameters
- requestParameters: MoveElementsToDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMoveElementInfo>>
- Defined in apis/DocumentApi.ts:1487

`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

restoreFromHistory

restoreFromHistory(requestParameters: RestoreFromHistoryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTRestoreFromHistoryInfo>
Restore version or microversion to workspace by document ID, workspace ID, and version or microversion ID.
Parameters
- requestParameters: RestoreFromHistoryRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTRestoreFromHistoryInfo>
- Defined in apis/DocumentApi.ts:1582

restoreFromHistoryRaw

restoreFromHistoryRaw(requestParameters: RestoreFromHistoryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTRestoreFromHistoryInfo>>
Restore version or microversion to workspace by document ID, workspace ID, and version or microversion ID.
Parameters
- requestParameters: RestoreFromHistoryRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTRestoreFromHistoryInfo>>
- Defined in apis/DocumentApi.ts:1536

revertUnchangedToRevisions

revertUnchangedToRevisions(requestParameters: RevertUnchangedToRevisionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTUnchangedElementInfo[]>
Parameters
- requestParameters: RevertUnchangedToRevisionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTUnchangedElementInfo[]>
- Defined in apis/DocumentApi.ts:1625

revertUnchangedToRevisionsRaw

revertUnchangedToRevisionsRaw(requestParameters: RevertUnchangedToRevisionsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTUnchangedElementInfo[]>>
Parameters
- requestParameters: RevertUnchangedToRevisionsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTUnchangedElementInfo[]>>
- Defined in apis/DocumentApi.ts:1589

search

search(requestParameters: SearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
This returns list of documents based on search parameters. Search document.
Parameters
- requestParameters: SearchRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:1668

searchRaw

searchRaw(requestParameters: SearchRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
This returns list of documents based on search parameters. Search document.
Parameters
- requestParameters: SearchRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:1634

shareDocument

shareDocument(requestParameters: ShareDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAclInfo>
Share document by document ID.
Parameters
- requestParameters: ShareDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAclInfo>
- Defined in apis/DocumentApi.ts:1713

shareDocumentRaw

shareDocumentRaw(requestParameters: ShareDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAclInfo>>
Share document by document ID.
Parameters
- requestParameters: ShareDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAclInfo>>
- Defined in apis/DocumentApi.ts:1676

shareWithSupport

shareWithSupport(requestParameters: ShareWithSupportRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Share document by document ID with Onshape support.
Parameters
- requestParameters: ShareWithSupportRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:1746

shareWithSupportRaw

shareWithSupportRaw(requestParameters: ShareWithSupportRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Share document by document ID with Onshape support.
Parameters
- requestParameters: ShareWithSupportRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:1721

syncApplicationElements

syncApplicationElements(requestParameters: SyncApplicationElementsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Parameters
- requestParameters: SyncApplicationElementsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:1793

syncApplicationElementsRaw

syncApplicationElementsRaw(requestParameters: SyncApplicationElementsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Parameters
- requestParameters: SyncApplicationElementsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:1753

unShareDocument

unShareDocument(requestParameters: UnShareDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Unshare document by document ID and tab ID.
Parameters
- requestParameters: UnShareDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:1839

unShareDocumentRaw

unShareDocumentRaw(requestParameters: UnShareDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Unshare document by document ID and tab ID.
Parameters
- requestParameters: UnShareDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:1801

unshareFromSupport

unshareFromSupport(requestParameters: UnshareFromSupportRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Unshare document with support.
Parameters
- requestParameters: UnshareFromSupportRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:1872

unshareFromSupportRaw

unshareFromSupportRaw(requestParameters: UnshareFromSupportRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Unshare document with support.
Parameters
- requestParameters: UnshareFromSupportRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:1847

updateDocumentAttributes

updateDocumentAttributes(requestParameters: UpdateDocumentAttributesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update document attributes by document ID.
Parameters
- requestParameters: UpdateDocumentAttributesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/DocumentApi.ts:1917

updateDocumentAttributesRaw

updateDocumentAttributesRaw(requestParameters: UpdateDocumentAttributesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update document attributes by document ID.
Parameters
- requestParameters: UpdateDocumentAttributesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/DocumentApi.ts:1880

updateExternalReferencesToLatestDocuments

updateExternalReferencesToLatestDocuments(requestParameters: UpdateExternalReferencesToLatestDocumentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTLinkToLatestDocumentInfo>
Update external references to latest by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateExternalReferencesToLatestDocumentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTLinkToLatestDocumentInfo>
- Defined in apis/DocumentApi.ts:1966

updateExternalReferencesToLatestDocumentsRaw

updateExternalReferencesToLatestDocumentsRaw(requestParameters: UpdateExternalReferencesToLatestDocumentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTLinkToLatestDocumentInfo>>
Update external references to latest by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateExternalReferencesToLatestDocumentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTLinkToLatestDocumentInfo>>
- Defined in apis/DocumentApi.ts:1925

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 DocumentApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns DocumentApi

Properties

Protected configuration

Methods

copyWorkspace

Parameters

requestParameters: CopyWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTCopyDocumentInfo>

copyWorkspaceRaw

Parameters

requestParameters: CopyWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTCopyDocumentInfo>>

createDocument

Parameters

requestParameters: CreateDocumentRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentInfo>

createDocumentRaw

Parameters

requestParameters: CreateDocumentRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentInfo>>

createVersion

Parameters

requestParameters: CreateVersionRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTVersionInfo>

createVersionRaw

Parameters

requestParameters: CreateVersionRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTVersionInfo>>

createWorkspace

Parameters

requestParameters: CreateWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTWorkspaceInfo>

createWorkspaceRaw

Parameters

requestParameters: CreateWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTWorkspaceInfo>>

deleteDocument

Parameters

requestParameters: DeleteDocumentRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

deleteDocumentRaw

Parameters

requestParameters: DeleteDocumentRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

deleteWorkspace

Parameters

requestParameters: DeleteWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

deleteWorkspaceRaw

Parameters

requestParameters: DeleteWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

downloadExternalData

Parameters

requestParameters: DownloadExternalDataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Blob>

downloadExternalDataRaw

`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