API Reference

Uploads a document file related to a specific model

post
https://apis.xbim-dev.net//aim/2.0//documentfiles/upload

Summary:Uploads a document file related to a specific model.
The document will be associated with the asset and model provided in the Form data parameters.
Return Type: FileUploadResult

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique Tenant ID (UUID or Identifier string)

string
enum
required
Defaults to UK

The data center region the data resides in

Allowed:
Body Params
file
required

An arbitrary document which will get associated to the model or its parts.

string
required

The name of the Document

integer
required

Asset which should contain the document

integer
required

Asset model which should contain the document

string | null

External identity of the document. This will be used for versioning.

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

Updated 9 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated 9 months ago

Did this page help you?