Adds a new document to an entity

post

https://apis.xbim-dev.net/{region}/aim/2.0/{tenantId}/Zones(AssetModelId={assetModelId}, EntityId={entityId})/Documents

Summary:Adds a new document to an entity.
Return Type: Document

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

assetModelId

int64

required

The model Id

entityId

int64

required

The unique identifier for the target entity (Entity Label)

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

A document to create

Represents a new document.
This is an simplification of the IfcDocumentInformation and IfcDocumentReference concepts.
See https://standards.buildingsmart.org/IFC/RELEASE/IFC2x3/TC1/HTML/ifcexternalreferenceresource/lexical/ifcdocumentinformation.htm

Url

string | null

The Url of the document. Prefer Location over setting the URL

Location

string | null

Location, where the external source (classification, document or library).
For externally hosted documents normally given as an URL location string. For documents hosted in Flex, use the value 'Flex',
and provide the Flex 'fileId' in the Item Reference

ItemReference

string | null

Identifier for the referenced item in the external source (classification, document or library)
For documents hosted in Flex this should be the fileId

Scope

string | null

Scope for this document.

Revision

string | null

Document revision designation

Purpose

string | null

Purpose for this document.

IntendedUse

string | null

Intended Use for this document.

AssetModelId

int32

required

The identifier of the Model this entity belongs to

EntityId

int32 | null

Gets or sets the entity identifier / Label.

ExternalIdentifier

uuid | null

The immutable unique identifier key for this Entity

Name

string | null

The name of the entity

Description

string | null

Optional Description of the document

ExternalObjectType

string | null

A system identifier of the type of entity

Responses

400

Invalid request / document

401

Unauthorized - Login required

403

Forbidden - Not authorised

404

Target entity not found

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200On success