Documentation

ModelApi
in package

BIMworks

ModelApi Class Doc Comment

Constants

contentTypes = ['addModelWithUrl' => ['application/json'], 'download' => ['application/json'], 'uploadModel' => ['multipart/form-data']]

Properties

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

Methods

__construct() : mixed
addModelWithUrl() : BIMworksModelVersion|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
download() : SplFileObject|ErrorResponse: Operation download
downloadAsync() : PromiseInterface: Operation downloadAsync
downloadAsyncWithHttpInfo() : PromiseInterface: Operation downloadAsyncWithHttpInfo
downloadRequest() : Request: Create request for operation 'download'
downloadWithHttpInfo() : array<string|int, mixed>: Operation downloadWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
setHostIndex() : void: Set the host index
uploadModel() : BIMworksModelVersion|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'], 'download' => ['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|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|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> —

of \BIMworksModelVersion|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

download()

Operation download


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

Download the original model that was uploaded for the given Version UUID, this will always be a byte-for-byte copy of the original. In case you want to download only a subset of an IFC model, use ifc/query.

Parameters

$model_identifier : ModelIdentifier: model_identifier (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(ModelIdentifier $model_identifier[, string $contentType = self::contentTypes['download'][0] ]) : PromiseInterface

Parameters

$model_identifier : ModelIdentifier: (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(ModelIdentifier $model_identifier[, string $contentType = self::contentTypes['download'][0] ]) : PromiseInterface

Parameters

$model_identifier : ModelIdentifier: (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

downloadRequest()

Create request for operation 'download'


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

Parameters

$model_identifier : ModelIdentifier: (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(ModelIdentifier $model_identifier[, string $contentType = self::contentTypes['download'][0] ]) : array<string|int, mixed>

Parameters

$model_identifier : ModelIdentifier: (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> —

of \SplFileObject|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

uploadModel()

Operation uploadModel


    public
                    uploadModel(SplFileObject $file[, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : BIMworksModelVersion|ErrorResponse

Upload a single model using multipart/form-data

Parameters

$file : SplFileObject: A single uploaded model (required)
$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/pdf, application/e57 (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|ErrorResponse

uploadModelAsync()

Operation uploadModelAsync


    public
                    uploadModelAsync(SplFileObject $file[, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : PromiseInterface

Upload a single model using multipart/form-data

Parameters

$file : SplFileObject: A single uploaded model (required)
$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/pdf, application/e57 (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 $file[, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : PromiseInterface

Upload a single model using multipart/form-data

Parameters

$file : SplFileObject: A single uploaded model (required)
$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/pdf, application/e57 (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 $file[, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : Request

Parameters

$file : SplFileObject: A single uploaded model (required)
$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/pdf, application/e57 (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 $file[, string|null $node_uuid = null ][, string|null $filename = 'model.ifc' ][, int|null $filesize = -1 ][, string|null $content_type = null ][, string $contentType = self::contentTypes['uploadModel'][0] ]) : array<string|int, mixed>

Upload a single model using multipart/form-data

Parameters

$file : SplFileObject: A single uploaded model (required)
$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/pdf, application/e57 (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> —

of \BIMworksModelVersion|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

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

download()

Parameters

Tags

Return values

downloadAsync()

Parameters

Tags

Return values

downloadAsyncWithHttpInfo()

Parameters

Tags

Return values

downloadRequest()

Parameters

Tags

Return values

downloadWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

setHostIndex()

Parameters

uploadModel()

Parameters

Tags

Return values

uploadModelAsync()

Parameters

Tags

Return values

uploadModelAsyncWithHttpInfo()

Parameters

Tags

Return values

uploadModelRequest()

Parameters

Tags

Return values

uploadModelWithHttpInfo()

Parameters

ModelApi
in package

BIMworks