aps_issues_docs
Retrieve ACC Issues API quick-reference documentation covering project ID format, statuses, workflow, API paths, filters, sort options, and error troubleshooting. Call this before your first Issues interaction.
Instructions
Return ACC Issues API quick‑reference documentation: project ID format, statuses, typical workflow, raw API paths, common filters, sort options, and error troubleshooting. Call this before your first Issues interaction.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:785-794 (registration)Tool registration for 'aps_issues_docs' in the TOOLS array. Defines name, description, and empty inputSchema (no parameters).
// 18 ── aps_issues_docs { name: "aps_issues_docs", description: "Return ACC Issues API quick‑reference documentation: " + "project ID format, statuses, typical workflow, raw API paths, " + "common filters, sort options, and error troubleshooting. " + "Call this before your first Issues interaction.", inputSchema: { type: "object" as const, properties: {} }, }, - src/index.ts:1443-1446 (handler)Tool handler for 'aps_issues_docs' – simply returns the ISSUES_DOCS constant wrapped in an ok() response.
// ── aps_issues_docs ───────────────────────────────────────── if (name === "aps_issues_docs") { return ok(ISSUES_DOCS); } - src/aps-issues-helpers.ts:274-348 (helper)The ISSUES_DOCS constant containing the full quick-reference documentation string (project ID format, statuses, workflow, raw API paths, filters, sort options, error troubleshooting).
export const ISSUES_DOCS = `# ACC Issues API – Quick Reference ## Important: Project ID Format The Issues API uses project IDs **without** the 'b.' prefix. - Data Management ID: \`b.a4be0c34a-4ab7\` - Issues API ID: \`a4be0c34a-4ab7\` The simplified tools handle this conversion automatically – you can pass either format. ## Statuses \`draft\` → \`open\` → \`pending\` / \`in_progress\` / \`in_review\` / \`completed\` / \`not_approved\` / \`in_dispute\` → \`closed\` ## Typical Workflow \`\`\` 1. aps_issues_get_types project_id → get issue categories & types 2. aps_issues_list project_id + filters → browse issues 3. aps_issues_get project_id + issue_id → single issue details 4. aps_issues_create project_id + title + subtype → create new issue 5. aps_issues_update project_id + issue_id + fields → update issue 6. aps_issues_get_comments project_id + issue_id → read comments 7. aps_issues_create_comment project_id + issue_id + body → add comment \`\`\` ## Raw API Paths (for aps_issues_request) | Action | Method | Path | |--------|--------|------| | User profile | GET | construction/issues/v1/projects/{projectId}/users/me | | Issue types | GET | construction/issues/v1/projects/{projectId}/issue-types?include=subtypes | | Attribute definitions | GET | construction/issues/v1/projects/{projectId}/issue-attribute-definitions | | Attribute mappings | GET | construction/issues/v1/projects/{projectId}/issue-attribute-mappings | | Root cause categories | GET | construction/issues/v1/projects/{projectId}/issue-root-cause-categories?include=rootcauses | | List issues | GET | construction/issues/v1/projects/{projectId}/issues | | Create issue | POST | construction/issues/v1/projects/{projectId}/issues | | Get issue | GET | construction/issues/v1/projects/{projectId}/issues/{issueId} | | Update issue | PATCH | construction/issues/v1/projects/{projectId}/issues/{issueId} | | List comments | GET | construction/issues/v1/projects/{projectId}/issues/{issueId}/comments | | Create comment | POST | construction/issues/v1/projects/{projectId}/issues/{issueId}/comments | ## Common Filters (for aps_issues_list) - \`filter[status]\` – open, closed, pending, in_progress, etc. - \`filter[assignedTo]\` – Autodesk user/company/role ID - \`filter[issueTypeId]\` – category UUID - \`filter[issueSubtypeId]\` – type UUID - \`filter[dueDate]\` – YYYY-MM-DD - \`filter[createdAt]\` – YYYY-MM-DDThh:mm:ss.sz - \`filter[search]\` – search by title or display ID - \`filter[locationId]\` – LBS location UUID - \`filter[rootCauseId]\` – root cause UUID - \`filter[displayId]\` – chronological issue number ## Sort Options \`createdAt\`, \`updatedAt\`, \`displayId\`, \`title\`, \`status\`, \`assignedTo\`, \`dueDate\`, \`startDate\`, \`closedAt\` Prefix with \`-\` for descending (e.g. \`-createdAt\`). ## Region Header (x-ads-region) Possible values: \`US\` (default), \`EMEA\`, \`AUS\`, \`CAN\`, \`DEU\`, \`IND\`, \`JPN\`, \`GBR\`. Pass as the \`region\` parameter on any Issues tool. ## Creating an Issue (required fields) - \`title\` – the issue title (max 10,000 chars) - \`issueSubtypeId\` – the type UUID (get from aps_issues_get_types) - \`status\` – initial status (e.g. 'open') ## Error Troubleshooting | Code | Common Cause | Fix | |------|-------------|-----| | 401 | Expired / invalid token | Check credentials; token auto‑refreshes | | 403 | App not provisioned or insufficient scopes | Admin → Account Settings → Custom Integrations. Ensure scope includes 'data:read data:write' for write operations | | 404 | Wrong project ID or issue not found | Ensure project ID has no 'b.' prefix for raw API calls | | 409 | Conflict (e.g. duplicate) | Check for existing resource | | 422 | Attachment limit reached (100/issue) | Remove old attachments first | ## Full Specification - OpenAPI: https://github.com/autodesk-platform-services/aps-sdk-openapi/blob/main/construction/issues/Issues.yaml `;