Javascript Platform APIs
Note: For more information on installing the NPM package, see NPM install.
The platform APIs contain the following API types:
Low-level APIs
- Wrappers over Platform Services REST APIs, for example, IafPassportSvc, IafItemSvc, IafDatasourcesSvc, IafFileSvc, IafGraphicsSvc
High-Level APIs
- Built using low-level APIs
- Encapsulate higher-level semantics
- REST API service for higher-level APIs
- For example, IafProj, IafFile, IafFileContainer
For more information on the available APIs, see the following graphic and table:
| API | Description | Services |
|---|---|---|
| IafApplication | Manage Application resources and apps for Users, UserGroups, and session users. | Passport Service |
| IafBimGraphicsLoader | Get a model's geometry views, download an SVG image for a view resource, load an imported BIM model's 3D BIM graphics for the IafViewer. | Graphics Service |
| IafDataSource | Create and manage orchestrators, as well as orchestrator components, runs, schedules, and permissions. | Data sources |
| IafFetch | Use methods that simplify HTTP requests. | |
| IafFile | Manage Files, FileContainers, FileItems, and NamedFileCollections. | Item service, File service |
| IafFileContainer | Manage FileContainers. | File service |
| IafFileSvc | Manage source Files, FileVersions, metadata, resumable uploads, permissions, download and preview URLs, and FileContainers. | File service |
| IafGraphicsSvc | Create file sets and cache graphics files on the Graphics Service | Graphics Service |
| IafHelper | Use helper methods that check, add, convert, ignore, and get data. | |
| IafItemSvc | Manage item service resources such as related items and named user items, such as collections, scripts, and user configs. | Item service |
| IafNsProvider | Manage namespaces and their resources. | Passport service |
| IafObjectModelAPISvc | Manage API config files and their permissions in the Object Model API service. | Object Model API service |
| IafPassSvc | Create and update Users, UserGroups, NotificationTemplates, manage session user authorization, as well as permissions for Users, UserGroups, Applications, Workspaces, and more. | Passport service |
| IafPermissions | Create and manage Permissions. | Passport service |
| IafProj | Manage Projects and their resources. | Passport service |
| IafPurge | Purge NamedCompositeItems, NamedFileCollections or their versions. | |
| IafSession | Manage session users, storage, auth tokens, and error messages. | Passport service |
| IafScripts | Create and manage Scripts and ScriptVersions. | Item service |
| IafScriptEngine | Write scripts on the platform by calling platform APIs and using utility functions | Item, Passport, and Datasource services |
| IafUser | Create a User in the Passport Service. | Passport service |
| IafUserConfig | Create and manage UserConfigs. | Item service |
| IafUserGroup | Manage UserGroups, as well as UserGroup resources, Permissions, Users, and Invites. | Passport service |
| IafWorkspace | Manage workspaces and their resources. | Passport service |