Class PartStudioApi

Hierarchy

BaseAPI
- PartStudioApi

Index

Constructors

Properties

Methods

addPartStudioFeature addPartStudioFeatureRaw comparePartStudios comparePartStudiosRaw createPartStudio createPartStudioRaw createPartStudioTranslation createPartStudioTranslationRaw deletePartStudioFeature deletePartStudioFeatureRaw evalFeatureScript evalFeatureScriptRaw exportParasolid exportParasolidRaw exportPartStudioGltf exportPartStudioGltfRaw exportPartStudioStl exportPartStudioStlRaw getFeatureScriptRepresentation getFeatureScriptRepresentationRaw getFeatureScriptTable getFeatureScriptTableRaw getPartStudioBodyDetails getPartStudioBodyDetailsRaw getPartStudioBoundingBoxes getPartStudioBoundingBoxesRaw getPartStudioEdges getPartStudioEdgesRaw getPartStudioFaces getPartStudioFacesRaw getPartStudioFeatureSpecs getPartStudioFeatureSpecsRaw getPartStudioFeatures getPartStudioFeaturesRaw getPartStudioMassProperties getPartStudioMassPropertiesRaw getPartStudioNamedViews getPartStudioNamedViewsRaw getPartStudioShadedViews getPartStudioShadedViewsRaw request translateIds translateIdsRaw updateFeatures updateFeaturesRaw updatePartStudioFeature updatePartStudioFeatureRaw updateRollback updateRollbackRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

addPartStudioFeature

addPartStudioFeature(requestParameters: AddPartStudioFeatureRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureDefinitionResponse1617>
Add feature to the feature list for a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: AddPartStudioFeatureRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureDefinitionResponse1617>
- Defined in apis/PartStudioApi.ts:437

addPartStudioFeatureRaw

addPartStudioFeatureRaw(requestParameters: AddPartStudioFeatureRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureDefinitionResponse1617>>
Add feature to the feature list for a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: AddPartStudioFeatureRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureDefinitionResponse1617>>
- Defined in apis/PartStudioApi.ts:392

comparePartStudios

comparePartStudios(requestParameters: ComparePartStudiosRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTRootDiffInfo>
Compare Part Studios by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ComparePartStudiosRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTRootDiffInfo>
- Defined in apis/PartStudioApi.ts:511

comparePartStudiosRaw

comparePartStudiosRaw(requestParameters: ComparePartStudiosRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTRootDiffInfo>>
Compare Part Studios by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ComparePartStudiosRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTRootDiffInfo>>
- Defined in apis/PartStudioApi.ts:445

createPartStudio

createPartStudio(requestParameters: CreatePartStudioRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentElementInfo>
Create Part Studio by document ID and workspace ID.
Parameters
- requestParameters: CreatePartStudioRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentElementInfo>
- Defined in apis/PartStudioApi.ts:560

createPartStudioRaw

createPartStudioRaw(requestParameters: CreatePartStudioRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentElementInfo>>
Create Part Studio by document ID and workspace ID.
Parameters
- requestParameters: CreatePartStudioRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentElementInfo>>
- Defined in apis/PartStudioApi.ts:519

createPartStudioTranslation

createPartStudioTranslation(requestParameters: CreatePartStudioTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTTranslationRequestInfo>
Create Part Studio translation by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: CreatePartStudioTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTTranslationRequestInfo>
- Defined in apis/PartStudioApi.ts:617

createPartStudioTranslationRaw

createPartStudioTranslationRaw(requestParameters: CreatePartStudioTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTTranslationRequestInfo>>
Create Part Studio translation by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: CreatePartStudioTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTTranslationRequestInfo>>
- Defined in apis/PartStudioApi.ts:568

deletePartStudioFeature

deletePartStudioFeature(requestParameters: DeletePartStudioFeatureRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureApiBase1430>
Delete feature by document ID, workspace ID, tab ID, and feature ID.
Parameters
- requestParameters: DeletePartStudioFeatureRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureApiBase1430>
- Defined in apis/PartStudioApi.ts:667

deletePartStudioFeatureRaw

deletePartStudioFeatureRaw(requestParameters: DeletePartStudioFeatureRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureApiBase1430>>
Delete feature by document ID, workspace ID, tab ID, and feature ID.
Parameters
- requestParameters: DeletePartStudioFeatureRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureApiBase1430>>
- Defined in apis/PartStudioApi.ts:625

evalFeatureScript

evalFeatureScript(requestParameters: EvalFeatureScriptRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureScriptEvalResponse1859>
Evaluate FeatureScript for a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: EvalFeatureScriptRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureScriptEvalResponse1859>
- Defined in apis/PartStudioApi.ts:736

evalFeatureScriptRaw

evalFeatureScriptRaw(requestParameters: EvalFeatureScriptRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureScriptEvalResponse1859>>
Evaluate FeatureScript for a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: EvalFeatureScriptRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureScriptEvalResponse1859>>
- Defined in apis/PartStudioApi.ts:675

exportParasolid

exportParasolid(requestParameters: ExportParasolidRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>
Export Part Studio to Parasolid by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ExportParasolidRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in apis/PartStudioApi.ts:810

exportParasolidRaw

exportParasolidRaw(requestParameters: ExportParasolidRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>
Export Part Studio to Parasolid by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ExportParasolidRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in apis/PartStudioApi.ts:744

exportPartStudioGltf

exportPartStudioGltf(requestParameters: ExportPartStudioGltfRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Blob>
Export GLTF representation for parts in a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ExportPartStudioGltfRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Blob>
- Defined in apis/PartStudioApi.ts:907

exportPartStudioGltfRaw

exportPartStudioGltfRaw(requestParameters: ExportPartStudioGltfRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Blob>>
Export GLTF representation for parts in a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ExportPartStudioGltfRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Blob>>
- Defined in apis/PartStudioApi.ts:817

exportPartStudioStl

exportPartStudioStl(requestParameters: ExportPartStudioStlRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>
Export Part Studio to STL by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ExportPartStudioStlRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in apis/PartStudioApi.ts:1001

exportPartStudioStlRaw

exportPartStudioStlRaw(requestParameters: ExportPartStudioStlRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>
Export Part Studio to STL by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: ExportPartStudioStlRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in apis/PartStudioApi.ts:915

getFeatureScriptRepresentation

getFeatureScriptRepresentation(requestParameters: GetFeatureScriptRepresentationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTPModule234>
Retrieve FeatureScript representation of the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetFeatureScriptRepresentationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTPModule234>
- Defined in apis/PartStudioApi.ts:1066

getFeatureScriptRepresentationRaw

getFeatureScriptRepresentationRaw(requestParameters: GetFeatureScriptRepresentationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTPModule234>>
Retrieve FeatureScript representation of the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetFeatureScriptRepresentationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTPModule234>>
- Defined in apis/PartStudioApi.ts:1008

getFeatureScriptTable

getFeatureScriptTable(requestParameters: GetFeatureScriptTableRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTApiTableList1223>
Retrieve FeatureScript table of the Part Studio or part by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetFeatureScriptTableRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTApiTableList1223>
- Defined in apis/PartStudioApi.ts:1144

getFeatureScriptTableRaw

getFeatureScriptTableRaw(requestParameters: GetFeatureScriptTableRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTApiTableList1223>>
Retrieve FeatureScript table of the Part Studio or part by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetFeatureScriptTableRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTApiTableList1223>>
- Defined in apis/PartStudioApi.ts:1074

getPartStudioBodyDetails

getPartStudioBodyDetails(requestParameters: GetPartStudioBodyDetailsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTExportModelBodiesResponse734>
Retrieve an array of body details by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioBodyDetailsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTExportModelBodiesResponse734>
- Defined in apis/PartStudioApi.ts:1222

getPartStudioBodyDetailsRaw

getPartStudioBodyDetailsRaw(requestParameters: GetPartStudioBodyDetailsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTExportModelBodiesResponse734>>
Retrieve an array of body details by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioBodyDetailsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTExportModelBodiesResponse734>>
- Defined in apis/PartStudioApi.ts:1152

getPartStudioBoundingBoxes

getPartStudioBoundingBoxes(requestParameters: GetPartStudioBoundingBoxesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTBoundingBoxInfo>
Retrieve an array of Mass properties of parts or a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioBoundingBoxesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTBoundingBoxInfo>
- Defined in apis/PartStudioApi.ts:1288

getPartStudioBoundingBoxesRaw

getPartStudioBoundingBoxesRaw(requestParameters: GetPartStudioBoundingBoxesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTBoundingBoxInfo>>
Retrieve an array of Mass properties of parts or a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioBoundingBoxesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTBoundingBoxInfo>>
- Defined in apis/PartStudioApi.ts:1230

getPartStudioEdges

getPartStudioEdges(requestParameters: GetPartStudioEdgesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTExportTessellatedEdgesResponse327>
Retrieve tessellated edges of the parts in the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioEdgesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTExportTessellatedEdgesResponse327>
- Defined in apis/PartStudioApi.ts:1374

getPartStudioEdgesRaw

getPartStudioEdgesRaw(requestParameters: GetPartStudioEdgesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTExportTessellatedEdgesResponse327>>
Retrieve tessellated edges of the parts in the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioEdgesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTExportTessellatedEdgesResponse327>>
- Defined in apis/PartStudioApi.ts:1296

getPartStudioFaces

getPartStudioFaces(requestParameters: GetPartStudioFacesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTExportTessellatedFacesResponse898>
Parameters
- requestParameters: GetPartStudioFacesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTExportTessellatedFacesResponse898>
- Defined in apis/PartStudioApi.ts:1490

getPartStudioFacesRaw

getPartStudioFacesRaw(requestParameters: GetPartStudioFacesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTExportTessellatedFacesResponse898>>
Parameters
- requestParameters: GetPartStudioFacesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTExportTessellatedFacesResponse898>>
- Defined in apis/PartStudioApi.ts:1381

getPartStudioFeatureSpecs

getPartStudioFeatureSpecs(requestParameters: GetPartStudioFeatureSpecsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureSpecsResponse664>
Retrieve feature specifications of the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioFeatureSpecsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureSpecsResponse664>
- Defined in apis/PartStudioApi.ts:1540

getPartStudioFeatureSpecsRaw

getPartStudioFeatureSpecsRaw(requestParameters: GetPartStudioFeatureSpecsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureSpecsResponse664>>
Retrieve feature specifications of the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioFeatureSpecsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureSpecsResponse664>>
- Defined in apis/PartStudioApi.ts:1498

getPartStudioFeatures

getPartStudioFeatures(requestParameters: GetPartStudioFeaturesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureListResponse2457>
Retrieve a feature list of parts or a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioFeaturesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureListResponse2457>
- Defined in apis/PartStudioApi.ts:1618

getPartStudioFeaturesRaw

getPartStudioFeaturesRaw(requestParameters: GetPartStudioFeaturesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureListResponse2457>>
Retrieve a feature list of parts or a Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioFeaturesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureListResponse2457>>
- Defined in apis/PartStudioApi.ts:1548

getPartStudioMassProperties

getPartStudioMassProperties(requestParameters: GetPartStudioMassPropertiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMassPropertiesBulkInfo>
Retrieve mass properties of the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioMassPropertiesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMassPropertiesBulkInfo>
- Defined in apis/PartStudioApi.ts:1696

getPartStudioMassPropertiesRaw

getPartStudioMassPropertiesRaw(requestParameters: GetPartStudioMassPropertiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMassPropertiesBulkInfo>>
Retrieve mass properties of the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioMassPropertiesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMassPropertiesBulkInfo>>
- Defined in apis/PartStudioApi.ts:1626

getPartStudioNamedViews

getPartStudioNamedViews(requestParameters: GetPartStudioNamedViewsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTNamedViewsInfo>
Parameters
- requestParameters: GetPartStudioNamedViewsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTNamedViewsInfo>
- Defined in apis/PartStudioApi.ts:1748

getPartStudioNamedViewsRaw

getPartStudioNamedViewsRaw(requestParameters: GetPartStudioNamedViewsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTNamedViewsInfo>>
Parameters
- requestParameters: GetPartStudioNamedViewsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTNamedViewsInfo>>
- Defined in apis/PartStudioApi.ts:1703

getPartStudioShadedViews

getPartStudioShadedViews(requestParameters: GetPartStudioShadedViewsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTShadedViewsInfo>
Retrieve shaded views of the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioShadedViewsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTShadedViewsInfo>
- Defined in apis/PartStudioApi.ts:1842

getPartStudioShadedViewsRaw

getPartStudioShadedViewsRaw(requestParameters: GetPartStudioShadedViewsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTShadedViewsInfo>>
Retrieve shaded views of the Part Studio by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetPartStudioShadedViewsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTShadedViewsInfo>>
- Defined in apis/PartStudioApi.ts:1756

`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

translateIds

translateIds(requestParameters: TranslateIdsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTIdTranslationInfo>
Create Part Studio ID translation by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: TranslateIdsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTIdTranslationInfo>
- Defined in apis/PartStudioApi.ts:1899

translateIdsRaw

translateIdsRaw(requestParameters: TranslateIdsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTIdTranslationInfo>>
Create Part Studio ID translation by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: TranslateIdsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTIdTranslationInfo>>
- Defined in apis/PartStudioApi.ts:1850

updateFeatures

updateFeatures(requestParameters: UpdateFeaturesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTUpdateFeaturesResponse1333>
Update features by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateFeaturesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTUpdateFeaturesResponse1333>
- Defined in apis/PartStudioApi.ts:1948

updateFeaturesRaw

updateFeaturesRaw(requestParameters: UpdateFeaturesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTUpdateFeaturesResponse1333>>
Update features by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateFeaturesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTUpdateFeaturesResponse1333>>
- Defined in apis/PartStudioApi.ts:1907

updatePartStudioFeature

updatePartStudioFeature(requestParameters: UpdatePartStudioFeatureRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTFeatureDefinitionResponse1617>
Update feature by document ID, workspace ID, tab ID, and feature ID.
Parameters
- requestParameters: UpdatePartStudioFeatureRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTFeatureDefinitionResponse1617>
- Defined in apis/PartStudioApi.ts:2001

updatePartStudioFeatureRaw

updatePartStudioFeatureRaw(requestParameters: UpdatePartStudioFeatureRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTFeatureDefinitionResponse1617>>
Update feature by document ID, workspace ID, tab ID, and feature ID.
Parameters
- requestParameters: UpdatePartStudioFeatureRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTFeatureDefinitionResponse1617>>
- Defined in apis/PartStudioApi.ts:1956

updateRollback

updateRollback(requestParameters: UpdateRollbackRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTSetFeatureRollbackResponse1042>
Update feature rollback by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateRollbackRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTSetFeatureRollbackResponse1042>
- Defined in apis/PartStudioApi.ts:2054

updateRollbackRaw

updateRollbackRaw(requestParameters: UpdateRollbackRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTSetFeatureRollbackResponse1042>>
Update feature rollback by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateRollbackRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTSetFeatureRollbackResponse1042>>
- Defined in apis/PartStudioApi.ts:2009

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 PartStudioApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns PartStudioApi

Properties

Protected configuration

Methods

addPartStudioFeature

Parameters

requestParameters: AddPartStudioFeatureRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTFeatureDefinitionResponse1617>

addPartStudioFeatureRaw

Parameters

requestParameters: AddPartStudioFeatureRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTFeatureDefinitionResponse1617>>

comparePartStudios

Parameters

requestParameters: ComparePartStudiosRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTRootDiffInfo>

comparePartStudiosRaw

Parameters

requestParameters: ComparePartStudiosRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTRootDiffInfo>>

createPartStudio

Parameters

requestParameters: CreatePartStudioRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentElementInfo>

createPartStudioRaw

Parameters

requestParameters: CreatePartStudioRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentElementInfo>>

createPartStudioTranslation

Parameters

requestParameters: CreatePartStudioTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTTranslationRequestInfo>

createPartStudioTranslationRaw

Parameters

requestParameters: CreatePartStudioTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTTranslationRequestInfo>>

deletePartStudioFeature

Parameters

requestParameters: DeletePartStudioFeatureRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTFeatureApiBase1430>

deletePartStudioFeatureRaw

Parameters

requestParameters: DeletePartStudioFeatureRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTFeatureApiBase1430>>

evalFeatureScript

Parameters

requestParameters: EvalFeatureScriptRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTFeatureScriptEvalResponse1859>

evalFeatureScriptRaw

Parameters

requestParameters: EvalFeatureScriptRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTFeatureScriptEvalResponse1859>>

exportParasolid

Parameters

requestParameters: ExportParasolidRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<void>

exportParasolidRaw

`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