Patch Documents by assetmodelid, entityid and tenantid

patch

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

Summary:Return Type: Entity

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

AssetModelId

int64

required

EntityId

int64

required

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

Represents an edit to a 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.

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 Data

401

Unauthorized - Login required

403

Forbidden - Not authorised

404

Entity not found

200Entity successfully amended