Glossary

2-legged OAuth (Client Credentials flow) authenticates your application directly with APS without requiring user interaction. Used for server-side operations, CI/CD pipelines, and accessing application-owned resources like OSS buckets.

3-legged OAuth (Authorization Code flow) requires user interaction to grant your application access to their data. The user logs in via browser, approves permissions, and your app receives tokens to act on their behalf. Required for accessing user-specific data in ACC, BIM 360, and Fusion.

Autodesk Construction Cloud is a unified platform for construction project management, including document management, design collaboration, issue tracking, RFIs, submittals, and field management. Successor to BIM 360.

An Activity defines what a Design Automation job does: which engine to use, which AppBundles to load, input/output parameters, and execution settings. Work items reference Activities to run actual jobs.

An Application Programming Interface defines how software components interact. APS provides REST APIs for cloud operations. RAPS wraps these APIs in CLI commands for easier scripting and automation.

An AppBundle is a ZIP package containing your custom code (plugin, script, or add-in) that runs within a Design Automation engine. AppBundles are uploaded to APS and referenced by Activities to extend engine capabilities.

Autodesk Platform Services (formerly Forge) is a collection of cloud-based APIs that enable developers to build applications integrating with Autodesk products. It includes services for authentication, file storage, model translation, data management, and more.

An argument is a value passed to a command, typically required for the command to execute. Unlike flags, arguments don't have names: `raps bucket delete my-bucket` (my-bucket is the argument).

An artifact is a file produced during a pipeline run, such as compiled binaries, translated models, or reports. CI/CD platforms can store, share, and deploy artifacts between jobs and workflows.

AutoCAD is Autodesk's foundational CAD software for 2D drafting and 3D modeling. Used across industries for technical drawings, documentation, and design. Native file format is DWG.

Automation eliminates repetitive manual tasks through software. RAPS automates APS operations (uploads, translations, queries) that would otherwise require clicking through web interfaces.

Building Information Modeling is a process using intelligent 3D models for planning, design, construction, and operation of buildings. BIM models contain geometry plus rich metadata about building components, materials, and relationships.

BIM 360 was Autodesk's original cloud-based construction management platform. While largely replaced by ACC, many existing projects and APIs still use BIM 360. Includes Docs, Design, Build, and other modules.

A bucket is a named container in Object Storage Service that holds files (objects). Buckets have retention policies (transient, temporary, persistent) that determine how long files are stored. Bucket names must be globally unique across all APS applications.

Computer-Aided Design encompasses software tools for creating, modifying, and analyzing designs. CAD software ranges from 2D drafting (AutoCAD) to 3D modeling (Inventor, Fusion) to building design (Revit).

Continuous Integration/Continuous Delivery automates software building, testing, and deployment. CI merges code changes frequently with automated tests; CD automatically deploys validated changes. RAPS enables CI/CD for CAD workflows.

A Command Line Interface accepts text commands for program interaction. CLIs are essential for automation, scripting, and CI/CD integration. RAPS is a CLI tool for APS.

A command is an instruction given to a CLI tool. RAPS commands are organized hierarchically: `raps bucket list`, `raps auth test`, etc. Commands accept flags and arguments to customize behavior.

Configuration includes settings like credentials, defaults, and preferences. RAPS reads configuration from environment variables, config files, and command-line flags (in order of precedence).

A container is a lightweight, standalone package containing code and dependencies. Containers provide consistent environments across development, testing, and production. RAPS runs in Docker containers.

CSV is a simple format for tabular data, easily imported into spreadsheets and databases. RAPS can output results in CSV format (`--output csv`) for reporting and analysis.

Data Management API provides access to files stored in Autodesk cloud products (ACC, BIM 360, Fusion Team). It exposes a hierarchical structure of hubs, projects, folders, items, and versions. Requires 3-legged authentication.

A derivative is any file generated by the Model Derivative API from a source model. This includes viewables (SVF2), geometry exports (OBJ, STL), metadata extracts, and thumbnails.

Design Automation API executes Autodesk desktop application engines (AutoCAD, Revit, Inventor, 3ds Max) in the cloud without user interaction. Used for batch processing, automated drawing generation, and custom automation workflows.

Docker packages applications with their dependencies into containers that run consistently anywhere. RAPS provides official Docker images for containerized deployments and CI/CD environments.

DWG (drawing) is the proprietary binary file format used by AutoCAD and other Autodesk products. It's the most widely used CAD file format, containing 2D/3D design data, layers, and metadata.

Drawing Exchange Format is an open ASCII/binary format for CAD data interchange. Created by Autodesk as a DWG alternative for sharing drawings between different CAD applications.

Environment variables are key-value pairs that configure application behavior without hardcoding values. RAPS uses env vars (APS_CLIENT_ID, APS_CLIENT_SECRET) for secure credential management in CI/CD.

Exit codes indicate command success (0) or failure (non-zero). RAPS uses standardized exit codes for CI/CD integration: 0=success, 1=general error, 2=auth failure, etc. Pipelines use exit codes to control flow.

FBX is Autodesk's format for 3D content exchange, supporting geometry, materials, textures, animations, and rigging. Widely used in game development and visual effects pipelines.

A flag is a command-line option that modifies command behavior. Flags start with dashes: `-o json` (short) or `--output json` (long). Boolean flags toggle features: `--verbose`, `--quiet`.

Forge was the original branding for Autodesk's cloud platform APIs, rebranded to Autodesk Platform Services (APS) in 2022. Many older documentation, tutorials, and code samples still reference Forge.

GitHub Actions is GitHub's automation platform for CI/CD workflows. Workflows are defined in YAML files and triggered by events (push, PR, schedule). RAPS provides a GitHub Action for easy integration.

Hypertext Transfer Protocol is the foundation of data communication on the web. HTTPS is the secure version using TLS encryption. All APS API calls use HTTPS.

A hub represents a company or account in Autodesk's cloud products. BIM 360 and ACC accounts appear as hubs with different hub types. Hubs contain projects, which contain folders and files.

Industry Foundation Classes is an ISO standard (ISO 16739) for open BIM data exchange. IFC enables interoperability between different BIM software by defining a common schema for building elements and properties.

Initial Graphics Exchange Specification is an older vendor-neutral format for CAD data exchange. While largely superseded by STEP, IGES is still used for compatibility with legacy systems.

RAPS's interactive shell provides a REPL (Read-Eval-Print Loop) for executing commands without retyping `raps` each time. Features include tab completion, command history, and parameter hints.

JSON (JavaScript Object Notation) is a lightweight data format used for API responses and configuration. RAPS can output results in JSON format (`--output json`) for easy parsing in scripts.

JSON Web Tokens are a compact, URL-safe means of representing claims. APS access tokens are JWTs containing the client ID, scopes, and expiration. They can be decoded to inspect permissions.

The keychain is the operating system's secure credential storage (macOS Keychain, Windows Credential Manager, Linux Secret Service). RAPS stores OAuth tokens in the keychain rather than plain text files.

The manifest describes a translated model's structure, available derivatives, and translation status. It lists all generated outputs (viewables, thumbnails, extracted data) and their download URNs. Check the manifest to monitor translation progress.

Model Context Protocol is a standard for connecting AI assistants to external tools. RAPS includes an MCP server that exposes APS operations to AI assistants like Claude, enabling natural language interaction with APS.

Model Derivative API converts CAD files into viewable formats (SVF/SVF2) and extracts metadata, geometry, and properties. It supports 60+ input formats and can output to formats like OBJ, STL, STEP, and IGES.

NWD is a published Navisworks file format for sharing models for review. It contains flattened geometry from various source formats, making it ideal for coordination and clash detection without exposing original CAD data.

OAuth 2.0 is the authorization framework used by APS to grant applications access to user data without sharing passwords. APS supports multiple OAuth flows including 2-legged (client credentials) and 3-legged (authorization code) authentication.

OBJ is a simple, widely-supported 3D geometry format storing vertices, faces, and texture coordinates. Common for 3D printing, game development, and web visualization. Does not preserve CAD-specific data.

Object Storage Service is APS's cloud file storage system. Files are organized in buckets and identified by object keys. OSS is commonly used to store source CAD files before translation and to host translated derivatives.

A pipeline is an automated workflow that processes code or data through defined stages. In CI/CD, pipelines typically include build, test, and deploy stages. RAPS integrates into pipelines to automate APS operations.

A profile is a named configuration set containing credentials and settings. RAPS supports multiple profiles for different APS applications or environments: `raps --profile production auth test`.

A project is a collection of folders and files within a hub. In ACC/BIM 360, projects correspond to construction or design projects. Projects have their own folder structure, permissions, and settings.

RAPS (Rust APS CLI) is a command-line tool for interacting with Autodesk Platform Services. It provides commands for authentication, file storage, model translation, and data management, optimized for CI/CD pipelines.

Representational State Transfer is an architectural style for web services using HTTP methods (GET, POST, PUT, DELETE). APS uses REST APIs that RAPS calls to perform operations.

Revit is Autodesk's flagship BIM application for architects, engineers, and contractors. It creates parametric 3D models with embedded intelligence about building components. Native file format is RVT.

RFA (Revit Family) files contain reusable building components like doors, windows, furniture, and equipment. Families define parametric geometry and behavior that can be placed multiple times in projects.

Rust is a systems programming language emphasizing safety, speed, and concurrency. RAPS is written in Rust, providing a fast, single-binary CLI with no runtime dependencies.

RVT is Revit's proprietary file format containing the complete BIM model: 3D geometry, 2D views, schedules, and all embedded building data. RVT files can be quite large due to their comprehensive data.

A Software Development Kit provides libraries, tools, and documentation for building on a platform. Autodesk provides SDKs for various languages, but RAPS offers a CLI alternative for scripting.

Secrets are encrypted environment variables for sensitive data like API keys and passwords. CI/CD platforms store secrets securely and inject them at runtime without exposing values in logs.

STEP (Standard for the Exchange of Product Data) is an ISO standard (ISO 10303) for representing 3D CAD models. Widely used in manufacturing for exchanging geometry between different CAD systems.

STL (Stereolithography) is a file format describing surface geometry as triangular meshes. Standard format for 3D printing and rapid prototyping. Does not include color, texture, or material information.

Simple Vector Format was APS's original output format for web viewing. Contains optimized geometry, materials, and metadata for browser-based rendering. Superseded by SVF2.

SVF2 is the current-generation viewing format for APS, offering improved loading performance, smaller file sizes, and better rendering quality than SVF. Recommended for all new translations.

A terminal is an application that provides access to the command line. Examples include macOS Terminal, Windows Terminal, and iTerm2. RAPS's interactive shell runs within a terminal.

An access token is a credential issued after authentication that grants API access. APS tokens are JWTs with encoded scopes and expiration. RAPS handles token acquisition, refresh, and secure storage.

A translation job is an asynchronous process that converts source CAD files into derivatives. Jobs are started via the Model Derivative API and progress through states: pending, inprogress, success, or failed. Use manifest endpoint to check status.

A Uniform Resource Name uniquely identifies an object in APS. URNs are base64-encoded strings derived from bucket and object keys. They're used extensively in Model Derivative API calls and must be URL-safe encoded when passed as parameters.

A viewable is a Model Derivative output optimized for display in the Autodesk Viewer. Viewables include geometry, materials, and metadata in formats (SVF/SVF2) that browsers can render efficiently.

Webhooks deliver real-time notifications when events occur in APS services. Instead of polling for changes, your application registers callback URLs to receive HTTP POST requests when files are uploaded, translations complete, or other events happen.

A Work Item is a request to execute an Activity with specific inputs. It's an asynchronous job that processes files through the specified engine and AppBundles, producing outputs that can be downloaded or stored in OSS.

A workflow is an automated process defined in a configuration file (e.g., GitHub Actions YAML). Workflows specify triggers, jobs, steps, and environments for automated tasks.

YAML is a human-readable data format commonly used for configuration files. GitHub Actions workflows use YAML. RAPS can output results in YAML format (`--output yaml`).