Class ModelChecksApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.ModelChecksApi

public class ModelChecksApi
extends SubApi

API Calls related to running and defining Model Checks

Constructor Summary

Constructors

Constructor	Description
ModelChecksApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
AddModelCheckDefinition	addModelCheckDefinition(String name, UUID setUuid, String javaClass)	Deprecated.
AddModelCheckDefinitionSet	addModelCheckDefinitionSet(String name)	Deprecated.
DownloadCheckResultsAsBcfInput	downloadCheckResultsAsBcf(UUID uuid)	Deprecated.
DownloadCheckResultsAsBcfDirect	downloadCheckResultsAsBcfDirect(Set<UUID> versionUuids, String type, String input)	Download the results of a model check as BCF.
DownloadCheckResultsAsBcfDirect	downloadCheckResultsAsBcfDirect(Set<UUID> versionUuids, String type, String input, com.fasterxml.jackson.databind.JsonNode parameters)	As downloadCheckResultsAsBcfDirect(Set, String, String), for a BCL check ("Check3") with $name parameters: parameters holds their values by name, and every parameter then needs one
GetModelCheckDefinitionByName	getModelCheckDefinitionByName(UUID setUuid, String name)	Deprecated.
GetModelCheckDefinitionByName	getModelCheckDefinitionByNameNE(UUID setUuid, String name)	Deprecated.
com.fasterxml.jackson.databind.node.ObjectNode	getModelCheckDefinitionSetByName(String name)	Deprecated.
com.fasterxml.jackson.databind.node.ObjectNode	getModelCheckDefinitionSetByNameNE(String name)	Deprecated.
GetModelCheckResultsTask	getModelCheckResults(UUID modelCheckSetUuid)	Deprecated.
GetModelReportTask	getModelReport(Set<UUID> versionUuids)	Deprecated.
GetModelReportByModelCheckSetUuidTask	getModelReportByCheckSetUuid(UUID modelCheckSetUuid)	Deprecated.
com.fasterxml.jackson.databind.JsonNode	getValidationReport(UUID versionUuid, boolean summaryOnly)	The stored checkin validation report of a model version: per-stage (parse, schema check, geometry, indexing) findings and a summary with EXACT per-severity counts — counts stay exact even when the findings lists are truncated by the server-side caps.
com.fasterxml.jackson.databind.JsonNode	getValidationReportForError(UUID errorUuid)	The validation report of a FAILED checkin, resolved through the server's error record: a checkin that fails still has a report explaining how far the pipeline got and what it found (docs/validation-report-design.md section 9).
com.fasterxml.jackson.databind.node.ArrayNode	listModelCheckDefinitions(ListModelCheckDefinitionsInput input)	Deprecated.
com.fasterxml.jackson.databind.node.ArrayNode	listModelCheckDefinitionSets()	Every active check definition set (requires the CHECK_DEFINITIONS user feature).
ListModelCheckResultsTask	listModelCheckResults(UUID modelCheckSetUuid, Set<UUID> modelCheckResultUuids)	Deprecated.
ModelChecksAvailabilityTask	modelCheckResultsAvailability(UUID modelCheckSetEUuid)	Deprecated.
RunCheckTask	runCheck(String input, Set<UUID> versionUuids)	Deprecated.
RunChecksTask	runChecks(UUID modelCheckDefinitionSet, Set<UUID> versionUuids, com.fasterxml.jackson.databind.node.ObjectNode input)	Deprecated.
RunChecksTask	runChecks(UUID modelCheckDefinitionSet, Set<UUID> versionUuids, com.fasterxml.jackson.databind.node.ObjectNode input, Set<UUID> modelCheckDefinitionUuids)	Deprecated.
RunIdsCheckTask	runIdsCheck(String input, Set<UUID> versionUuids)
UpdateModelCheckDefinition	updateModelCheckDefinition(UUID uuid, String name, String input)	Deprecated.

Methods inherited from class SubApi

getBimWorksClient

Modifier and Type	Method	Description
BimWorksClient	getBimWorksClient()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ModelChecksApi

public ModelChecksApi(BimWorksClient bimWorksClient)

Method Details

getValidationReport

public com.fasterxml.jackson.databind.JsonNode getValidationReport(UUID versionUuid,
 boolean summaryOnly)
                                                            throws BimWorksException

The stored checkin validation report of a model version: per-stage (parse, schema check, geometry, indexing) findings and a summary with EXACT per-severity counts — counts stay exact even when the findings lists are truncated by the server-side caps.

The result carries summary and report; both are null (never an error) when the version predates validation reports.

Parameters:

versionUuid - the model version

summaryOnly - true to fetch only the compact summary (cheap), false for the full report including findings

Throws:

BimWorksException

getValidationReportForError

public com.fasterxml.jackson.databind.JsonNode getValidationReportForError(UUID errorUuid)
                                                                    throws BimWorksException

The validation report of a FAILED checkin, resolved through the server's error record: a checkin that fails still has a report explaining how far the pipeline got and what it found (docs/validation-report-design.md section 9).

Parameters:

errorUuid - the uuid of the server error row for the failed checkin

Throws:

BimWorksException

runChecks

@Deprecated
public RunChecksTask runChecks(UUID modelCheckDefinitionSet,
 Set<UUID> versionUuids,
 com.fasterxml.jackson.databind.node.ObjectNode input)
                        throws BimWorksException

Deprecated.

Throws:

BimWorksException

runChecks

@Deprecated
public RunChecksTask runChecks(UUID modelCheckDefinitionSet,
 Set<UUID> versionUuids,
 com.fasterxml.jackson.databind.node.ObjectNode input,
 Set<UUID> modelCheckDefinitionUuids)
                        throws BimWorksException

Deprecated.

Throws:

BimWorksException

listModelCheckDefinitions

@Deprecated
public com.fasterxml.jackson.databind.node.ArrayNode listModelCheckDefinitions(ListModelCheckDefinitionsInput input)
                                                                        throws BimWorksException

Deprecated.

Throws:

BimWorksException

getModelCheckDefinitionSetByName

@Deprecated
public com.fasterxml.jackson.databind.node.ObjectNode getModelCheckDefinitionSetByName(String name)
                                                                                throws BimWorksException

Deprecated.

Throws:

BimWorksException

getModelCheckDefinitionSetByNameNE

@Deprecated
public com.fasterxml.jackson.databind.node.ObjectNode getModelCheckDefinitionSetByNameNE(String name)
                                                                                  throws BimWorksException

Deprecated.

Throws:

BimWorksException

downloadCheckResultsAsBcf

@Deprecated
public DownloadCheckResultsAsBcfInput downloadCheckResultsAsBcf(UUID uuid)
                                                         throws BimWorksException

Deprecated.

Throws:

BimWorksException

getModelReport

@Deprecated
public GetModelReportTask getModelReport(Set<UUID> versionUuids)

Deprecated.

getModelReportByCheckSetUuid

@Deprecated
public GetModelReportByModelCheckSetUuidTask getModelReportByCheckSetUuid(UUID modelCheckSetUuid)

Deprecated.

getModelCheckResults

@Deprecated
public GetModelCheckResultsTask getModelCheckResults(UUID modelCheckSetUuid)

Deprecated.

listModelCheckResults

@Deprecated
public ListModelCheckResultsTask listModelCheckResults(UUID modelCheckSetUuid,
 Set<UUID> modelCheckResultUuids)

Deprecated.

modelCheckResultsAvailability

@Deprecated
public ModelChecksAvailabilityTask modelCheckResultsAvailability(UUID modelCheckSetEUuid)

Deprecated.

addModelCheckDefinitionSet

@Deprecated
public AddModelCheckDefinitionSet addModelCheckDefinitionSet(String name)

Deprecated.

addModelCheckDefinition

@Deprecated
public AddModelCheckDefinition addModelCheckDefinition(String name,
 UUID setUuid,
 String javaClass)

Deprecated.

updateModelCheckDefinition

@Deprecated
public UpdateModelCheckDefinition updateModelCheckDefinition(UUID uuid,
 String name,
 String input)

Deprecated.

getModelCheckDefinitionByName

@Deprecated
public GetModelCheckDefinitionByName getModelCheckDefinitionByName(UUID setUuid,
 String name)

Deprecated.

getModelCheckDefinitionByNameNE

@Deprecated
public GetModelCheckDefinitionByName getModelCheckDefinitionByNameNE(UUID setUuid,
 String name)

Deprecated.

runCheck

@Deprecated
public RunCheckTask runCheck(String input,
 Set<UUID> versionUuids)

Deprecated.

runIdsCheck

public RunIdsCheckTask runIdsCheck(String input,
 Set<UUID> versionUuids)

downloadCheckResultsAsBcfDirect

public DownloadCheckResultsAsBcfDirect downloadCheckResultsAsBcfDirect(Set<UUID> versionUuids,
 String type,
 String input)

Download the results of a model check as BCF. This can for example be used to export a BCF for an IDS check

Parameters:

versionUuids - Version UUIDs of the models to check

type - For IDS this has to be "IdsCheck"

input - The actual description of the model check, for "IdsCheck" this must be a valid IDS (XML)

Returns:

DownloadCheckResultsAsBcfDirect To do something with the results first call executeAsync(), then use downloadTo(outputStream) to write the returned data to for example a file

downloadCheckResultsAsBcfDirect

public DownloadCheckResultsAsBcfDirect downloadCheckResultsAsBcfDirect(Set<UUID> versionUuids,
 String type,
 String input,
 com.fasterxml.jackson.databind.JsonNode parameters)

As downloadCheckResultsAsBcfDirect(Set, String, String), for a BCL check ("Check3") with $name parameters: parameters holds their values by name, and every parameter then needs one

listModelCheckDefinitionSets

public com.fasterxml.jackson.databind.node.ArrayNode listModelCheckDefinitionSets()
                                                                           throws BimWorksException

Every active check definition set (requires the CHECK_DEFINITIONS user feature).

Throws:

BimWorksException