BIM.works SDKs - v3.0.0-beta.168
    Preparing search index...

    Files, URLs, texts and identifiers linked to objects, which follow their objects to later versions. Available through BimWorksClient.linkedData. Reading needs the scope links:read, changing links:write.

    Index

    Constructors

    Methods

    • Links an existing item to more objects; a target it is on already is left as it is

      Parameters

      • itemUuid: string
      • versionUuid: string
      • targets: LinkTarget[]

      Returns Promise<{ item: LinkedDataItem; links: LinkedDataLink[] }>

    • Confirms that a link marked CHECK on the version is on the right object

      Parameters

      • linkUuid: string
      • versionUuid: string

      Returns Promise<{ confirmed_anchor_uuid: string; link: LinkedDataLink }>

    • Which objects of a version have linked data: for colouring and markers

      Parameters

      • versionUuid: string
      • Optionaloptions: { includeLater?: boolean }

      Returns Promise<LinkedDataCounts>

    • The item's content, as uploaded: a file byte for byte, a URL, identifier or text as text/plain

      Parameters

      • itemUuid: string

      Returns Promise<ArrayBuffer>

    • A URL of the item's content, valid for a few minutes without a token (treat it like the file itself), that supports Range, for a browser tab, a player or a PDF viewer. With inline: true it shows the content when the type allows it; disposition says what it will do.

      Parameters

      • itemUuid: string
      • Optionaloptions: { inline?: boolean }

      Returns Promise<
          {
              disposition: "attachment"
              | "inline";
              expires: string;
              path?: string;
              url: string;
          },
      >

    • Ends a link from the version on; the older versions keep it

      Parameters

      • linkUuid: string
      • fromVersionUuid: string

      Returns Promise<{ link: LinkedDataLink }>

    • One item, its links with their trail across versions, and its replacements

      Parameters

      • itemUuid: string
      • OptionalversionUuid: string

      Returns Promise<LinkedDataDetails>

    • What this server accepts: the file families, the deny list, the limits, the categories

      Returns Promise<LinkedDataPolicy>

    • Puts a link on another object from the version on

      Parameters

      • linkUuid: string
      • versionUuid: string
      • target: LinkTarget

      Returns Promise<{ link: LinkedDataLink }>

    • Deletes items from every object and version, restorable for the policy's retention_days

      Parameters

      • itemUuids: string[]
      • Optionalreason: string

      Returns Promise<{ deleted: string[]; retention_days: number }>

    • Replaces an item from a version on; the older versions keep it

      Parameters

      Returns Promise<
          {
              deleted: boolean;
              ended: string[];
              item: LinkedDataItem;
              links: LinkedDataLink[];
              unlinked: string[];
          },
      >

    • Parameters

      • itemUuids: string[]

      Returns Promise<{ restored: string[] }>

    • Takes links off their objects on every version; an item that loses its last link is deleted

      Parameters

      • linkUuids: string[]

      Returns Promise<{ items_deleted: string[]; unlinked: string[] }>

    • Edits what can be edited; a stale rowVersion rejects with VERSION_CONFLICT

      Parameters

      • itemUuid: string
      • rowVersion: number
      • fields: {
            category?: string;
            description?: string;
            identifier_system?: string;
            title?: string;
            valid_until?: string;
        }

      Returns Promise<LinkedDataItem>