BIM.works SDKs - v3.0.0-b.115
    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 runCheck3 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

      • Optionalparameters: Record<string, unknown> | null

        The values of the $name parameters of a BCL check, by name; every parameter then needs a value. Not for an IDS. Without them a $name stays unbound

      Returns Promise<string>

      A Promise, resolving to a URL; rejected when the check is refused

    • 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>

    • Returns Promise<unknown>

    • Parameters

      • modelCheckDefinitionSetUuid: string

      Returns Promise<unknown>

    • Returns Promise<unknown>

    • Run a BCL (BIM.works Check Language, "Check3") check on a set of models, without storing it as a check definition

      Parameters

      • versionUuids: Iterable<string>

        An iterable of Vid (Version UUID)

      • bcl: string

        Your check as a BCL string

      • Optionalparameters: Record<string, unknown> | null

        The values of the $name parameters of the check, by name; every parameter then needs a value. Without them a $name stays unbound

      Returns Promise<unknown>

      A Promise that resolves to { modelMapping, results, bcl }, where results.checkResults holds the check results, or rejects with an error (SYNTAX_ERROR with line:column when the BCL does not parse, MISSING_PARAMETER or PARAMETER_TYPE_MISMATCH for the parameters)

    • Parameters

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

      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