Class Checks

API Namespace Checks is used for Model Check related API calls.

Index

Constructors

Methods

downloadCheckGltf downloadCheckResultsAsBcf getModelCheckDefinitionByName getModelCheckDefinitionByUuid getModelCheckDefinitionSetByName getModelCheckDefinitionSetByUuid getModelReportByModelCheckSetUuid listChecks listModelCheckDefinitionSets listModelCheckDefinitions runChecks runChecksAsTask runIdsCheck

Constructors

constructor

new Checks(): Checks
Returns Checks

Methods

downloadCheckGltf

downloadCheckGltf(resourceUuid): Promise<unknown>
Parameters
- resourceUuid: string
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:155

downloadCheckResultsAsBcf

downloadCheckResultsAsBcf(modelCheckSetUuids): Promise<unknown>
Parameters
- modelCheckSetUuids: Iterable<string>
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:154

getModelCheckDefinitionByName

getModelCheckDefinitionByName(setUuid, name): Promise<unknown>
Parameters
- setUuid: string
- name: string
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:152

getModelCheckDefinitionByUuid

getModelCheckDefinitionByUuid(uuid): Promise<unknown>
Parameters
- uuid: string
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:151

getModelCheckDefinitionSetByName

getModelCheckDefinitionSetByName(name): Promise<unknown>
Parameters
- name: string
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:149

getModelCheckDefinitionSetByUuid

getModelCheckDefinitionSetByUuid(uuid): Promise<unknown>
Parameters
- uuid: string
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:150

getModelReportByModelCheckSetUuid

getModelReportByModelCheckSetUuid(modelCheckSetUuid): Promise<unknown>
Parameters
- modelCheckSetUuid: string
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:153

listChecks

listChecks(): Promise<unknown>
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:148

listModelCheckDefinitionSets

listModelCheckDefinitionSets(): Promise<unknown>
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:147

listModelCheckDefinitions

listModelCheckDefinitions(modelCheckDefinitionSetUuid): Promise<unknown>
Parameters
- modelCheckDefinitionSetUuid: string
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:146

runChecks

runChecks(modelCheckDefinitionSetUuid, versionUuids, checkDefinitionUuids, force): Promise<unknown>
Parameters
- modelCheckDefinitionSetUuid: string
- versionUuids: string[]
- checkDefinitionUuids: string[]
- force: boolean
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:144

runChecksAsTask

runChecksAsTask(modelCheckDefinitionSetUuid, versionUuids, checkDefinitionUuids, force): Promise<unknown>
Parameters
- modelCheckDefinitionSetUuid: string
- versionUuids: string[]
- checkDefinitionUuids: string[]
- force: boolean
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:145

runIdsCheck

runIdsCheck(versionUuids, ids): Promise<unknown>
Run an IDS check on a set of models
Parameters
- versionUuids: Iterable<string>
  An iterable of Vid (Version UUID)
- ids: string
  Your IDS as an XML string
Returns Promise<unknown>
A Promise that resolves to either the results or an error
- Defined in BimWorksJsSdk/jssdk.d.ts:163