Documentation

IFCApi
in package

BIMworks

IFCApi Class Doc Comment

Constants

contentTypes : array<string|int, string> = ['check' => ['application/json'], 'commitTransa...

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
check() : CheckResultsResponse|ErrorResponse: Operation check
checkAsync() : PromiseInterface: Operation checkAsync
checkAsyncWithHttpInfo() : PromiseInterface: Operation checkAsyncWithHttpInfo
checkRequest() : Request: Create request for operation 'check'
checkWithHttpInfo() : array<string|int, mixed>: Operation checkWithHttpInfo
commitTransaction() : CommitTransactionResult|ErrorResponse: Operation commitTransaction
commitTransactionAsync() : PromiseInterface: Operation commitTransactionAsync
commitTransactionAsyncWithHttpInfo() : PromiseInterface: Operation commitTransactionAsyncWithHttpInfo
commitTransactionRequest() : Request: Create request for operation 'commitTransaction'
commitTransactionWithHttpInfo() : array<string|int, mixed>: Operation commitTransactionWithHttpInfo
compareModels() : CompareResult|ErrorResponse: Operation compareModels
compareModelsAsync() : PromiseInterface: Operation compareModelsAsync
compareModelsAsyncWithHttpInfo() : PromiseInterface: Operation compareModelsAsyncWithHttpInfo
compareModelsRequest() : Request: Create request for operation 'compareModels'
compareModelsWithHttpInfo() : array<string|int, mixed>: Operation compareModelsWithHttpInfo
compareObjects() : CompareObjectsResult|ErrorResponse: Operation compareObjects
compareObjectsAsync() : PromiseInterface: Operation compareObjectsAsync
compareObjectsAsyncWithHttpInfo() : PromiseInterface: Operation compareObjectsAsyncWithHttpInfo
compareObjectsRequest() : Request: Create request for operation 'compareObjects'
compareObjectsWithHttpInfo() : array<string|int, mixed>: Operation compareObjectsWithHttpInfo
deleteComparePairOverride() : ComparePairOverrides|ErrorResponse: Operation deleteComparePairOverride
deleteComparePairOverrideAsync() : PromiseInterface: Operation deleteComparePairOverrideAsync
deleteComparePairOverrideAsyncWithHttpInfo() : PromiseInterface: Operation deleteComparePairOverrideAsyncWithHttpInfo
deleteComparePairOverrideRequest() : Request: Create request for operation 'deleteComparePairOverride'
deleteComparePairOverrideWithHttpInfo() : array<string|int, mixed>: Operation deleteComparePairOverrideWithHttpInfo
exportCompareResult() : SplFileObject|ErrorResponse: Operation exportCompareResult
exportCompareResultAsync() : PromiseInterface: Operation exportCompareResultAsync
exportCompareResultAsyncWithHttpInfo() : PromiseInterface: Operation exportCompareResultAsyncWithHttpInfo
exportCompareResultRequest() : Request: Create request for operation 'exportCompareResult'
exportCompareResultWithHttpInfo() : array<string|int, mixed>: Operation exportCompareResultWithHttpInfo
getCompareBul() : CompareBul|ErrorResponse: Operation getCompareBul
getCompareBulAsync() : PromiseInterface: Operation getCompareBulAsync
getCompareBulAsyncWithHttpInfo() : PromiseInterface: Operation getCompareBulAsyncWithHttpInfo
getCompareBulRequest() : Request: Create request for operation 'getCompareBul'
getCompareBulWithHttpInfo() : array<string|int, mixed>: Operation getCompareBulWithHttpInfo
getCompareResult() : CompareResult|ErrorResponse: Operation getCompareResult
getCompareResultAsync() : PromiseInterface: Operation getCompareResultAsync
getCompareResultAsyncWithHttpInfo() : PromiseInterface: Operation getCompareResultAsyncWithHttpInfo
getCompareResultRequest() : Request: Create request for operation 'getCompareResult'
getCompareResultWithHttpInfo() : array<string|int, mixed>: Operation getCompareResultWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
getMatchCandidates() : MatchCandidates|ErrorResponse: Operation getMatchCandidates
getMatchCandidatesAsync() : PromiseInterface: Operation getMatchCandidatesAsync
getMatchCandidatesAsyncWithHttpInfo() : PromiseInterface: Operation getMatchCandidatesAsyncWithHttpInfo
getMatchCandidatesRequest() : Request: Create request for operation 'getMatchCandidates'
getMatchCandidatesWithHttpInfo() : array<string|int, mixed>: Operation getMatchCandidatesWithHttpInfo
getObjectHistory() : array<string, mixed>|ErrorResponse: Operation getObjectHistory
getObjectHistoryAsync() : PromiseInterface: Operation getObjectHistoryAsync
getObjectHistoryAsyncWithHttpInfo() : PromiseInterface: Operation getObjectHistoryAsyncWithHttpInfo
getObjectHistoryRequest() : Request: Create request for operation 'getObjectHistory'
getObjectHistoryWithHttpInfo() : array<string|int, mixed>: Operation getObjectHistoryWithHttpInfo
getVersionChanges() : VersionChangesResult|ErrorResponse: Operation getVersionChanges
getVersionChangesAsync() : PromiseInterface: Operation getVersionChangesAsync
getVersionChangesAsyncWithHttpInfo() : PromiseInterface: Operation getVersionChangesAsyncWithHttpInfo
getVersionChangesRequest() : Request: Create request for operation 'getVersionChanges'
getVersionChangesWithHttpInfo() : array<string|int, mixed>: Operation getVersionChangesWithHttpInfo
listBuildingStoreys() : BuildingStoreys|ErrorResponse: Operation listBuildingStoreys
listBuildingStoreysAsync() : PromiseInterface: Operation listBuildingStoreysAsync
listBuildingStoreysAsyncWithHttpInfo() : PromiseInterface: Operation listBuildingStoreysAsyncWithHttpInfo
listBuildingStoreysRequest() : Request: Create request for operation 'listBuildingStoreys'
listBuildingStoreysWithHttpInfo() : array<string|int, mixed>: Operation listBuildingStoreysWithHttpInfo
listComparePairOverrides() : ComparePairOverrides|ErrorResponse: Operation listComparePairOverrides
listComparePairOverridesAsync() : PromiseInterface: Operation listComparePairOverridesAsync
listComparePairOverridesAsyncWithHttpInfo() : PromiseInterface: Operation listComparePairOverridesAsyncWithHttpInfo
listComparePairOverridesRequest() : Request: Create request for operation 'listComparePairOverrides'
listComparePairOverridesWithHttpInfo() : array<string|int, mixed>: Operation listComparePairOverridesWithHttpInfo
mapQids() : MapQidsResult|ErrorResponse: Operation mapQids
mapQidsAsync() : PromiseInterface: Operation mapQidsAsync
mapQidsAsyncWithHttpInfo() : PromiseInterface: Operation mapQidsAsyncWithHttpInfo
mapQidsRequest() : Request: Create request for operation 'mapQids'
mapQidsWithHttpInfo() : array<string|int, mixed>: Operation mapQidsWithHttpInfo
parseQuery() : array<string, mixed>|ErrorResponse: Operation parseQuery
parseQueryAsync() : PromiseInterface: Operation parseQueryAsync
parseQueryAsyncWithHttpInfo() : PromiseInterface: Operation parseQueryAsyncWithHttpInfo
parseQueryRequest() : Request: Create request for operation 'parseQuery'
parseQueryWithHttpInfo() : array<string|int, mixed>: Operation parseQueryWithHttpInfo
query() : mixed|ErrorResponse: Operation query
queryAsync() : PromiseInterface: Operation queryAsync
queryAsyncWithHttpInfo() : PromiseInterface: Operation queryAsyncWithHttpInfo
queryRequest() : Request: Create request for operation 'query'
queryWithHttpInfo() : array<string|int, mixed>: Operation queryWithHttpInfo
recordUploadAsTransaction() : RecordUploadAsTransactionResult|ErrorResponse: Operation recordUploadAsTransaction
recordUploadAsTransactionAsync() : PromiseInterface: Operation recordUploadAsTransactionAsync
recordUploadAsTransactionAsyncWithHttpInfo() : PromiseInterface: Operation recordUploadAsTransactionAsyncWithHttpInfo
recordUploadAsTransactionRequest() : Request: Create request for operation 'recordUploadAsTransaction'
recordUploadAsTransactionWithHttpInfo() : array<string|int, mixed>: Operation recordUploadAsTransactionWithHttpInfo
resolveBvl() : ResolvedActions|ErrorResponse: Operation resolveBvl
resolveBvlAsync() : PromiseInterface: Operation resolveBvlAsync
resolveBvlAsyncWithHttpInfo() : PromiseInterface: Operation resolveBvlAsyncWithHttpInfo
resolveBvlRequest() : Request: Create request for operation 'resolveBvl'
resolveBvlWithHttpInfo() : array<string|int, mixed>: Operation resolveBvlWithHttpInfo
setComparePairOverride() : ComparePairOverrideSet|ErrorResponse: Operation setComparePairOverride
setComparePairOverrideAsync() : PromiseInterface: Operation setComparePairOverrideAsync
setComparePairOverrideAsyncWithHttpInfo() : PromiseInterface: Operation setComparePairOverrideAsyncWithHttpInfo
setComparePairOverrideRequest() : Request: Create request for operation 'setComparePairOverride'
setComparePairOverrideWithHttpInfo() : array<string|int, mixed>: Operation setComparePairOverrideWithHttpInfo
setHostIndex() : void: Set the host index
textSearch() : TextSearchResult|ErrorResponse: Operation textSearch
textSearchAsync() : PromiseInterface: Operation textSearchAsync
textSearchAsyncWithHttpInfo() : PromiseInterface: Operation textSearchAsyncWithHttpInfo
textSearchRequest() : Request: Create request for operation 'textSearch'
textSearchWithHttpInfo() : array<string|int, mixed>: Operation textSearchWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['check' => ['application/json'], 'commitTransaction' => ['application/json'], 'compareModels' => ['application/json'], 'compareObjects' => ['application/json'], 'deleteComparePairOverride' => ['application/json'], 'exportCompareResult' => ['application/json'], 'getCompareBul' => ['application/json'], 'getCompareResult' => ['application/json'], 'getMatchCandidates' => ['application/json'], 'getObjectHistory' => ['application/json'], 'getVersionChanges' => ['application/json'], 'listBuildingStoreys' => ['application/json'], 'listComparePairOverrides' => ['application/json'], 'mapQids' => ['application/json'], 'parseQuery' => ['application/json'], 'query' => ['application/json'], 'recordUploadAsTransaction' => ['application/json'], 'resolveBvl' => ['application/json'], 'setComparePairOverride' => ['application/json'], 'textSearch' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

check()

Operation check


    public
                    check(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : CheckResultsResponse|ErrorResponse

Check one or more models

Parameters

$check_request : CheckRequest: check_request (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

CheckResultsResponse|ErrorResponse

checkAsync()

Operation checkAsync


    public
                    checkAsync(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : PromiseInterface

Check one or more models

Parameters

$check_request : CheckRequest: (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

PromiseInterface

checkAsyncWithHttpInfo()

Operation checkAsyncWithHttpInfo


    public
                    checkAsyncWithHttpInfo(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : PromiseInterface

Check one or more models

Parameters

$check_request : CheckRequest: (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

PromiseInterface

checkRequest()

Create request for operation 'check'


    public
                    checkRequest(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : Request

Parameters

$check_request : CheckRequest: (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

Request

checkWithHttpInfo()

Operation checkWithHttpInfo


    public
                    checkWithHttpInfo(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : array<string|int, mixed>

Check one or more models

Parameters

$check_request : CheckRequest: (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

array<string|int, mixed> —

commitTransaction()

Operation commitTransaction


    public
                    commitTransaction(CommitTransactionRequest $commit_transaction_request[, string $contentType = self::contentTypes['commitTransaction'][0] ]) : CommitTransactionResult|ErrorResponse

Commit a BUL transaction against the head Version of a Node, producing a new Version

Parameters

$commit_transaction_request : CommitTransactionRequest: commit_transaction_request (required)
$contentType : string = self::contentTypes['commitTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['commitTransaction'] to see the possible values for this operation

Return values

CommitTransactionResult|ErrorResponse

commitTransactionAsync()

Operation commitTransactionAsync


    public
                    commitTransactionAsync(CommitTransactionRequest $commit_transaction_request[, string $contentType = self::contentTypes['commitTransaction'][0] ]) : PromiseInterface

Commit a BUL transaction against the head Version of a Node, producing a new Version

Parameters

$commit_transaction_request : CommitTransactionRequest: (required)
$contentType : string = self::contentTypes['commitTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['commitTransaction'] to see the possible values for this operation

Return values

PromiseInterface

commitTransactionAsyncWithHttpInfo()

Operation commitTransactionAsyncWithHttpInfo


    public
                    commitTransactionAsyncWithHttpInfo(CommitTransactionRequest $commit_transaction_request[, string $contentType = self::contentTypes['commitTransaction'][0] ]) : PromiseInterface

Commit a BUL transaction against the head Version of a Node, producing a new Version

Parameters

$commit_transaction_request : CommitTransactionRequest: (required)
$contentType : string = self::contentTypes['commitTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['commitTransaction'] to see the possible values for this operation

Return values

PromiseInterface

commitTransactionRequest()

Create request for operation 'commitTransaction'


    public
                    commitTransactionRequest(CommitTransactionRequest $commit_transaction_request[, string $contentType = self::contentTypes['commitTransaction'][0] ]) : Request

Parameters

$commit_transaction_request : CommitTransactionRequest: (required)
$contentType : string = self::contentTypes['commitTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['commitTransaction'] to see the possible values for this operation

Return values

Request

commitTransactionWithHttpInfo()

Operation commitTransactionWithHttpInfo


    public
                    commitTransactionWithHttpInfo(CommitTransactionRequest $commit_transaction_request[, string $contentType = self::contentTypes['commitTransaction'][0] ]) : array<string|int, mixed>

Commit a BUL transaction against the head Version of a Node, producing a new Version

Parameters

$commit_transaction_request : CommitTransactionRequest: (required)
$contentType : string = self::contentTypes['commitTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['commitTransaction'] to see the possible values for this operation

Return values

array<string|int, mixed> —

compareModels()

Operation compareModels


    public
                    compareModels(CompareModelsRequest $compare_models_request[, string $contentType = self::contentTypes['compareModels'][0] ]) : CompareResult|ErrorResponse

Compare two models with a BCOL definition

Parameters

$compare_models_request : CompareModelsRequest: compare_models_request (required)
$contentType : string = self::contentTypes['compareModels'][0]: The value for the Content-Type header. Check self::contentTypes['compareModels'] to see the possible values for this operation

Return values

CompareResult|ErrorResponse

compareModelsAsync()

Operation compareModelsAsync


    public
                    compareModelsAsync(CompareModelsRequest $compare_models_request[, string $contentType = self::contentTypes['compareModels'][0] ]) : PromiseInterface

Compare two models with a BCOL definition

Parameters

$compare_models_request : CompareModelsRequest: (required)
$contentType : string = self::contentTypes['compareModels'][0]: The value for the Content-Type header. Check self::contentTypes['compareModels'] to see the possible values for this operation

Return values

PromiseInterface

compareModelsAsyncWithHttpInfo()

Operation compareModelsAsyncWithHttpInfo


    public
                    compareModelsAsyncWithHttpInfo(CompareModelsRequest $compare_models_request[, string $contentType = self::contentTypes['compareModels'][0] ]) : PromiseInterface

Compare two models with a BCOL definition

Parameters

$compare_models_request : CompareModelsRequest: (required)
$contentType : string = self::contentTypes['compareModels'][0]: The value for the Content-Type header. Check self::contentTypes['compareModels'] to see the possible values for this operation

Return values

PromiseInterface

compareModelsRequest()

Create request for operation 'compareModels'


    public
                    compareModelsRequest(CompareModelsRequest $compare_models_request[, string $contentType = self::contentTypes['compareModels'][0] ]) : Request

Parameters

$compare_models_request : CompareModelsRequest: (required)
$contentType : string = self::contentTypes['compareModels'][0]: The value for the Content-Type header. Check self::contentTypes['compareModels'] to see the possible values for this operation

Return values

Request

compareModelsWithHttpInfo()

Operation compareModelsWithHttpInfo


    public
                    compareModelsWithHttpInfo(CompareModelsRequest $compare_models_request[, string $contentType = self::contentTypes['compareModels'][0] ]) : array<string|int, mixed>

Compare two models with a BCOL definition

Parameters

$compare_models_request : CompareModelsRequest: (required)
$contentType : string = self::contentTypes['compareModels'][0]: The value for the Content-Type header. Check self::contentTypes['compareModels'] to see the possible values for this operation

Return values

array<string|int, mixed> —

compareObjects()

Operation compareObjects


    public
                    compareObjects(CompareObjectsRequest $compare_objects_request[, string $contentType = self::contentTypes['compareObjects'][0] ]) : CompareObjectsResult|ErrorResponse

Compare two chosen objects

Parameters

$compare_objects_request : CompareObjectsRequest: compare_objects_request (required)
$contentType : string = self::contentTypes['compareObjects'][0]: The value for the Content-Type header. Check self::contentTypes['compareObjects'] to see the possible values for this operation

Return values

CompareObjectsResult|ErrorResponse

compareObjectsAsync()

Operation compareObjectsAsync


    public
                    compareObjectsAsync(CompareObjectsRequest $compare_objects_request[, string $contentType = self::contentTypes['compareObjects'][0] ]) : PromiseInterface

Compare two chosen objects

Parameters

$compare_objects_request : CompareObjectsRequest: (required)
$contentType : string = self::contentTypes['compareObjects'][0]: The value for the Content-Type header. Check self::contentTypes['compareObjects'] to see the possible values for this operation

Return values

PromiseInterface

compareObjectsAsyncWithHttpInfo()

Operation compareObjectsAsyncWithHttpInfo


    public
                    compareObjectsAsyncWithHttpInfo(CompareObjectsRequest $compare_objects_request[, string $contentType = self::contentTypes['compareObjects'][0] ]) : PromiseInterface

Compare two chosen objects

Parameters

$compare_objects_request : CompareObjectsRequest: (required)
$contentType : string = self::contentTypes['compareObjects'][0]: The value for the Content-Type header. Check self::contentTypes['compareObjects'] to see the possible values for this operation

Return values

PromiseInterface

compareObjectsRequest()

Create request for operation 'compareObjects'


    public
                    compareObjectsRequest(CompareObjectsRequest $compare_objects_request[, string $contentType = self::contentTypes['compareObjects'][0] ]) : Request

Parameters

$compare_objects_request : CompareObjectsRequest: (required)
$contentType : string = self::contentTypes['compareObjects'][0]: The value for the Content-Type header. Check self::contentTypes['compareObjects'] to see the possible values for this operation

Return values

Request

compareObjectsWithHttpInfo()

Operation compareObjectsWithHttpInfo


    public
                    compareObjectsWithHttpInfo(CompareObjectsRequest $compare_objects_request[, string $contentType = self::contentTypes['compareObjects'][0] ]) : array<string|int, mixed>

Compare two chosen objects

Parameters

$compare_objects_request : CompareObjectsRequest: (required)
$contentType : string = self::contentTypes['compareObjects'][0]: The value for the Content-Type header. Check self::contentTypes['compareObjects'] to see the possible values for this operation

Return values

array<string|int, mixed> —

deleteComparePairOverride()

Operation deleteComparePairOverride


    public
                    deleteComparePairOverride(DeleteComparePairOverrideRequest $delete_compare_pair_override_request[, string $contentType = self::contentTypes['deleteComparePairOverride'][0] ]) : ComparePairOverrides|ErrorResponse

Take a pair fixed by hand away again

Parameters

$delete_compare_pair_override_request : DeleteComparePairOverrideRequest: delete_compare_pair_override_request (required)
$contentType : string = self::contentTypes['deleteComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['deleteComparePairOverride'] to see the possible values for this operation

Return values

ComparePairOverrides|ErrorResponse

deleteComparePairOverrideAsync()

Operation deleteComparePairOverrideAsync


    public
                    deleteComparePairOverrideAsync(DeleteComparePairOverrideRequest $delete_compare_pair_override_request[, string $contentType = self::contentTypes['deleteComparePairOverride'][0] ]) : PromiseInterface

Take a pair fixed by hand away again

Parameters

$delete_compare_pair_override_request : DeleteComparePairOverrideRequest: (required)
$contentType : string = self::contentTypes['deleteComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['deleteComparePairOverride'] to see the possible values for this operation

Return values

PromiseInterface

deleteComparePairOverrideAsyncWithHttpInfo()

Operation deleteComparePairOverrideAsyncWithHttpInfo


    public
                    deleteComparePairOverrideAsyncWithHttpInfo(DeleteComparePairOverrideRequest $delete_compare_pair_override_request[, string $contentType = self::contentTypes['deleteComparePairOverride'][0] ]) : PromiseInterface

Take a pair fixed by hand away again

Parameters

$delete_compare_pair_override_request : DeleteComparePairOverrideRequest: (required)
$contentType : string = self::contentTypes['deleteComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['deleteComparePairOverride'] to see the possible values for this operation

Return values

PromiseInterface

deleteComparePairOverrideRequest()

Create request for operation 'deleteComparePairOverride'


    public
                    deleteComparePairOverrideRequest(DeleteComparePairOverrideRequest $delete_compare_pair_override_request[, string $contentType = self::contentTypes['deleteComparePairOverride'][0] ]) : Request

Parameters

$delete_compare_pair_override_request : DeleteComparePairOverrideRequest: (required)
$contentType : string = self::contentTypes['deleteComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['deleteComparePairOverride'] to see the possible values for this operation

Return values

Request

deleteComparePairOverrideWithHttpInfo()

Operation deleteComparePairOverrideWithHttpInfo


    public
                    deleteComparePairOverrideWithHttpInfo(DeleteComparePairOverrideRequest $delete_compare_pair_override_request[, string $contentType = self::contentTypes['deleteComparePairOverride'][0] ]) : array<string|int, mixed>

Take a pair fixed by hand away again

Parameters

$delete_compare_pair_override_request : DeleteComparePairOverrideRequest: (required)
$contentType : string = self::contentTypes['deleteComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['deleteComparePairOverride'] to see the possible values for this operation

Return values

array<string|int, mixed> —

exportCompareResult()

Operation exportCompareResult


    public
                    exportCompareResult(ExportCompareResultRequest $export_compare_result_request[, string $contentType = self::contentTypes['exportCompareResult'][0] ]) : SplFileObject|ErrorResponse

Download a stored compare result (deprecated, use GetCompareResult with a format)

Parameters

$export_compare_result_request : ExportCompareResultRequest: export_compare_result_request (required)
$contentType : string = self::contentTypes['exportCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['exportCompareResult'] to see the possible values for this operation

Return values

SplFileObject|ErrorResponse

exportCompareResultAsync()

Operation exportCompareResultAsync


    public
                    exportCompareResultAsync(ExportCompareResultRequest $export_compare_result_request[, string $contentType = self::contentTypes['exportCompareResult'][0] ]) : PromiseInterface

Download a stored compare result (deprecated, use GetCompareResult with a format)

Parameters

$export_compare_result_request : ExportCompareResultRequest: (required)
$contentType : string = self::contentTypes['exportCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['exportCompareResult'] to see the possible values for this operation

Return values

PromiseInterface

exportCompareResultAsyncWithHttpInfo()

Operation exportCompareResultAsyncWithHttpInfo


    public
                    exportCompareResultAsyncWithHttpInfo(ExportCompareResultRequest $export_compare_result_request[, string $contentType = self::contentTypes['exportCompareResult'][0] ]) : PromiseInterface

Download a stored compare result (deprecated, use GetCompareResult with a format)

Parameters

$export_compare_result_request : ExportCompareResultRequest: (required)
$contentType : string = self::contentTypes['exportCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['exportCompareResult'] to see the possible values for this operation

Return values

PromiseInterface

exportCompareResultRequest()

Create request for operation 'exportCompareResult'


    public
                    exportCompareResultRequest(ExportCompareResultRequest $export_compare_result_request[, string $contentType = self::contentTypes['exportCompareResult'][0] ]) : Request

Parameters

$export_compare_result_request : ExportCompareResultRequest: (required)
$contentType : string = self::contentTypes['exportCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['exportCompareResult'] to see the possible values for this operation

Return values

Request

exportCompareResultWithHttpInfo()

Operation exportCompareResultWithHttpInfo


    public
                    exportCompareResultWithHttpInfo(ExportCompareResultRequest $export_compare_result_request[, string $contentType = self::contentTypes['exportCompareResult'][0] ]) : array<string|int, mixed>

Download a stored compare result (deprecated, use GetCompareResult with a format)

Parameters

$export_compare_result_request : ExportCompareResultRequest: (required)
$contentType : string = self::contentTypes['exportCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['exportCompareResult'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getCompareBul()

Operation getCompareBul


    public
                    getCompareBul(GetCompareBulRequest $get_compare_bul_request[, string $contentType = self::contentTypes['getCompareBul'][0] ]) : CompareBul|ErrorResponse

The changes between two Versions as BUL

Parameters

$get_compare_bul_request : GetCompareBulRequest: get_compare_bul_request (required)
$contentType : string = self::contentTypes['getCompareBul'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareBul'] to see the possible values for this operation

Return values

CompareBul|ErrorResponse

getCompareBulAsync()

Operation getCompareBulAsync


    public
                    getCompareBulAsync(GetCompareBulRequest $get_compare_bul_request[, string $contentType = self::contentTypes['getCompareBul'][0] ]) : PromiseInterface

The changes between two Versions as BUL

Parameters

$get_compare_bul_request : GetCompareBulRequest: (required)
$contentType : string = self::contentTypes['getCompareBul'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareBul'] to see the possible values for this operation

Return values

PromiseInterface

getCompareBulAsyncWithHttpInfo()

Operation getCompareBulAsyncWithHttpInfo


    public
                    getCompareBulAsyncWithHttpInfo(GetCompareBulRequest $get_compare_bul_request[, string $contentType = self::contentTypes['getCompareBul'][0] ]) : PromiseInterface

The changes between two Versions as BUL

Parameters

$get_compare_bul_request : GetCompareBulRequest: (required)
$contentType : string = self::contentTypes['getCompareBul'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareBul'] to see the possible values for this operation

Return values

PromiseInterface

getCompareBulRequest()

Create request for operation 'getCompareBul'


    public
                    getCompareBulRequest(GetCompareBulRequest $get_compare_bul_request[, string $contentType = self::contentTypes['getCompareBul'][0] ]) : Request

Parameters

$get_compare_bul_request : GetCompareBulRequest: (required)
$contentType : string = self::contentTypes['getCompareBul'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareBul'] to see the possible values for this operation

Return values

Request

getCompareBulWithHttpInfo()

Operation getCompareBulWithHttpInfo


    public
                    getCompareBulWithHttpInfo(GetCompareBulRequest $get_compare_bul_request[, string $contentType = self::contentTypes['getCompareBul'][0] ]) : array<string|int, mixed>

The changes between two Versions as BUL

Parameters

$get_compare_bul_request : GetCompareBulRequest: (required)
$contentType : string = self::contentTypes['getCompareBul'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareBul'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getCompareResult()

Operation getCompareResult


    public
                    getCompareResult(GetCompareResultRequest $get_compare_result_request[, string $contentType = self::contentTypes['getCompareResult'][0] ]) : CompareResult|ErrorResponse

Read a stored compare result

Parameters

$get_compare_result_request : GetCompareResultRequest: get_compare_result_request (required)
$contentType : string = self::contentTypes['getCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareResult'] to see the possible values for this operation

Return values

CompareResult|ErrorResponse

getCompareResultAsync()

Operation getCompareResultAsync


    public
                    getCompareResultAsync(GetCompareResultRequest $get_compare_result_request[, string $contentType = self::contentTypes['getCompareResult'][0] ]) : PromiseInterface

Read a stored compare result

Parameters

$get_compare_result_request : GetCompareResultRequest: (required)
$contentType : string = self::contentTypes['getCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareResult'] to see the possible values for this operation

Return values

PromiseInterface

getCompareResultAsyncWithHttpInfo()

Operation getCompareResultAsyncWithHttpInfo


    public
                    getCompareResultAsyncWithHttpInfo(GetCompareResultRequest $get_compare_result_request[, string $contentType = self::contentTypes['getCompareResult'][0] ]) : PromiseInterface

Read a stored compare result

Parameters

$get_compare_result_request : GetCompareResultRequest: (required)
$contentType : string = self::contentTypes['getCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareResult'] to see the possible values for this operation

Return values

PromiseInterface

getCompareResultRequest()

Create request for operation 'getCompareResult'


    public
                    getCompareResultRequest(GetCompareResultRequest $get_compare_result_request[, string $contentType = self::contentTypes['getCompareResult'][0] ]) : Request

Parameters

$get_compare_result_request : GetCompareResultRequest: (required)
$contentType : string = self::contentTypes['getCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareResult'] to see the possible values for this operation

Return values

Request

getCompareResultWithHttpInfo()

Operation getCompareResultWithHttpInfo


    public
                    getCompareResultWithHttpInfo(GetCompareResultRequest $get_compare_result_request[, string $contentType = self::contentTypes['getCompareResult'][0] ]) : array<string|int, mixed>

Read a stored compare result

Parameters

$get_compare_result_request : GetCompareResultRequest: (required)
$contentType : string = self::contentTypes['getCompareResult'][0]: The value for the Content-Type header. Check self::contentTypes['getCompareResult'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getMatchCandidates()

Operation getMatchCandidates


    public
                    getMatchCandidates(GetMatchCandidatesRequest $get_match_candidates_request[, string $contentType = self::contentTypes['getMatchCandidates'][0] ]) : MatchCandidates|ErrorResponse

The added objects that could be a removed object

Parameters

$get_match_candidates_request : GetMatchCandidatesRequest: get_match_candidates_request (required)
$contentType : string = self::contentTypes['getMatchCandidates'][0]: The value for the Content-Type header. Check self::contentTypes['getMatchCandidates'] to see the possible values for this operation

Return values

MatchCandidates|ErrorResponse

getMatchCandidatesAsync()

Operation getMatchCandidatesAsync


    public
                    getMatchCandidatesAsync(GetMatchCandidatesRequest $get_match_candidates_request[, string $contentType = self::contentTypes['getMatchCandidates'][0] ]) : PromiseInterface

The added objects that could be a removed object

Parameters

$get_match_candidates_request : GetMatchCandidatesRequest: (required)
$contentType : string = self::contentTypes['getMatchCandidates'][0]: The value for the Content-Type header. Check self::contentTypes['getMatchCandidates'] to see the possible values for this operation

Return values

PromiseInterface

getMatchCandidatesAsyncWithHttpInfo()

Operation getMatchCandidatesAsyncWithHttpInfo


    public
                    getMatchCandidatesAsyncWithHttpInfo(GetMatchCandidatesRequest $get_match_candidates_request[, string $contentType = self::contentTypes['getMatchCandidates'][0] ]) : PromiseInterface

The added objects that could be a removed object

Parameters

$get_match_candidates_request : GetMatchCandidatesRequest: (required)
$contentType : string = self::contentTypes['getMatchCandidates'][0]: The value for the Content-Type header. Check self::contentTypes['getMatchCandidates'] to see the possible values for this operation

Return values

PromiseInterface

getMatchCandidatesRequest()

Create request for operation 'getMatchCandidates'


    public
                    getMatchCandidatesRequest(GetMatchCandidatesRequest $get_match_candidates_request[, string $contentType = self::contentTypes['getMatchCandidates'][0] ]) : Request

Parameters

$get_match_candidates_request : GetMatchCandidatesRequest: (required)
$contentType : string = self::contentTypes['getMatchCandidates'][0]: The value for the Content-Type header. Check self::contentTypes['getMatchCandidates'] to see the possible values for this operation

Return values

Request

getMatchCandidatesWithHttpInfo()

Operation getMatchCandidatesWithHttpInfo


    public
                    getMatchCandidatesWithHttpInfo(GetMatchCandidatesRequest $get_match_candidates_request[, string $contentType = self::contentTypes['getMatchCandidates'][0] ]) : array<string|int, mixed>

The added objects that could be a removed object

Parameters

$get_match_candidates_request : GetMatchCandidatesRequest: (required)
$contentType : string = self::contentTypes['getMatchCandidates'][0]: The value for the Content-Type header. Check self::contentTypes['getMatchCandidates'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getObjectHistory()

Operation getObjectHistory


    public
                    getObjectHistory(GetObjectHistoryRequest $get_object_history_request[, string $contentType = self::contentTypes['getObjectHistory'][0] ]) : array<string, mixed>|ErrorResponse

The change history of one object

Parameters

$get_object_history_request : GetObjectHistoryRequest: get_object_history_request (required)
$contentType : string = self::contentTypes['getObjectHistory'][0]: The value for the Content-Type header. Check self::contentTypes['getObjectHistory'] to see the possible values for this operation

Return values

array<string, mixed>|ErrorResponse

getObjectHistoryAsync()

Operation getObjectHistoryAsync


    public
                    getObjectHistoryAsync(GetObjectHistoryRequest $get_object_history_request[, string $contentType = self::contentTypes['getObjectHistory'][0] ]) : PromiseInterface

The change history of one object

Parameters

$get_object_history_request : GetObjectHistoryRequest: (required)
$contentType : string = self::contentTypes['getObjectHistory'][0]: The value for the Content-Type header. Check self::contentTypes['getObjectHistory'] to see the possible values for this operation

Return values

PromiseInterface

getObjectHistoryAsyncWithHttpInfo()

Operation getObjectHistoryAsyncWithHttpInfo


    public
                    getObjectHistoryAsyncWithHttpInfo(GetObjectHistoryRequest $get_object_history_request[, string $contentType = self::contentTypes['getObjectHistory'][0] ]) : PromiseInterface

The change history of one object

Parameters

$get_object_history_request : GetObjectHistoryRequest: (required)
$contentType : string = self::contentTypes['getObjectHistory'][0]: The value for the Content-Type header. Check self::contentTypes['getObjectHistory'] to see the possible values for this operation

Return values

PromiseInterface

getObjectHistoryRequest()

Create request for operation 'getObjectHistory'


    public
                    getObjectHistoryRequest(GetObjectHistoryRequest $get_object_history_request[, string $contentType = self::contentTypes['getObjectHistory'][0] ]) : Request

Parameters

$get_object_history_request : GetObjectHistoryRequest: (required)
$contentType : string = self::contentTypes['getObjectHistory'][0]: The value for the Content-Type header. Check self::contentTypes['getObjectHistory'] to see the possible values for this operation

Return values

Request

getObjectHistoryWithHttpInfo()

Operation getObjectHistoryWithHttpInfo


    public
                    getObjectHistoryWithHttpInfo(GetObjectHistoryRequest $get_object_history_request[, string $contentType = self::contentTypes['getObjectHistory'][0] ]) : array<string|int, mixed>

The change history of one object

Parameters

$get_object_history_request : GetObjectHistoryRequest: (required)
$contentType : string = self::contentTypes['getObjectHistory'][0]: The value for the Content-Type header. Check self::contentTypes['getObjectHistory'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getVersionChanges()

Operation getVersionChanges


    public
                    getVersionChanges(GetVersionChangesRequest $get_version_changes_request[, string $contentType = self::contentTypes['getVersionChanges'][0] ]) : VersionChangesResult|ErrorResponse

What changed in Versions since the Versions before them

Parameters

$get_version_changes_request : GetVersionChangesRequest: get_version_changes_request (required)
$contentType : string = self::contentTypes['getVersionChanges'][0]: The value for the Content-Type header. Check self::contentTypes['getVersionChanges'] to see the possible values for this operation

Return values

VersionChangesResult|ErrorResponse

getVersionChangesAsync()

Operation getVersionChangesAsync


    public
                    getVersionChangesAsync(GetVersionChangesRequest $get_version_changes_request[, string $contentType = self::contentTypes['getVersionChanges'][0] ]) : PromiseInterface

What changed in Versions since the Versions before them

Parameters

$get_version_changes_request : GetVersionChangesRequest: (required)
$contentType : string = self::contentTypes['getVersionChanges'][0]: The value for the Content-Type header. Check self::contentTypes['getVersionChanges'] to see the possible values for this operation

Return values

PromiseInterface

getVersionChangesAsyncWithHttpInfo()

Operation getVersionChangesAsyncWithHttpInfo


    public
                    getVersionChangesAsyncWithHttpInfo(GetVersionChangesRequest $get_version_changes_request[, string $contentType = self::contentTypes['getVersionChanges'][0] ]) : PromiseInterface

What changed in Versions since the Versions before them

Parameters

$get_version_changes_request : GetVersionChangesRequest: (required)
$contentType : string = self::contentTypes['getVersionChanges'][0]: The value for the Content-Type header. Check self::contentTypes['getVersionChanges'] to see the possible values for this operation

Return values

PromiseInterface

getVersionChangesRequest()

Create request for operation 'getVersionChanges'


    public
                    getVersionChangesRequest(GetVersionChangesRequest $get_version_changes_request[, string $contentType = self::contentTypes['getVersionChanges'][0] ]) : Request

Parameters

$get_version_changes_request : GetVersionChangesRequest: (required)
$contentType : string = self::contentTypes['getVersionChanges'][0]: The value for the Content-Type header. Check self::contentTypes['getVersionChanges'] to see the possible values for this operation

Return values

Request

getVersionChangesWithHttpInfo()

Operation getVersionChangesWithHttpInfo


    public
                    getVersionChangesWithHttpInfo(GetVersionChangesRequest $get_version_changes_request[, string $contentType = self::contentTypes['getVersionChanges'][0] ]) : array<string|int, mixed>

What changed in Versions since the Versions before them

Parameters

$get_version_changes_request : GetVersionChangesRequest: (required)
$contentType : string = self::contentTypes['getVersionChanges'][0]: The value for the Content-Type header. Check self::contentTypes['getVersionChanges'] to see the possible values for this operation

Return values

array<string|int, mixed> —

listBuildingStoreys()

Operation listBuildingStoreys


    public
                    listBuildingStoreys(ListBuildingStoreysRequest $list_building_storeys_request[, string $contentType = self::contentTypes['listBuildingStoreys'][0] ]) : BuildingStoreys|ErrorResponse

The building storeys of one or more models

Parameters

$list_building_storeys_request : ListBuildingStoreysRequest: list_building_storeys_request (required)
$contentType : string = self::contentTypes['listBuildingStoreys'][0]: The value for the Content-Type header. Check self::contentTypes['listBuildingStoreys'] to see the possible values for this operation

Return values

BuildingStoreys|ErrorResponse

listBuildingStoreysAsync()

Operation listBuildingStoreysAsync


    public
                    listBuildingStoreysAsync(ListBuildingStoreysRequest $list_building_storeys_request[, string $contentType = self::contentTypes['listBuildingStoreys'][0] ]) : PromiseInterface

The building storeys of one or more models

Parameters

$list_building_storeys_request : ListBuildingStoreysRequest: (required)
$contentType : string = self::contentTypes['listBuildingStoreys'][0]: The value for the Content-Type header. Check self::contentTypes['listBuildingStoreys'] to see the possible values for this operation

Return values

PromiseInterface

listBuildingStoreysAsyncWithHttpInfo()

Operation listBuildingStoreysAsyncWithHttpInfo


    public
                    listBuildingStoreysAsyncWithHttpInfo(ListBuildingStoreysRequest $list_building_storeys_request[, string $contentType = self::contentTypes['listBuildingStoreys'][0] ]) : PromiseInterface

The building storeys of one or more models

Parameters

$list_building_storeys_request : ListBuildingStoreysRequest: (required)
$contentType : string = self::contentTypes['listBuildingStoreys'][0]: The value for the Content-Type header. Check self::contentTypes['listBuildingStoreys'] to see the possible values for this operation

Return values

PromiseInterface

listBuildingStoreysRequest()

Create request for operation 'listBuildingStoreys'


    public
                    listBuildingStoreysRequest(ListBuildingStoreysRequest $list_building_storeys_request[, string $contentType = self::contentTypes['listBuildingStoreys'][0] ]) : Request

Parameters

$list_building_storeys_request : ListBuildingStoreysRequest: (required)
$contentType : string = self::contentTypes['listBuildingStoreys'][0]: The value for the Content-Type header. Check self::contentTypes['listBuildingStoreys'] to see the possible values for this operation

Return values

Request

listBuildingStoreysWithHttpInfo()

Operation listBuildingStoreysWithHttpInfo


    public
                    listBuildingStoreysWithHttpInfo(ListBuildingStoreysRequest $list_building_storeys_request[, string $contentType = self::contentTypes['listBuildingStoreys'][0] ]) : array<string|int, mixed>

The building storeys of one or more models

Parameters

$list_building_storeys_request : ListBuildingStoreysRequest: (required)
$contentType : string = self::contentTypes['listBuildingStoreys'][0]: The value for the Content-Type header. Check self::contentTypes['listBuildingStoreys'] to see the possible values for this operation

Return values

array<string|int, mixed> —

listComparePairOverrides()

Operation listComparePairOverrides


    public
                    listComparePairOverrides(ListComparePairOverridesRequest $list_compare_pair_overrides_request[, string $contentType = self::contentTypes['listComparePairOverrides'][0] ]) : ComparePairOverrides|ErrorResponse

The pairs fixed by hand for two Versions

Parameters

$list_compare_pair_overrides_request : ListComparePairOverridesRequest: list_compare_pair_overrides_request (required)
$contentType : string = self::contentTypes['listComparePairOverrides'][0]: The value for the Content-Type header. Check self::contentTypes['listComparePairOverrides'] to see the possible values for this operation

Return values

ComparePairOverrides|ErrorResponse

listComparePairOverridesAsync()

Operation listComparePairOverridesAsync


    public
                    listComparePairOverridesAsync(ListComparePairOverridesRequest $list_compare_pair_overrides_request[, string $contentType = self::contentTypes['listComparePairOverrides'][0] ]) : PromiseInterface

The pairs fixed by hand for two Versions

Parameters

$list_compare_pair_overrides_request : ListComparePairOverridesRequest: (required)
$contentType : string = self::contentTypes['listComparePairOverrides'][0]: The value for the Content-Type header. Check self::contentTypes['listComparePairOverrides'] to see the possible values for this operation

Return values

PromiseInterface

listComparePairOverridesAsyncWithHttpInfo()

Operation listComparePairOverridesAsyncWithHttpInfo


    public
                    listComparePairOverridesAsyncWithHttpInfo(ListComparePairOverridesRequest $list_compare_pair_overrides_request[, string $contentType = self::contentTypes['listComparePairOverrides'][0] ]) : PromiseInterface

The pairs fixed by hand for two Versions

Parameters

$list_compare_pair_overrides_request : ListComparePairOverridesRequest: (required)
$contentType : string = self::contentTypes['listComparePairOverrides'][0]: The value for the Content-Type header. Check self::contentTypes['listComparePairOverrides'] to see the possible values for this operation

Return values

PromiseInterface

listComparePairOverridesRequest()

Create request for operation 'listComparePairOverrides'


    public
                    listComparePairOverridesRequest(ListComparePairOverridesRequest $list_compare_pair_overrides_request[, string $contentType = self::contentTypes['listComparePairOverrides'][0] ]) : Request

Parameters

$list_compare_pair_overrides_request : ListComparePairOverridesRequest: (required)
$contentType : string = self::contentTypes['listComparePairOverrides'][0]: The value for the Content-Type header. Check self::contentTypes['listComparePairOverrides'] to see the possible values for this operation

Return values

Request

listComparePairOverridesWithHttpInfo()

Operation listComparePairOverridesWithHttpInfo


    public
                    listComparePairOverridesWithHttpInfo(ListComparePairOverridesRequest $list_compare_pair_overrides_request[, string $contentType = self::contentTypes['listComparePairOverrides'][0] ]) : array<string|int, mixed>

The pairs fixed by hand for two Versions

Parameters

$list_compare_pair_overrides_request : ListComparePairOverridesRequest: (required)
$contentType : string = self::contentTypes['listComparePairOverrides'][0]: The value for the Content-Type header. Check self::contentTypes['listComparePairOverrides'] to see the possible values for this operation

Return values

array<string|int, mixed> —

mapQids()

Operation mapQids


    public
                    mapQids(MapQidsRequest $map_qids_request[, string $contentType = self::contentTypes['mapQids'][0] ]) : MapQidsResult|ErrorResponse

Map objects of one Version to their counterparts in another

Parameters

$map_qids_request : MapQidsRequest: map_qids_request (required)
$contentType : string = self::contentTypes['mapQids'][0]: The value for the Content-Type header. Check self::contentTypes['mapQids'] to see the possible values for this operation

Return values

MapQidsResult|ErrorResponse

mapQidsAsync()

Operation mapQidsAsync


    public
                    mapQidsAsync(MapQidsRequest $map_qids_request[, string $contentType = self::contentTypes['mapQids'][0] ]) : PromiseInterface

Map objects of one Version to their counterparts in another

Parameters

$map_qids_request : MapQidsRequest: (required)
$contentType : string = self::contentTypes['mapQids'][0]: The value for the Content-Type header. Check self::contentTypes['mapQids'] to see the possible values for this operation

Return values

PromiseInterface

mapQidsAsyncWithHttpInfo()

Operation mapQidsAsyncWithHttpInfo


    public
                    mapQidsAsyncWithHttpInfo(MapQidsRequest $map_qids_request[, string $contentType = self::contentTypes['mapQids'][0] ]) : PromiseInterface

Map objects of one Version to their counterparts in another

Parameters

$map_qids_request : MapQidsRequest: (required)
$contentType : string = self::contentTypes['mapQids'][0]: The value for the Content-Type header. Check self::contentTypes['mapQids'] to see the possible values for this operation

Return values

PromiseInterface

mapQidsRequest()

Create request for operation 'mapQids'


    public
                    mapQidsRequest(MapQidsRequest $map_qids_request[, string $contentType = self::contentTypes['mapQids'][0] ]) : Request

Parameters

$map_qids_request : MapQidsRequest: (required)
$contentType : string = self::contentTypes['mapQids'][0]: The value for the Content-Type header. Check self::contentTypes['mapQids'] to see the possible values for this operation

Return values

Request

mapQidsWithHttpInfo()

Operation mapQidsWithHttpInfo


    public
                    mapQidsWithHttpInfo(MapQidsRequest $map_qids_request[, string $contentType = self::contentTypes['mapQids'][0] ]) : array<string|int, mixed>

Map objects of one Version to their counterparts in another

Parameters

$map_qids_request : MapQidsRequest: (required)
$contentType : string = self::contentTypes['mapQids'][0]: The value for the Content-Type header. Check self::contentTypes['mapQids'] to see the possible values for this operation

Return values

array<string|int, mixed> —

parseQuery()

Operation parseQuery


    public
                    parseQuery(ParseQueryRequest $parse_query_request[, string $contentType = self::contentTypes['parseQuery'][0] ]) : array<string, mixed>|ErrorResponse

Parse a BQL query into its syntax tree

Parameters

$parse_query_request : ParseQueryRequest: parse_query_request (required)
$contentType : string = self::contentTypes['parseQuery'][0]: The value for the Content-Type header. Check self::contentTypes['parseQuery'] to see the possible values for this operation

Return values

array<string, mixed>|ErrorResponse

parseQueryAsync()

Operation parseQueryAsync


    public
                    parseQueryAsync(ParseQueryRequest $parse_query_request[, string $contentType = self::contentTypes['parseQuery'][0] ]) : PromiseInterface

Parse a BQL query into its syntax tree

Parameters

$parse_query_request : ParseQueryRequest: (required)
$contentType : string = self::contentTypes['parseQuery'][0]: The value for the Content-Type header. Check self::contentTypes['parseQuery'] to see the possible values for this operation

Return values

PromiseInterface

parseQueryAsyncWithHttpInfo()

Operation parseQueryAsyncWithHttpInfo


    public
                    parseQueryAsyncWithHttpInfo(ParseQueryRequest $parse_query_request[, string $contentType = self::contentTypes['parseQuery'][0] ]) : PromiseInterface

Parse a BQL query into its syntax tree

Parameters

$parse_query_request : ParseQueryRequest: (required)
$contentType : string = self::contentTypes['parseQuery'][0]: The value for the Content-Type header. Check self::contentTypes['parseQuery'] to see the possible values for this operation

Return values

PromiseInterface

parseQueryRequest()

Create request for operation 'parseQuery'


    public
                    parseQueryRequest(ParseQueryRequest $parse_query_request[, string $contentType = self::contentTypes['parseQuery'][0] ]) : Request

Parameters

$parse_query_request : ParseQueryRequest: (required)
$contentType : string = self::contentTypes['parseQuery'][0]: The value for the Content-Type header. Check self::contentTypes['parseQuery'] to see the possible values for this operation

Return values

Request

parseQueryWithHttpInfo()

Operation parseQueryWithHttpInfo


    public
                    parseQueryWithHttpInfo(ParseQueryRequest $parse_query_request[, string $contentType = self::contentTypes['parseQuery'][0] ]) : array<string|int, mixed>

Parse a BQL query into its syntax tree

Parameters

$parse_query_request : ParseQueryRequest: (required)
$contentType : string = self::contentTypes['parseQuery'][0]: The value for the Content-Type header. Check self::contentTypes['parseQuery'] to see the possible values for this operation

Return values

array<string|int, mixed> —

query()

Operation query


    public
                    query(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : mixed|ErrorResponse

Query one or more IFC models

Parameters

$query_request : QueryRequest: query_request (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

mixed|ErrorResponse

queryAsync()

Operation queryAsync


    public
                    queryAsync(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : PromiseInterface

Query one or more IFC models

Parameters

$query_request : QueryRequest: (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

PromiseInterface

queryAsyncWithHttpInfo()

Operation queryAsyncWithHttpInfo


    public
                    queryAsyncWithHttpInfo(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : PromiseInterface

Query one or more IFC models

Parameters

$query_request : QueryRequest: (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

PromiseInterface

queryRequest()

Create request for operation 'query'


    public
                    queryRequest(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : Request

Parameters

$query_request : QueryRequest: (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

Request

queryWithHttpInfo()

Operation queryWithHttpInfo


    public
                    queryWithHttpInfo(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : array<string|int, mixed>

Query one or more IFC models

Parameters

$query_request : QueryRequest: (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

array<string|int, mixed> —

recordUploadAsTransaction()

Operation recordUploadAsTransaction


    public
                    recordUploadAsTransaction(RecordUploadAsTransactionRequest $record_upload_as_transaction_request[, string $contentType = self::contentTypes['recordUploadAsTransaction'][0] ]) : RecordUploadAsTransactionResult|ErrorResponse

Replace an upload by a transaction with the same changes

Parameters

$record_upload_as_transaction_request : RecordUploadAsTransactionRequest: record_upload_as_transaction_request (required)
$contentType : string = self::contentTypes['recordUploadAsTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['recordUploadAsTransaction'] to see the possible values for this operation

Return values

RecordUploadAsTransactionResult|ErrorResponse

recordUploadAsTransactionAsync()

Operation recordUploadAsTransactionAsync


    public
                    recordUploadAsTransactionAsync(RecordUploadAsTransactionRequest $record_upload_as_transaction_request[, string $contentType = self::contentTypes['recordUploadAsTransaction'][0] ]) : PromiseInterface

Replace an upload by a transaction with the same changes

Parameters

$record_upload_as_transaction_request : RecordUploadAsTransactionRequest: (required)
$contentType : string = self::contentTypes['recordUploadAsTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['recordUploadAsTransaction'] to see the possible values for this operation

Return values

PromiseInterface

recordUploadAsTransactionAsyncWithHttpInfo()

Operation recordUploadAsTransactionAsyncWithHttpInfo


    public
                    recordUploadAsTransactionAsyncWithHttpInfo(RecordUploadAsTransactionRequest $record_upload_as_transaction_request[, string $contentType = self::contentTypes['recordUploadAsTransaction'][0] ]) : PromiseInterface

Replace an upload by a transaction with the same changes

Parameters

$record_upload_as_transaction_request : RecordUploadAsTransactionRequest: (required)
$contentType : string = self::contentTypes['recordUploadAsTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['recordUploadAsTransaction'] to see the possible values for this operation

Return values

PromiseInterface

recordUploadAsTransactionRequest()

Create request for operation 'recordUploadAsTransaction'


    public
                    recordUploadAsTransactionRequest(RecordUploadAsTransactionRequest $record_upload_as_transaction_request[, string $contentType = self::contentTypes['recordUploadAsTransaction'][0] ]) : Request

Parameters

$record_upload_as_transaction_request : RecordUploadAsTransactionRequest: (required)
$contentType : string = self::contentTypes['recordUploadAsTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['recordUploadAsTransaction'] to see the possible values for this operation

Return values

Request

recordUploadAsTransactionWithHttpInfo()

Operation recordUploadAsTransactionWithHttpInfo


    public
                    recordUploadAsTransactionWithHttpInfo(RecordUploadAsTransactionRequest $record_upload_as_transaction_request[, string $contentType = self::contentTypes['recordUploadAsTransaction'][0] ]) : array<string|int, mixed>

Replace an upload by a transaction with the same changes

Parameters

$record_upload_as_transaction_request : RecordUploadAsTransactionRequest: (required)
$contentType : string = self::contentTypes['recordUploadAsTransaction'][0]: The value for the Content-Type header. Check self::contentTypes['recordUploadAsTransaction'] to see the possible values for this operation

Return values

array<string|int, mixed> —

resolveBvl()

Operation resolveBvl


    public
                    resolveBvl(ResolveBvlRequest $resolve_bvl_request[, string $contentType = self::contentTypes['resolveBvl'][0] ]) : ResolvedActions|ErrorResponse

Resolve a BVL script to what it shows, hides, selects and colours

Parameters

$resolve_bvl_request : ResolveBvlRequest: resolve_bvl_request (required)
$contentType : string = self::contentTypes['resolveBvl'][0]: The value for the Content-Type header. Check self::contentTypes['resolveBvl'] to see the possible values for this operation

Return values

ResolvedActions|ErrorResponse

resolveBvlAsync()

Operation resolveBvlAsync


    public
                    resolveBvlAsync(ResolveBvlRequest $resolve_bvl_request[, string $contentType = self::contentTypes['resolveBvl'][0] ]) : PromiseInterface

Resolve a BVL script to what it shows, hides, selects and colours

Parameters

$resolve_bvl_request : ResolveBvlRequest: (required)
$contentType : string = self::contentTypes['resolveBvl'][0]: The value for the Content-Type header. Check self::contentTypes['resolveBvl'] to see the possible values for this operation

Return values

PromiseInterface

resolveBvlAsyncWithHttpInfo()

Operation resolveBvlAsyncWithHttpInfo


    public
                    resolveBvlAsyncWithHttpInfo(ResolveBvlRequest $resolve_bvl_request[, string $contentType = self::contentTypes['resolveBvl'][0] ]) : PromiseInterface

Resolve a BVL script to what it shows, hides, selects and colours

Parameters

$resolve_bvl_request : ResolveBvlRequest: (required)
$contentType : string = self::contentTypes['resolveBvl'][0]: The value for the Content-Type header. Check self::contentTypes['resolveBvl'] to see the possible values for this operation

Return values

PromiseInterface

resolveBvlRequest()

Create request for operation 'resolveBvl'


    public
                    resolveBvlRequest(ResolveBvlRequest $resolve_bvl_request[, string $contentType = self::contentTypes['resolveBvl'][0] ]) : Request

Parameters

$resolve_bvl_request : ResolveBvlRequest: (required)
$contentType : string = self::contentTypes['resolveBvl'][0]: The value for the Content-Type header. Check self::contentTypes['resolveBvl'] to see the possible values for this operation

Return values

Request

resolveBvlWithHttpInfo()

Operation resolveBvlWithHttpInfo


    public
                    resolveBvlWithHttpInfo(ResolveBvlRequest $resolve_bvl_request[, string $contentType = self::contentTypes['resolveBvl'][0] ]) : array<string|int, mixed>

Resolve a BVL script to what it shows, hides, selects and colours

Parameters

$resolve_bvl_request : ResolveBvlRequest: (required)
$contentType : string = self::contentTypes['resolveBvl'][0]: The value for the Content-Type header. Check self::contentTypes['resolveBvl'] to see the possible values for this operation

Return values

array<string|int, mixed> —

setComparePairOverride()

Operation setComparePairOverride


    public
                    setComparePairOverride(SetComparePairOverrideRequest $set_compare_pair_override_request[, string $contentType = self::contentTypes['setComparePairOverride'][0] ]) : ComparePairOverrideSet|ErrorResponse

Fix a pair by hand for two Versions

Parameters

$set_compare_pair_override_request : SetComparePairOverrideRequest: set_compare_pair_override_request (required)
$contentType : string = self::contentTypes['setComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['setComparePairOverride'] to see the possible values for this operation

Return values

ComparePairOverrideSet|ErrorResponse

setComparePairOverrideAsync()

Operation setComparePairOverrideAsync


    public
                    setComparePairOverrideAsync(SetComparePairOverrideRequest $set_compare_pair_override_request[, string $contentType = self::contentTypes['setComparePairOverride'][0] ]) : PromiseInterface

Fix a pair by hand for two Versions

Parameters

$set_compare_pair_override_request : SetComparePairOverrideRequest: (required)
$contentType : string = self::contentTypes['setComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['setComparePairOverride'] to see the possible values for this operation

Return values

PromiseInterface

setComparePairOverrideAsyncWithHttpInfo()

Operation setComparePairOverrideAsyncWithHttpInfo


    public
                    setComparePairOverrideAsyncWithHttpInfo(SetComparePairOverrideRequest $set_compare_pair_override_request[, string $contentType = self::contentTypes['setComparePairOverride'][0] ]) : PromiseInterface

Fix a pair by hand for two Versions

Parameters

$set_compare_pair_override_request : SetComparePairOverrideRequest: (required)
$contentType : string = self::contentTypes['setComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['setComparePairOverride'] to see the possible values for this operation

Return values

PromiseInterface

setComparePairOverrideRequest()

Create request for operation 'setComparePairOverride'


    public
                    setComparePairOverrideRequest(SetComparePairOverrideRequest $set_compare_pair_override_request[, string $contentType = self::contentTypes['setComparePairOverride'][0] ]) : Request

Parameters

$set_compare_pair_override_request : SetComparePairOverrideRequest: (required)
$contentType : string = self::contentTypes['setComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['setComparePairOverride'] to see the possible values for this operation

Return values

Request

setComparePairOverrideWithHttpInfo()

Operation setComparePairOverrideWithHttpInfo


    public
                    setComparePairOverrideWithHttpInfo(SetComparePairOverrideRequest $set_compare_pair_override_request[, string $contentType = self::contentTypes['setComparePairOverride'][0] ]) : array<string|int, mixed>

Fix a pair by hand for two Versions

Parameters

$set_compare_pair_override_request : SetComparePairOverrideRequest: (required)
$contentType : string = self::contentTypes['setComparePairOverride'][0]: The value for the Content-Type header. Check self::contentTypes['setComparePairOverride'] to see the possible values for this operation

Return values

array<string|int, mixed> —

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

textSearch()

Operation textSearch


    public
                    textSearch(TextSearchRequest $text_search_request[, string $contentType = self::contentTypes['textSearch'][0] ]) : TextSearchResult|ErrorResponse

Free-text search in models

Parameters

$text_search_request : TextSearchRequest: text_search_request (required)
$contentType : string = self::contentTypes['textSearch'][0]: The value for the Content-Type header. Check self::contentTypes['textSearch'] to see the possible values for this operation

Return values

TextSearchResult|ErrorResponse

textSearchAsync()

Operation textSearchAsync


    public
                    textSearchAsync(TextSearchRequest $text_search_request[, string $contentType = self::contentTypes['textSearch'][0] ]) : PromiseInterface

Free-text search in models

Parameters

$text_search_request : TextSearchRequest: (required)
$contentType : string = self::contentTypes['textSearch'][0]: The value for the Content-Type header. Check self::contentTypes['textSearch'] to see the possible values for this operation

Return values

PromiseInterface

textSearchAsyncWithHttpInfo()

Operation textSearchAsyncWithHttpInfo


    public
                    textSearchAsyncWithHttpInfo(TextSearchRequest $text_search_request[, string $contentType = self::contentTypes['textSearch'][0] ]) : PromiseInterface

Free-text search in models

Parameters

$text_search_request : TextSearchRequest: (required)
$contentType : string = self::contentTypes['textSearch'][0]: The value for the Content-Type header. Check self::contentTypes['textSearch'] to see the possible values for this operation

Return values

PromiseInterface

textSearchRequest()

Create request for operation 'textSearch'


    public
                    textSearchRequest(TextSearchRequest $text_search_request[, string $contentType = self::contentTypes['textSearch'][0] ]) : Request

Parameters

$text_search_request : TextSearchRequest: (required)
$contentType : string = self::contentTypes['textSearch'][0]: The value for the Content-Type header. Check self::contentTypes['textSearch'] to see the possible values for this operation

Return values

Request

textSearchWithHttpInfo()

Operation textSearchWithHttpInfo


    public
                    textSearchWithHttpInfo(TextSearchRequest $text_search_request[, string $contentType = self::contentTypes['textSearch'][0] ]) : array<string|int, mixed>

Free-text search in models

Parameters

$text_search_request : TextSearchRequest: (required)
$contentType : string = self::contentTypes['textSearch'][0]: The value for the Content-Type header. Check self::contentTypes['textSearch'] to see the possible values for this operation

Return values

array<string|int, mixed> —

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

IFCApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

check()

Parameters

Tags

Return values

checkAsync()

Parameters

Tags

Return values

checkAsyncWithHttpInfo()

Parameters

Tags

Return values

checkRequest()

Parameters

Tags

Return values

checkWithHttpInfo()

Parameters

Tags

Return values

commitTransaction()

Parameters

Tags

Return values

commitTransactionAsync()

Parameters

Tags

Return values

commitTransactionAsyncWithHttpInfo()

Parameters

Tags

Return values

commitTransactionRequest()

Parameters

Tags

Return values

commitTransactionWithHttpInfo()

Parameters

Tags

Return values

compareModels()

Parameters

Tags

Return values

compareModelsAsync()

Parameters

Tags

Return values

compareModelsAsyncWithHttpInfo()

Parameters

Tags

Return values

compareModelsRequest()

Parameters

Tags

Return values

compareModelsWithHttpInfo()

Parameters

Tags

Return values

compareObjects()

Parameters

Tags

Return values

IFCApi
in package

BIMworks