A one-stop service for Uploading an IFC model file, creating an asset and Model as required, and initiating processing

post

https://apis.xbim-dev.net/{region}/aim/2.0/{tenantId}/modelfiles/upload

Summary:A one-stop service for Uploading an IFC model file, creating an asset and Model as required, and initiating processing.
Uploads a model File, creating a new Asset and Model as required.
The model is associated with the named asset. The Asset will be created if it does not exist.

On successful upload the model will be queued for processing..
Return Type: FileUploadResult

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

string

required

The unique Tenant ID (UUID or Identifier string)

region

string

enum

required

Defaults to UK

The data center region the data resides in

Allowed:

Body Params

file

required

A model file in the correct format (IFC / IFCZip / Zip)

assetName

string

required

The name of the asset to associate the model upload with.

segmentName

string | null

The name of the asset segment to associate the model with. The segment will be created if not present. Defaults to the Model Name if undefined

revision

string | null

A version identifier for the model.

status

string | null

A status identifier for the model

assetId

integer | null

The ID of the asset to associate the model upload with. If not defined, a new asset will be created.

modelId

integer | null

The ID of the model to be populated with the data. If not defined, a new model will be created.

originalFilename

string | null

The original filename of the model, for zipped models

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Invalid input

401

Unauthorized - Login required

402

Plan limit reached

403

Forbidden - Not authorised

404

Asset or Model not found

409

Concurrency Failure - retry

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200An upload result