BIM.works SDKs - v1.5.0-b164
    Preparing search index...

    Class Checks

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

    Index

    Constructors

    constructor

    Methods

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

    Constructors

    Methods

    • Parameters

      • resourceUuid: string

      Returns Promise<unknown>

    • Parameters

      • modelCheckSetUuids: Iterable<string>

      Returns Promise<unknown>

    • Download the check results as a BCF file

      Parameters

      • versionUuids: Iterable<string>

        The models to check

      • type: string

        The type of the check, for IDS this should be "IdsCheck", or for a BCL based check "Check3"

      • input: string

        The check input, for example IDS XML data

      Returns Promise<string>

      A Promise, resolving to a URL

    • Parameters

      • setUuid: string
      • name: string

      Returns Promise<unknown>

    • Parameters

      • uuid: string

      Returns Promise<unknown>

    • Parameters

      • name: string

      Returns Promise<unknown>

    • Parameters

      • uuid: string

      Returns Promise<unknown>

    • Parameters

      • modelCheckSetUuid: string

      Returns Promise<unknown>

    • Parameters

      • modelCheckDefinitionSetUuid: string

      Returns Promise<unknown>

    • Parameters

      • modelCheckDefinitionSetUuid: string
      • versionUuids: string[]
      • checkDefinitionUuids: string[]
      • force: boolean

      Returns Promise<unknown>

    • Parameters

      • modelCheckDefinitionSetUuid: string
      • versionUuids: string[]
      • checkDefinitionUuids: string[]
      • force: boolean

      Returns 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods