Class ElementApi

Hierarchy

BaseAPI
- ElementApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

copyElementFromSourceDocument

copyElementFromSourceDocument(requestParameters: CopyElementFromSourceDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentElementInfo>
Copy tab by document ID and workspace ID.
Parameters
- requestParameters: CopyElementFromSourceDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentElementInfo>
- Defined in apis/ElementApi.ts:161

copyElementFromSourceDocumentRaw

copyElementFromSourceDocumentRaw(requestParameters: CopyElementFromSourceDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentElementInfo>>
Copy tab by document ID and workspace ID.
Parameters
- requestParameters: CopyElementFromSourceDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentElementInfo>>
- Defined in apis/ElementApi.ts:120

decodeConfiguration

decodeConfiguration(requestParameters: DecodeConfigurationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTConfigurationInfo>
Decode configuration string by documentation ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: DecodeConfigurationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTConfigurationInfo>
- Defined in apis/ElementApi.ts:227

decodeConfigurationRaw

decodeConfigurationRaw(requestParameters: DecodeConfigurationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTConfigurationInfo>>
Decode configuration string by documentation ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: DecodeConfigurationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTConfigurationInfo>>
- Defined in apis/ElementApi.ts:169

deleteElement

deleteElement(requestParameters: DeleteElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Parameters
- requestParameters: DeleteElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ElementApi.ts:271

deleteElementRaw

deleteElementRaw(requestParameters: DeleteElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Parameters
- requestParameters: DeleteElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ElementApi.ts:234

encodeConfigurationMap

encodeConfigurationMap(requestParameters: EncodeConfigurationMapRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTEncodedConfigurationInfo>
Encode configuration by documentation ID and tab ID.
Parameters
- requestParameters: EncodeConfigurationMapRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTEncodedConfigurationInfo>
- Defined in apis/ElementApi.ts:328

encodeConfigurationMapRaw

encodeConfigurationMapRaw(requestParameters: EncodeConfigurationMapRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTEncodedConfigurationInfo>>
Encode configuration by documentation ID and tab ID.
Parameters
- requestParameters: EncodeConfigurationMapRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTEncodedConfigurationInfo>>
- Defined in apis/ElementApi.ts:279

getConfiguration

getConfiguration(requestParameters: GetConfigurationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTConfigurationResponse2019>
Retrieve configuration by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetConfigurationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTConfigurationResponse2019>
- Defined in apis/ElementApi.ts:378

getConfigurationRaw

getConfigurationRaw(requestParameters: GetConfigurationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTConfigurationResponse2019>>
Retrieve configuration by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetConfigurationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTConfigurationResponse2019>>
- Defined in apis/ElementApi.ts:336

getElementTranslatorFormatsByVersionOrWorkspace

getElementTranslatorFormatsByVersionOrWorkspace(requestParameters: GetElementTranslatorFormatsByVersionOrWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTModelFormatInfo[]>
Parameters
- requestParameters: GetElementTranslatorFormatsByVersionOrWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTModelFormatInfo[]>
- Defined in apis/ElementApi.ts:433

getElementTranslatorFormatsByVersionOrWorkspaceRaw

getElementTranslatorFormatsByVersionOrWorkspaceRaw(requestParameters: GetElementTranslatorFormatsByVersionOrWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTModelFormatInfo[]>>
Parameters
- requestParameters: GetElementTranslatorFormatsByVersionOrWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTModelFormatInfo[]>>
- Defined in apis/ElementApi.ts:385

`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

updateConfiguration

updateConfiguration(requestParameters: UpdateConfigurationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTConfigurationResponse2019>
Update configuration by document ID, workspace or microversion ID, and tab ID.
Parameters
- requestParameters: UpdateConfigurationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTConfigurationResponse2019>
- Defined in apis/ElementApi.ts:486

updateConfigurationRaw

updateConfigurationRaw(requestParameters: UpdateConfigurationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTConfigurationResponse2019>>
Update configuration by document ID, workspace or microversion ID, and tab ID.
Parameters
- requestParameters: UpdateConfigurationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTConfigurationResponse2019>>
- Defined in apis/ElementApi.ts:441

updateReferences

updateReferences(requestParameters: UpdateReferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update or replace node references by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateReferencesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ElementApi.ts:539

updateReferencesRaw

updateReferencesRaw(requestParameters: UpdateReferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update or replace node references by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateReferencesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ElementApi.ts:494

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 ElementApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns ElementApi

Properties

Protected configuration

Methods

copyElementFromSourceDocument

Parameters

requestParameters: CopyElementFromSourceDocumentRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentElementInfo>

copyElementFromSourceDocumentRaw

Parameters

requestParameters: CopyElementFromSourceDocumentRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentElementInfo>>

decodeConfiguration

Parameters

requestParameters: DecodeConfigurationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTConfigurationInfo>

decodeConfigurationRaw

Parameters

requestParameters: DecodeConfigurationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTConfigurationInfo>>

deleteElement

Parameters

requestParameters: DeleteElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

deleteElementRaw

Parameters

requestParameters: DeleteElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

encodeConfigurationMap

Parameters

requestParameters: EncodeConfigurationMapRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTEncodedConfigurationInfo>

encodeConfigurationMapRaw

Parameters

requestParameters: EncodeConfigurationMapRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTEncodedConfigurationInfo>>

getConfiguration

Parameters

requestParameters: GetConfigurationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTConfigurationResponse2019>

getConfigurationRaw

Parameters

requestParameters: GetConfigurationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTConfigurationResponse2019>>

getElementTranslatorFormatsByVersionOrWorkspace

Parameters

requestParameters: GetElementTranslatorFormatsByVersionOrWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTModelFormatInfo[]>

getElementTranslatorFormatsByVersionOrWorkspaceRaw

Parameters

requestParameters: GetElementTranslatorFormatsByVersionOrWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTModelFormatInfo[]>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

updateConfiguration

`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

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]