Overview
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, user groups, 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 file items and file collections. | Item service, File service |
| IafFileContainer | Manage file containers. | File service |
| IafFileSvc | Manage source files, file versions, metadata, resumable uploads, permissions, download and preview URLs, and file containers. | 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, user groups, notification templates, manage session user authorization, as well as permissions for users, user groups, applications, workspaces, and more. | Passport service |
| IafPermissions | Create and manage permissions. | Passport service |
| IafProj | Manage projects and their resources. | Passport service |
| IafPurge | Purge name composite items, named file collections or their versions. | |
| IafSession | Manage session users, storage, auth tokens, and error messages. | Passport service |
| IafScripts | Create and manage scripts and script versions. | 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 user configs. | Item service |
| IafUserGroup | Manage user groups, as well as user group resources, permissions, users, and invites. | Passport service |
| IafWorkspace | Manage workspaces and their resources. | Passport service |