Documentation - v19.12.0-dev
    Preparing search index...
    • REST client for reading twin object geometries, values, fields, tree view, and search results.

      Parameters

      Returns {
          flattenedObjectProperties_deprecated(twin: Twin): Promise<string[]>;
          getGeometryInfo(
              endpoint: string,
              hash: string,
              geometryType: TwinObjectGeometryType,
              axis?: Vector3,
          ): Promise<number>;
          getGeometryRequest(
              endpoint: string,
              hash: string,
              pageNumber: number,
              pageSize: number,
              geometryType: TwinObjectGeometryType,
              axis?: Vector3,
          ): FileRequest;
          getTwinObject<
              TFamily extends
                  | "Primitive"
                  | "TwinBimData"
                  | "TwinOpenData"
                  | "TwinUserData"
                  | "TwinEquipment"
                  | "TwinStereographData"
                  | "TwinMaintenanceRequest",
          >(
              twin: Twin,
              uuid: string,
              families?: TFamily[],
          ): Promise<TwinObject<TwinObjectPropertiesByFamily<TFamily>[]>>;
          getTwinObjectFields(
              twin: Twin,
              searchPattern: string,
              pageNumber: number,
              pageSize: number,
          ): Promise<ApiDataList<TwinObjectField>>;
          getTwinObjectValues(
              twin: Twin,
              hash: string,
              pageSize?: number,
              afterKey?: string,
          ): Promise<AfterKeyList<TwinObjectPropertyWithCount>>;
          getTwinTreeView(
              twinProjectId: number,
              signal?: AbortSignal,
          ): Promise<TreeViewChild | TreeViewChild[]>;
          search(
              hash: string,
              pageNumber: number,
              pageSize: number,
          ): Promise<ApiDataList<TwinObject<TwinObjectProperty[]>>>;
      }