Documentation

ModelApi
in package

BIMworks

ModelApi Class Doc Comment

Constants

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

Properties

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

Methods

__construct() : mixed
addModelWithUrl() : BIMworksModelVersion|CheckinStatus|ErrorResponse: Operation addModelWithUrl
addModelWithUrlAsync() : PromiseInterface: Operation addModelWithUrlAsync
addModelWithUrlAsyncWithHttpInfo() : PromiseInterface: Operation addModelWithUrlAsyncWithHttpInfo
addModelWithUrlRequest() : Request: Create request for operation 'addModelWithUrl'
addModelWithUrlWithHttpInfo() : array<string|int, mixed>: Operation addModelWithUrlWithHttpInfo
augmentBcf() : SplFileObject|ErrorResponse: Operation augmentBcf
augmentBcfAsync() : PromiseInterface: Operation augmentBcfAsync
augmentBcfAsyncWithHttpInfo() : PromiseInterface: Operation augmentBcfAsyncWithHttpInfo
augmentBcfRequest() : Request: Create request for operation 'augmentBcf'
augmentBcfWithHttpInfo() : array<string|int, mixed>: Operation augmentBcfWithHttpInfo
download() : SplFileObject|ErrorResponse: Operation download
downloadAsync() : PromiseInterface: Operation downloadAsync
downloadAsyncWithHttpInfo() : PromiseInterface: Operation downloadAsyncWithHttpInfo
downloadIfcXml() : SplFileObject|ErrorResponse: Operation downloadIfcXml
downloadIfcXmlAsync() : PromiseInterface: Operation downloadIfcXmlAsync
downloadIfcXmlAsyncWithHttpInfo() : PromiseInterface: Operation downloadIfcXmlAsyncWithHttpInfo
downloadIfcXmlRequest() : Request: Create request for operation 'downloadIfcXml'
downloadIfcXmlWithHttpInfo() : array<string|int, mixed>: Operation downloadIfcXmlWithHttpInfo
downloadRequest() : Request: Create request for operation 'download'
downloadWithHttpInfo() : array<string|int, mixed>: Operation downloadWithHttpInfo
exportGeometry() : SplFileObject|ErrorResponse: Operation exportGeometry
exportGeometryAsync() : PromiseInterface: Operation exportGeometryAsync
exportGeometryAsyncWithHttpInfo() : PromiseInterface: Operation exportGeometryAsyncWithHttpInfo
exportGeometryRequest() : Request: Create request for operation 'exportGeometry'
exportGeometryWithHttpInfo() : array<string|int, mixed>: Operation exportGeometryWithHttpInfo
exportVectorSvg() : SplFileObject|ErrorResponse: Operation exportVectorSvg
exportVectorSvgAsync() : PromiseInterface: Operation exportVectorSvgAsync
exportVectorSvgAsyncWithHttpInfo() : PromiseInterface: Operation exportVectorSvgAsyncWithHttpInfo
exportVectorSvgRequest() : Request: Create request for operation 'exportVectorSvg'
exportVectorSvgWithHttpInfo() : array<string|int, mixed>: Operation exportVectorSvgWithHttpInfo
getCheckin() : CheckinStatus|ErrorResponse: Operation getCheckin
getCheckinAsync() : PromiseInterface: Operation getCheckinAsync
getCheckinAsyncWithHttpInfo() : PromiseInterface: Operation getCheckinAsyncWithHttpInfo
getCheckinRequest() : Request: Create request for operation 'getCheckin'
getCheckinWithHttpInfo() : array<string|int, mixed>: Operation getCheckinWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
getValidationReport() : ValidationReportResult|ErrorResponse: Operation getValidationReport
getValidationReportAsync() : PromiseInterface: Operation getValidationReportAsync
getValidationReportAsyncWithHttpInfo() : PromiseInterface: Operation getValidationReportAsyncWithHttpInfo
getValidationReportRequest() : Request: Create request for operation 'getValidationReport'
getValidationReportWithHttpInfo() : array<string|int, mixed>: Operation getValidationReportWithHttpInfo
lookupModelHashes() : LookupModelHashes200Response|ErrorResponse: Operation lookupModelHashes
lookupModelHashesAsync() : PromiseInterface: Operation lookupModelHashesAsync
lookupModelHashesAsyncWithHttpInfo() : PromiseInterface: Operation lookupModelHashesAsyncWithHttpInfo
lookupModelHashesRequest() : Request: Create request for operation 'lookupModelHashes'
lookupModelHashesWithHttpInfo() : array<string|int, mixed>: Operation lookupModelHashesWithHttpInfo
render() : SplFileObject|ErrorResponse: Operation render
renderAsync() : PromiseInterface: Operation renderAsync
renderAsyncWithHttpInfo() : PromiseInterface: Operation renderAsyncWithHttpInfo
renderRequest() : Request: Create request for operation 'render'
renderWithHttpInfo() : array<string|int, mixed>: Operation renderWithHttpInfo
schemaConversionReport() : SchemaConversionReportResponse|ErrorResponse: Operation schemaConversionReport
schemaConversionReportAsync() : PromiseInterface: Operation schemaConversionReportAsync
schemaConversionReportAsyncWithHttpInfo() : PromiseInterface: Operation schemaConversionReportAsyncWithHttpInfo
schemaConversionReportRequest() : Request: Create request for operation 'schemaConversionReport'
schemaConversionReportWithHttpInfo() : array<string|int, mixed>: Operation schemaConversionReportWithHttpInfo
setHostIndex() : void: Set the host index
uploadModel() : BIMworksModelVersion|CheckinStatus|ErrorResponse: Operation uploadModel
uploadModelAsync() : PromiseInterface: Operation uploadModelAsync
uploadModelAsyncWithHttpInfo() : PromiseInterface: Operation uploadModelAsyncWithHttpInfo
uploadModelRequest() : Request: Create request for operation 'uploadModel'
uploadModelWithHttpInfo() : array<string|int, mixed>: Operation uploadModelWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['addModelWithUrl' => ['application/json'], 'augmentBcf' => ['multipart/form-data'], 'download' => ['application/json'], 'downloadIfcXml' => ['application/json'], 'exportGeometry' => ['application/json'], 'exportVectorSvg' => ['application/json'], 'getCheckin' => ['application/json'], 'getValidationReport' => ['application/json'], 'lookupModelHashes' => ['application/json'], 'render' => ['application/json'], 'schemaConversionReport' => ['application/json'], 'uploadModel' => ['multipart/form-data']]

$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

addModelWithUrl()

Operation addModelWithUrl


    public
                    addModelWithUrl(AddModelWithUrlRequest $add_model_with_url_request[, string $contentType = self::contentTypes['addModelWithUrl'][0] ]) : BIMworksModelVersion|CheckinStatus|ErrorResponse

Add a new model by providing a URL

Parameters

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

Return values

BIMworksModelVersion|CheckinStatus|ErrorResponse

addModelWithUrlAsync()

Operation addModelWithUrlAsync


    public
                    addModelWithUrlAsync(AddModelWithUrlRequest $add_model_with_url_request[, string $contentType = self::contentTypes['addModelWithUrl'][0] ]) : PromiseInterface

Add a new model by providing a URL

Parameters

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

Return values

PromiseInterface

addModelWithUrlAsyncWithHttpInfo()

Operation addModelWithUrlAsyncWithHttpInfo


    public
                    addModelWithUrlAsyncWithHttpInfo(AddModelWithUrlRequest $add_model_with_url_request[, string $contentType = self::contentTypes['addModelWithUrl'][0] ]) : PromiseInterface

Add a new model by providing a URL

Parameters

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

Return values

PromiseInterface

addModelWithUrlRequest()

Create request for operation 'addModelWithUrl'


    public
                    addModelWithUrlRequest(AddModelWithUrlRequest $add_model_with_url_request[, string $contentType = self::contentTypes['addModelWithUrl'][0] ]) : Request

Parameters

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

Return values

Request

addModelWithUrlWithHttpInfo()

Operation addModelWithUrlWithHttpInfo


    public
                    addModelWithUrlWithHttpInfo(AddModelWithUrlRequest $add_model_with_url_request[, string $contentType = self::contentTypes['addModelWithUrl'][0] ]) : array<string|int, mixed>

Add a new model by providing a URL

Parameters

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

Return values

array<string|int, mixed> —

augmentBcf()

Operation augmentBcf


    public
                    augmentBcf(SplFileObject $bcf, string $version_uuid[, int|null $width = null ][, int|null $height = null ][, string $contentType = self::contentTypes['augmentBcf'][0] ]) : SplFileObject|ErrorResponse

Add snapshots to a BCF

Parameters

$bcf : SplFileObject: The BCF 2.1 file (required)
$version_uuid : string: version_uuid (required)
$width : int|null = null: The snapshots' width in pixels, 300 when absent (optional)
$height : int|null = null: The snapshots' height in pixels, 300 when absent (optional)
$contentType : string = self::contentTypes['augmentBcf'][0]: The value for the Content-Type header. Check self::contentTypes['augmentBcf'] to see the possible values for this operation

Return values

SplFileObject|ErrorResponse

augmentBcfAsync()

Operation augmentBcfAsync


    public
                    augmentBcfAsync(SplFileObject $bcf, string $version_uuid[, int|null $width = null ][, int|null $height = null ][, string $contentType = self::contentTypes['augmentBcf'][0] ]) : PromiseInterface

Add snapshots to a BCF

Parameters

$bcf : SplFileObject: The BCF 2.1 file (required)
$version_uuid : string: (required)
$width : int|null = null: The snapshots' width in pixels, 300 when absent (optional)
$height : int|null = null: The snapshots' height in pixels, 300 when absent (optional)
$contentType : string = self::contentTypes['augmentBcf'][0]: The value for the Content-Type header. Check self::contentTypes['augmentBcf'] to see the possible values for this operation

Return values

PromiseInterface

augmentBcfAsyncWithHttpInfo()

Operation augmentBcfAsyncWithHttpInfo


    public
                    augmentBcfAsyncWithHttpInfo(SplFileObject $bcf, string $version_uuid[, int|null $width = null ][, int|null $height = null ][, string $contentType = self::contentTypes['augmentBcf'][0] ]) : PromiseInterface

Add snapshots to a BCF

Parameters

$bcf : SplFileObject: The BCF 2.1 file (required)
$version_uuid : string: (required)
$width : int|null = null: The snapshots' width in pixels, 300 when absent (optional)
$height : int|null = null: The snapshots' height in pixels, 300 when absent (optional)
$contentType : string = self::contentTypes['augmentBcf'][0]: The value for the Content-Type header. Check self::contentTypes['augmentBcf'] to see the possible values for this operation

Return values

PromiseInterface

augmentBcfRequest()

Create request for operation 'augmentBcf'


    public
                    augmentBcfRequest(SplFileObject $bcf, string $version_uuid[, int|null $width = null ][, int|null $height = null ][, string $contentType = self::contentTypes['augmentBcf'][0] ]) : Request

Parameters

$bcf : SplFileObject: The BCF 2.1 file (required)
$version_uuid : string: (required)
$width : int|null = null: The snapshots' width in pixels, 300 when absent (optional)
$height : int|null = null: The snapshots' height in pixels, 300 when absent (optional)
$contentType : string = self::contentTypes['augmentBcf'][0]: The value for the Content-Type header. Check self::contentTypes['augmentBcf'] to see the possible values for this operation

Return values

Request

augmentBcfWithHttpInfo()

Operation augmentBcfWithHttpInfo


    public
                    augmentBcfWithHttpInfo(SplFileObject $bcf, string $version_uuid[, int|null $width = null ][, int|null $height = null ][, string $contentType = self::contentTypes['augmentBcf'][0] ]) : array<string|int, mixed>

Add snapshots to a BCF

Parameters

$bcf : SplFileObject: The BCF 2.1 file (required)
$version_uuid : string: (required)
$width : int|null = null: The snapshots' width in pixels, 300 when absent (optional)
$height : int|null = null: The snapshots' height in pixels, 300 when absent (optional)
$contentType : string = self::contentTypes['augmentBcf'][0]: The value for the Content-Type header. Check self::contentTypes['augmentBcf'] to see the possible values for this operation

Return values

array<string|int, mixed> —

download()

Operation download


    public
                    download(DownloadRequest $download_request[, string $contentType = self::contentTypes['download'][0] ]) : SplFileObject|ErrorResponse

Download the model of the given Version UUID, as uploaded or as IFC or ifcXML. In case you want to download only a subset of an IFC model, use ifc/query.

Parameters

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

Return values

SplFileObject|ErrorResponse

downloadAsync()

Operation downloadAsync


    public
                    downloadAsync(DownloadRequest $download_request[, string $contentType = self::contentTypes['download'][0] ]) : PromiseInterface

Download the model of the given Version UUID, as uploaded or as IFC or ifcXML. In case you want to download only a subset of an IFC model, use ifc/query.

Parameters

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

Return values

PromiseInterface

downloadAsyncWithHttpInfo()

Operation downloadAsyncWithHttpInfo


    public
                    downloadAsyncWithHttpInfo(DownloadRequest $download_request[, string $contentType = self::contentTypes['download'][0] ]) : PromiseInterface

Download the model of the given Version UUID, as uploaded or as IFC or ifcXML. In case you want to download only a subset of an IFC model, use ifc/query.

Parameters

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

Return values

PromiseInterface

downloadIfcXml()

Operation downloadIfcXml


    public
                    downloadIfcXml(ModelIdentifier $model_identifier[, string $contentType = self::contentTypes['downloadIfcXml'][0] ]) : SplFileObject|ErrorResponse

Download the model of the given Version UUID serialized as ifcXML (deprecated, use Download with format ifcxml)

Parameters

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

Return values

SplFileObject|ErrorResponse

downloadIfcXmlAsync()

Operation downloadIfcXmlAsync


    public
                    downloadIfcXmlAsync(ModelIdentifier $model_identifier[, string $contentType = self::contentTypes['downloadIfcXml'][0] ]) : PromiseInterface

Download the model of the given Version UUID serialized as ifcXML (deprecated, use Download with format ifcxml)

Parameters

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

Return values

PromiseInterface

downloadIfcXmlAsyncWithHttpInfo()

Operation downloadIfcXmlAsyncWithHttpInfo


    public
                    downloadIfcXmlAsyncWithHttpInfo(ModelIdentifier $model_identifier[, string $contentType = self::contentTypes['downloadIfcXml'][0] ]) : PromiseInterface

Download the model of the given Version UUID serialized as ifcXML (deprecated, use Download with format ifcxml)

Parameters

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

Return values

PromiseInterface

downloadIfcXmlRequest()

Create request for operation 'downloadIfcXml'


    public
                    downloadIfcXmlRequest(ModelIdentifier $model_identifier[, string $contentType = self::contentTypes['downloadIfcXml'][0] ]) : Request

Parameters

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

Return values

Request

downloadIfcXmlWithHttpInfo()

Operation downloadIfcXmlWithHttpInfo


    public
                    downloadIfcXmlWithHttpInfo(ModelIdentifier $model_identifier[, string $contentType = self::contentTypes['downloadIfcXml'][0] ]) : array<string|int, mixed>

Download the model of the given Version UUID serialized as ifcXML (deprecated, use Download with format ifcxml)

Parameters

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

Return values

array<string|int, mixed> —

downloadRequest()

Create request for operation 'download'


    public
                    downloadRequest(DownloadRequest $download_request[, string $contentType = self::contentTypes['download'][0] ]) : Request

Parameters

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

Return values

Request

downloadWithHttpInfo()

Operation downloadWithHttpInfo


    public
                    downloadWithHttpInfo(DownloadRequest $download_request[, string $contentType = self::contentTypes['download'][0] ]) : array<string|int, mixed>

Download the model of the given Version UUID, as uploaded or as IFC or ifcXML. In case you want to download only a subset of an IFC model, use ifc/query.

Parameters

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

Return values

array<string|int, mixed> —

exportGeometry()

Operation exportGeometry


    public
                    exportGeometry(ExportGeometryRequest $export_geometry_request[, string $contentType = self::contentTypes['exportGeometry'][0] ]) : SplFileObject|ErrorResponse

The geometry of models as glTF

Parameters

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

Return values

SplFileObject|ErrorResponse

exportGeometryAsync()

Operation exportGeometryAsync


    public
                    exportGeometryAsync(ExportGeometryRequest $export_geometry_request[, string $contentType = self::contentTypes['exportGeometry'][0] ]) : PromiseInterface

The geometry of models as glTF

Parameters

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

Return values

PromiseInterface

exportGeometryAsyncWithHttpInfo()

Operation exportGeometryAsyncWithHttpInfo


    public
                    exportGeometryAsyncWithHttpInfo(ExportGeometryRequest $export_geometry_request[, string $contentType = self::contentTypes['exportGeometry'][0] ]) : PromiseInterface

The geometry of models as glTF

Parameters

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

Return values

PromiseInterface

exportGeometryRequest()

Create request for operation 'exportGeometry'


    public
                    exportGeometryRequest(ExportGeometryRequest $export_geometry_request[, string $contentType = self::contentTypes['exportGeometry'][0] ]) : Request

Parameters

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

Return values

Request

exportGeometryWithHttpInfo()

Operation exportGeometryWithHttpInfo


    public
                    exportGeometryWithHttpInfo(ExportGeometryRequest $export_geometry_request[, string $contentType = self::contentTypes['exportGeometry'][0] ]) : array<string|int, mixed>

The geometry of models as glTF

Parameters

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

Return values

array<string|int, mixed> —

exportVectorSvg()

Operation exportVectorSvg


    public
                    exportVectorSvg(ExportVectorSvgRequest $export_vector_svg_request[, string $contentType = self::contentTypes['exportVectorSvg'][0] ]) : SplFileObject|ErrorResponse

Export an orthographic vector drawing (SVG) of a model

Parameters

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

Return values

SplFileObject|ErrorResponse

exportVectorSvgAsync()

Operation exportVectorSvgAsync


    public
                    exportVectorSvgAsync(ExportVectorSvgRequest $export_vector_svg_request[, string $contentType = self::contentTypes['exportVectorSvg'][0] ]) : PromiseInterface

Export an orthographic vector drawing (SVG) of a model

Parameters

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

Return values

PromiseInterface

exportVectorSvgAsyncWithHttpInfo()

Operation exportVectorSvgAsyncWithHttpInfo


    public
                    exportVectorSvgAsyncWithHttpInfo(ExportVectorSvgRequest $export_vector_svg_request[, string $contentType = self::contentTypes['exportVectorSvg'][0] ]) : PromiseInterface

Export an orthographic vector drawing (SVG) of a model

Parameters

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

Return values

PromiseInterface

exportVectorSvgRequest()

Create request for operation 'exportVectorSvg'


    public
                    exportVectorSvgRequest(ExportVectorSvgRequest $export_vector_svg_request[, string $contentType = self::contentTypes['exportVectorSvg'][0] ]) : Request

Parameters

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

Return values

Request

exportVectorSvgWithHttpInfo()

Operation exportVectorSvgWithHttpInfo


    public
                    exportVectorSvgWithHttpInfo(ExportVectorSvgRequest $export_vector_svg_request[, string $contentType = self::contentTypes['exportVectorSvg'][0] ]) : array<string|int, mixed>

Export an orthographic vector drawing (SVG) of a model

Parameters

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

Return values

array<string|int, mixed> —

getCheckin()

Operation getCheckin


    public
                    getCheckin(GetCheckinRequest $get_checkin_request[, string $contentType = self::contentTypes['getCheckin'][0] ]) : CheckinStatus|ErrorResponse

The status of a checkin

Parameters

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

Return values

CheckinStatus|ErrorResponse

getCheckinAsync()

Operation getCheckinAsync


    public
                    getCheckinAsync(GetCheckinRequest $get_checkin_request[, string $contentType = self::contentTypes['getCheckin'][0] ]) : PromiseInterface

The status of a checkin

Parameters

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

Return values

PromiseInterface

getCheckinAsyncWithHttpInfo()

Operation getCheckinAsyncWithHttpInfo


    public
                    getCheckinAsyncWithHttpInfo(GetCheckinRequest $get_checkin_request[, string $contentType = self::contentTypes['getCheckin'][0] ]) : PromiseInterface

The status of a checkin

Parameters

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

Return values

PromiseInterface

getCheckinRequest()

Create request for operation 'getCheckin'


    public
                    getCheckinRequest(GetCheckinRequest $get_checkin_request[, string $contentType = self::contentTypes['getCheckin'][0] ]) : Request

Parameters

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

Return values

Request

getCheckinWithHttpInfo()

Operation getCheckinWithHttpInfo


    public
                    getCheckinWithHttpInfo(GetCheckinRequest $get_checkin_request[, string $contentType = self::contentTypes['getCheckin'][0] ]) : array<string|int, mixed>

The status of a checkin

Parameters

$get_checkin_request : GetCheckinRequest: (required)
$contentType : string = self::contentTypes['getCheckin'][0]: The value for the Content-Type header. Check self::contentTypes['getCheckin'] 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

getValidationReport()

Operation getValidationReport


    public
                    getValidationReport([GetValidationReportRequest|null $get_validation_report_request = null ][, string $contentType = self::contentTypes['getValidationReport'][0] ]) : ValidationReportResult|ErrorResponse

Why a model is invalid, or why its checkin failed

Parameters

$get_validation_report_request : GetValidationReportRequest|null = null: get_validation_report_request (optional)
$contentType : string = self::contentTypes['getValidationReport'][0]: The value for the Content-Type header. Check self::contentTypes['getValidationReport'] to see the possible values for this operation

Return values

ValidationReportResult|ErrorResponse

getValidationReportAsync()

Operation getValidationReportAsync


    public
                    getValidationReportAsync([GetValidationReportRequest|null $get_validation_report_request = null ][, string $contentType = self::contentTypes['getValidationReport'][0] ]) : PromiseInterface

Why a model is invalid, or why its checkin failed

Parameters

$get_validation_report_request : GetValidationReportRequest|null = null: (optional)
$contentType : string = self::contentTypes['getValidationReport'][0]: The value for the Content-Type header. Check self::contentTypes['getValidationReport'] to see the possible values for this operation

Return values

PromiseInterface

getValidationReportAsyncWithHttpInfo()

Operation getValidationReportAsyncWithHttpInfo


    public
                    getValidationReportAsyncWithHttpInfo([GetValidationReportRequest|null $get_validation_report_request = null ][, string $contentType = self::contentTypes['getValidationReport'][0] ]) : PromiseInterface

Why a model is invalid, or why its checkin failed

Parameters

$get_validation_report_request : GetValidationReportRequest|null = null: (optional)
$contentType : string = self::contentTypes['getValidationReport'][0]: The value for the Content-Type header. Check self::contentTypes['getValidationReport'] to see the possible values for this operation

Return values

PromiseInterface

getValidationReportRequest()

Create request for operation 'getValidationReport'


    public
                    getValidationReportRequest([GetValidationReportRequest|null $get_validation_report_request = null ][, string $contentType = self::contentTypes['getValidationReport'][0] ]) : Request

Parameters

$get_validation_report_request : GetValidationReportRequest|null = null: (optional)
$contentType : string = self::contentTypes['getValidationReport'][0]: The value for the Content-Type header. Check self::contentTypes['getValidationReport'] to see the possible values for this operation

Return values

Request

getValidationReportWithHttpInfo()

Operation getValidationReportWithHttpInfo


    public
                    getValidationReportWithHttpInfo([GetValidationReportRequest|null $get_validation_report_request = null ][, string $contentType = self::contentTypes['getValidationReport'][0] ]) : array<string|int, mixed>

Why a model is invalid, or why its checkin failed

Parameters

$get_validation_report_request : GetValidationReportRequest|null = null: (optional)
$contentType : string = self::contentTypes['getValidationReport'][0]: The value for the Content-Type header. Check self::contentTypes['getValidationReport'] to see the possible values for this operation

Return values

array<string|int, mixed> —

lookupModelHashes()

Operation lookupModelHashes


    public
                    lookupModelHashes(LookupModelHashesRequest $lookup_model_hashes_request[, string $contentType = self::contentTypes['lookupModelHashes'][0] ]) : LookupModelHashes200Response|ErrorResponse

Which files the server has already

Parameters

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

Return values

LookupModelHashes200Response|ErrorResponse

lookupModelHashesAsync()

Operation lookupModelHashesAsync


    public
                    lookupModelHashesAsync(LookupModelHashesRequest $lookup_model_hashes_request[, string $contentType = self::contentTypes['lookupModelHashes'][0] ]) : PromiseInterface

Which files the server has already

Parameters

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

Return values

PromiseInterface

lookupModelHashesAsyncWithHttpInfo()

Operation lookupModelHashesAsyncWithHttpInfo


    public
                    lookupModelHashesAsyncWithHttpInfo(LookupModelHashesRequest $lookup_model_hashes_request[, string $contentType = self::contentTypes['lookupModelHashes'][0] ]) : PromiseInterface

Which files the server has already

Parameters

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

Return values

PromiseInterface

lookupModelHashesRequest()

Create request for operation 'lookupModelHashes'


    public
                    lookupModelHashesRequest(LookupModelHashesRequest $lookup_model_hashes_request[, string $contentType = self::contentTypes['lookupModelHashes'][0] ]) : Request

Parameters

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

Return values

Request

lookupModelHashesWithHttpInfo()

Operation lookupModelHashesWithHttpInfo


    public
                    lookupModelHashesWithHttpInfo(LookupModelHashesRequest $lookup_model_hashes_request[, string $contentType = self::contentTypes['lookupModelHashes'][0] ]) : array<string|int, mixed>

Which files the server has already

Parameters

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

Return values

array<string|int, mixed> —

render()

Operation render


    public
                    render(RenderRequest $render_request[, string $contentType = self::contentTypes['render'][0] ]) : SplFileObject|ErrorResponse

A PNG image of a model

Parameters

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

Return values

SplFileObject|ErrorResponse

renderAsync()

Operation renderAsync


    public
                    renderAsync(RenderRequest $render_request[, string $contentType = self::contentTypes['render'][0] ]) : PromiseInterface

A PNG image of a model

Parameters

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

Return values

PromiseInterface

renderAsyncWithHttpInfo()

Operation renderAsyncWithHttpInfo


    public
                    renderAsyncWithHttpInfo(RenderRequest $render_request[, string $contentType = self::contentTypes['render'][0] ]) : PromiseInterface

A PNG image of a model

Parameters

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

Return values

PromiseInterface

renderRequest()

Create request for operation 'render'


    public
                    renderRequest(RenderRequest $render_request[, string $contentType = self::contentTypes['render'][0] ]) : Request

Parameters

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

Return values

Request

renderWithHttpInfo()

Operation renderWithHttpInfo


    public
                    renderWithHttpInfo(RenderRequest $render_request[, string $contentType = self::contentTypes['render'][0] ]) : array<string|int, mixed>

A PNG image of a model

Parameters

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

Return values

array<string|int, mixed> —

schemaConversionReport()

Operation schemaConversionReport


    public
                    schemaConversionReport(SchemaConversionReportRequest $schema_conversion_report_request[, string $contentType = self::contentTypes['schemaConversionReport'][0] ]) : SchemaConversionReportResponse|ErrorResponse

The log of a schema conversion

Parameters

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

Return values

SchemaConversionReportResponse|ErrorResponse

schemaConversionReportAsync()

Operation schemaConversionReportAsync


    public
                    schemaConversionReportAsync(SchemaConversionReportRequest $schema_conversion_report_request[, string $contentType = self::contentTypes['schemaConversionReport'][0] ]) : PromiseInterface

The log of a schema conversion

Parameters

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

Return values

PromiseInterface

schemaConversionReportAsyncWithHttpInfo()

Operation schemaConversionReportAsyncWithHttpInfo


    public
                    schemaConversionReportAsyncWithHttpInfo(SchemaConversionReportRequest $schema_conversion_report_request[, string $contentType = self::contentTypes['schemaConversionReport'][0] ]) : PromiseInterface

The log of a schema conversion

Parameters

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

Return values

PromiseInterface

schemaConversionReportRequest()

Create request for operation 'schemaConversionReport'


    public
                    schemaConversionReportRequest(SchemaConversionReportRequest $schema_conversion_report_request[, string $contentType = self::contentTypes['schemaConversionReport'][0] ]) : Request

Parameters

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

Return values

Request

schemaConversionReportWithHttpInfo()

Operation schemaConversionReportWithHttpInfo


    public
                    schemaConversionReportWithHttpInfo(SchemaConversionReportRequest $schema_conversion_report_request[, string $contentType = self::contentTypes['schemaConversionReport'][0] ]) : array<string|int, mixed>

The log of a schema conversion

Parameters

$schema_conversion_report_request : SchemaConversionReportRequest: (required)
$contentType : string = self::contentTypes['schemaConversionReport'][0]: The value for the Content-Type header. Check self::contentTypes['schemaConversionReport'] 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)

uploadModel()

Operation uploadModel


    public
                    uploadModel([SplFileObject|null $file = null ][, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string|null $input_file_type = null ][, string|null $format_settings = null ][, string|null $hash = null ][, bool|null $force_reprocessing = false ][, string|null $tags = null ][, string|null $validation_settings = null ][, int|null $wait_ms = null ][, string|null $force = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : BIMworksModelVersion|CheckinStatus|ErrorResponse

Upload a single model using multipart/form-data

Parameters

$file : SplFileObject|null = null: A single uploaded model (optional)
$node_uuid : string|null = null: The UUID of the Node to which to add the models (optional)
$filename : string|null = 'model.ifc': Name of the file (optional, default to 'model.ifc')
$filesize : int|null = -1: Filesize in bytes (optional, default to -1)
$content_type : string|null = null: The content type. When available this information is taken from the Content-Type of the file part. Allowed values are application/ifc, application/xml (for .ifcxml files), application/pdf, application/e57 (optional)
$input_file_type : string|null = null: The type of the model (an InputFileType name). When present and not UNKNOWN it wins over the filename extension (optional)
$format_settings : string|null = null: A JSON-encoded PointCloudFormatSettings object (multipart form fields are strings) with per-upload point cloud format options (optional)
$hash : string|null = null: Instead of the file, its full_xxh64 (see ModelHash) when LookupModelHashes said the server knows it; ignored next to a file, which the server hashes itself. Needs filename (optional)
$force_reprocessing : bool|null = false: Process the file again, also when the server has processed the same file before (optional, default to false)
$tags : string|null = null: Tags of the new Version, comma-separated VersionTag names (optional)
$validation_settings : string|null = null: A JSON-encoded ValidationSettings object (optional)
$wait_ms : int|null = null: Answer 202 with the checkin's status when the checkin takes longer than this (optional)
$force : string|null = null: An UploadForce: NONE, NEW_VERSION or NEW_MODEL (optional)
$contentType : string = self::contentTypes['uploadModel'][0]: The value for the Content-Type header. Check self::contentTypes['uploadModel'] to see the possible values for this operation

Return values

BIMworksModelVersion|CheckinStatus|ErrorResponse

uploadModelAsync()

Operation uploadModelAsync


    public
                    uploadModelAsync([SplFileObject|null $file = null ][, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string|null $input_file_type = null ][, string|null $format_settings = null ][, string|null $hash = null ][, bool|null $force_reprocessing = false ][, string|null $tags = null ][, string|null $validation_settings = null ][, int|null $wait_ms = null ][, string|null $force = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : PromiseInterface

Upload a single model using multipart/form-data

Parameters

$file : SplFileObject|null = null: A single uploaded model (optional)
$node_uuid : string|null = null: The UUID of the Node to which to add the models (optional)
$filename : string|null = 'model.ifc': Name of the file (optional, default to 'model.ifc')
$filesize : int|null = -1: Filesize in bytes (optional, default to -1)
$content_type : string|null = null: The content type. When available this information is taken from the Content-Type of the file part. Allowed values are application/ifc, application/xml (for .ifcxml files), application/pdf, application/e57 (optional)
$input_file_type : string|null = null: The type of the model (an InputFileType name). When present and not UNKNOWN it wins over the filename extension (optional)
$format_settings : string|null = null: A JSON-encoded PointCloudFormatSettings object (multipart form fields are strings) with per-upload point cloud format options (optional)
$hash : string|null = null: Instead of the file, its full_xxh64 (see ModelHash) when LookupModelHashes said the server knows it; ignored next to a file, which the server hashes itself. Needs filename (optional)
$force_reprocessing : bool|null = false: Process the file again, also when the server has processed the same file before (optional, default to false)
$tags : string|null = null: Tags of the new Version, comma-separated VersionTag names (optional)
$validation_settings : string|null = null: A JSON-encoded ValidationSettings object (optional)
$wait_ms : int|null = null: Answer 202 with the checkin's status when the checkin takes longer than this (optional)
$force : string|null = null: An UploadForce: NONE, NEW_VERSION or NEW_MODEL (optional)
$contentType : string = self::contentTypes['uploadModel'][0]: The value for the Content-Type header. Check self::contentTypes['uploadModel'] to see the possible values for this operation

Return values

PromiseInterface

uploadModelAsyncWithHttpInfo()

Operation uploadModelAsyncWithHttpInfo


    public
                    uploadModelAsyncWithHttpInfo([SplFileObject|null $file = null ][, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string|null $input_file_type = null ][, string|null $format_settings = null ][, string|null $hash = null ][, bool|null $force_reprocessing = false ][, string|null $tags = null ][, string|null $validation_settings = null ][, int|null $wait_ms = null ][, string|null $force = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : PromiseInterface

Upload a single model using multipart/form-data

Parameters

$file : SplFileObject|null = null: A single uploaded model (optional)
$node_uuid : string|null = null: The UUID of the Node to which to add the models (optional)
$filename : string|null = 'model.ifc': Name of the file (optional, default to 'model.ifc')
$filesize : int|null = -1: Filesize in bytes (optional, default to -1)
$content_type : string|null = null: The content type. When available this information is taken from the Content-Type of the file part. Allowed values are application/ifc, application/xml (for .ifcxml files), application/pdf, application/e57 (optional)
$input_file_type : string|null = null: The type of the model (an InputFileType name). When present and not UNKNOWN it wins over the filename extension (optional)
$format_settings : string|null = null: A JSON-encoded PointCloudFormatSettings object (multipart form fields are strings) with per-upload point cloud format options (optional)
$hash : string|null = null: Instead of the file, its full_xxh64 (see ModelHash) when LookupModelHashes said the server knows it; ignored next to a file, which the server hashes itself. Needs filename (optional)
$force_reprocessing : bool|null = false: Process the file again, also when the server has processed the same file before (optional, default to false)
$tags : string|null = null: Tags of the new Version, comma-separated VersionTag names (optional)
$validation_settings : string|null = null: A JSON-encoded ValidationSettings object (optional)
$wait_ms : int|null = null: Answer 202 with the checkin's status when the checkin takes longer than this (optional)
$force : string|null = null: An UploadForce: NONE, NEW_VERSION or NEW_MODEL (optional)
$contentType : string = self::contentTypes['uploadModel'][0]: The value for the Content-Type header. Check self::contentTypes['uploadModel'] to see the possible values for this operation

Return values

PromiseInterface

uploadModelRequest()

Create request for operation 'uploadModel'


    public
                    uploadModelRequest([SplFileObject|null $file = null ][, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string|null $input_file_type = null ][, string|null $format_settings = null ][, string|null $hash = null ][, bool|null $force_reprocessing = false ][, string|null $tags = null ][, string|null $validation_settings = null ][, int|null $wait_ms = null ][, string|null $force = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : Request

Parameters

$file : SplFileObject|null = null: A single uploaded model (optional)
$node_uuid : string|null = null: The UUID of the Node to which to add the models (optional)
$filename : string|null = 'model.ifc': Name of the file (optional, default to 'model.ifc')
$filesize : int|null = -1: Filesize in bytes (optional, default to -1)
$content_type : string|null = null: The content type. When available this information is taken from the Content-Type of the file part. Allowed values are application/ifc, application/xml (for .ifcxml files), application/pdf, application/e57 (optional)
$input_file_type : string|null = null: The type of the model (an InputFileType name). When present and not UNKNOWN it wins over the filename extension (optional)
$format_settings : string|null = null: A JSON-encoded PointCloudFormatSettings object (multipart form fields are strings) with per-upload point cloud format options (optional)
$hash : string|null = null: Instead of the file, its full_xxh64 (see ModelHash) when LookupModelHashes said the server knows it; ignored next to a file, which the server hashes itself. Needs filename (optional)
$force_reprocessing : bool|null = false: Process the file again, also when the server has processed the same file before (optional, default to false)
$tags : string|null = null: Tags of the new Version, comma-separated VersionTag names (optional)
$validation_settings : string|null = null: A JSON-encoded ValidationSettings object (optional)
$wait_ms : int|null = null: Answer 202 with the checkin's status when the checkin takes longer than this (optional)
$force : string|null = null: An UploadForce: NONE, NEW_VERSION or NEW_MODEL (optional)
$contentType : string = self::contentTypes['uploadModel'][0]: The value for the Content-Type header. Check self::contentTypes['uploadModel'] to see the possible values for this operation

Return values

Request

uploadModelWithHttpInfo()

Operation uploadModelWithHttpInfo


    public
                    uploadModelWithHttpInfo([SplFileObject|null $file = null ][, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string|null $input_file_type = null ][, string|null $format_settings = null ][, string|null $hash = null ][, bool|null $force_reprocessing = false ][, string|null $tags = null ][, string|null $validation_settings = null ][, int|null $wait_ms = null ][, string|null $force = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : array<string|int, mixed>

Upload a single model using multipart/form-data

Parameters

$file : SplFileObject|null = null: A single uploaded model (optional)
$node_uuid : string|null = null: The UUID of the Node to which to add the models (optional)
$filename : string|null = 'model.ifc': Name of the file (optional, default to 'model.ifc')
$filesize : int|null = -1: Filesize in bytes (optional, default to -1)
$content_type : string|null = null: The content type. When available this information is taken from the Content-Type of the file part. Allowed values are application/ifc, application/xml (for .ifcxml files), application/pdf, application/e57 (optional)
$input_file_type : string|null = null: The type of the model (an InputFileType name). When present and not UNKNOWN it wins over the filename extension (optional)
$format_settings : string|null = null: A JSON-encoded PointCloudFormatSettings object (multipart form fields are strings) with per-upload point cloud format options (optional)
$hash : string|null = null: Instead of the file, its full_xxh64 (see ModelHash) when LookupModelHashes said the server knows it; ignored next to a file, which the server hashes itself. Needs filename (optional)
$force_reprocessing : bool|null = false: Process the file again, also when the server has processed the same file before (optional, default to false)
$tags : string|null = null: Tags of the new Version, comma-separated VersionTag names (optional)
$validation_settings : string|null = null: A JSON-encoded ValidationSettings object (optional)
$wait_ms : int|null = null: Answer 202 with the checkin's status when the checkin takes longer than this (optional)
$force : string|null = null: An UploadForce: NONE, NEW_VERSION or NEW_MODEL (optional)
$contentType : string = self::contentTypes['uploadModel'][0]: The value for the Content-Type header. Check self::contentTypes['uploadModel'] 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

ModelApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

addModelWithUrl()

Parameters

Tags

Return values

addModelWithUrlAsync()

Parameters

Tags

Return values

addModelWithUrlAsyncWithHttpInfo()

Parameters

Tags

Return values

addModelWithUrlRequest()

Parameters

Tags

Return values

addModelWithUrlWithHttpInfo()

Parameters

Tags

Return values

augmentBcf()

Parameters

Tags

Return values

augmentBcfAsync()

Parameters

Tags

Return values

augmentBcfAsyncWithHttpInfo()

Parameters

Tags

Return values

augmentBcfRequest()

Parameters

Tags

Return values

augmentBcfWithHttpInfo()

Parameters

Tags

Return values

download()

Parameters

Tags

Return values

downloadAsync()

Parameters

Tags

Return values

downloadAsyncWithHttpInfo()

Parameters

Tags

Return values

downloadIfcXml()

Parameters

Tags

Return values

downloadIfcXmlAsync()

Parameters

Tags

Return values

downloadIfcXmlAsyncWithHttpInfo()

Parameters

Tags

Return values

ModelApi
in package

BIMworks