ConnectCloud Forge API
Software development: projects with linked repositories, items (APP-12) with sections, links, milestones, iterations and the backlog, views, automations, and the handoff and conversion of items to and from desk.
The interactive reference needs JavaScript. Every operation also has its own page:
Status
GET /status What the caller may do in forge (tenant:forge:read)GET /live Change notices for open forge pages (tenant:forge:read)
Projects
Members
Repositories
Configuration
GET /projects/{key}/config Project page bootstrap (project, configuration, members, repositories) (tenant:forge:read)POST /projects/{key}/config/reorder Set the order of a configuration collection (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/statuses List the statuses of a project (tenant:forge:read)POST /projects/{key}/statuses Create a status (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/statuses/{id} Delete a status (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/statuses/{id} Change a status (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/workflows List the workflows of a project (tenant:forge:read)POST /projects/{key}/workflows Create a workflow (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/workflows/{id} Delete a workflow (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/workflows/{id} Change a workflow (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/item-types List the item types of a project (tenant:forge:read)POST /projects/{key}/item-types Create an item type (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/item-types/{id} Delete an item type (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/item-types/{id} Change an item type (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/labels List the labels of a project (tenant:forge:read)POST /projects/{key}/labels Create a label (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/labels/{id} Delete a label (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/labels/{id} Change a label (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/ownerships List the ownerships (code ownership) of a project (tenant:forge:read)POST /projects/{key}/ownerships Create an ownership (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/ownerships/{id} Delete an ownership (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/ownerships/{id} Change an ownership (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/teams List the teams of a project (tenant:forge:read)POST /projects/{key}/teams Create a team (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/teams/{id} Delete a team (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/teams/{id} Change a team (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/codeowners Render the ownerships as a CODEOWNERS file (tenant:forge:read)GET /projects/{key}/custom-fields List the custom fields of a project (tenant:forge:read)POST /projects/{key}/custom-fields Create a custom field (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/custom-fields/{id} Delete a custom field (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/custom-fields/{id} Change a custom field (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/item-templates List the item templates of a project (tenant:forge:read)POST /projects/{key}/item-templates Create an item template (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/item-templates/{id} Delete an item template (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/item-templates/{id} Change an item template (tenant:forge:write and maintainer, or tenant:forge:admin)GET /projects/{key}/section-defs List the section definitions of a project (tenant:forge:read)POST /projects/{key}/section-defs Create a section definition (tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /projects/{key}/section-defs/{id} Delete a section definition (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/section-defs/{id} Change a section definition (tenant:forge:write and maintainer, or tenant:forge:admin)
Automations
Milestones
Iterations
GET /projects/{key}/iterations List the iterations of a project (tenant:forge:read)POST /projects/{key}/iterations Create an iteration (tenant:forge:write and, as a member, at least developer)GET /projects/{key}/iterations/{id} Read an iteration with its progress (tenant:forge:read)DELETE /projects/{key}/iterations/{id} Delete an iteration (tenant:forge:write and, as a member, at least developer)PATCH /projects/{key}/iterations/{id} Change an iteration (tenant:forge:write and, as a member, at least developer)POST /projects/{key}/iterations/{id}/start Start an iteration (tenant:forge:write and, as a member, at least developer)POST /projects/{key}/iterations/{id}/close Close an iteration (tenant:forge:write and, as a member, at least developer)GET /projects/{key}/backlog Read the backlog of a project (tenant:forge:read)
Metrics
Templates
Views
GET /views List saved views (tenant:forge:read)POST /views Save a view (tenant:forge:read for a personal view; a project view tenant:forge:write and maintainer, or tenant:forge:admin)DELETE /views/{id} Delete a saved view (its owner for a personal view; a project view tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /views/{id} Change a saved view (its owner for a personal view; a project view tenant:forge:write and maintainer, or tenant:forge:admin)GET /views/{id}/items Run a saved view (tenant:forge:read)
Items
GET /items Search items of every visible project (tenant:forge:read)POST /items/bulk Change several items at once (tenant:forge:write and, as a member, at least developer, decided per item)GET /items/{ref} Get an item with its sections (tenant:forge:read)GET /projects/{key}/items List the items of a project (tenant:forge:read)POST /projects/{key}/items Create an item (tenant:forge:write, or any member role in the project; iterationId and milestoneId need tenant:forge:write and, as a member, at least developer)DELETE /projects/{key}/items/{number} Delete an item for good (tenant:forge:write and maintainer, or tenant:forge:admin)PATCH /projects/{key}/items/{number} Change an item (tenant:forge:write and, as a member, at least developer; the reporter may change only confidential)POST /projects/{key}/items/{number}/rank Move an item in the project's order (tenant:forge:write and, as a member, at least developer)POST /projects/{key}/items/{number}/move Move an item to another project (tenant:forge:write and, as a member, at least developer in the source; create rights in the target)GET /projects/{key}/items/{number}/children List the children of an item (tenant:forge:read)PUT /projects/{key}/items/{number}/assignees Replace the assignees of an item (tenant:forge:write and, as a member, at least developer)POST /projects/{key}/items/{number}/assignees/add Add one assignee to an item (tenant:forge:write and, as a member, at least developer)PUT /projects/{key}/items/{number}/labels Replace the labels of an item (tenant:forge:write and, as a member, at least developer)POST /projects/{key}/items/{number}/labels/add Add one label to an item (tenant:forge:write and, as a member, at least developer)POST /projects/{key}/items/{number}/labels/remove Remove one label from an item (tenant:forge:write and, as a member, at least developer)POST /projects/{key}/items/{number}/transition Move an item to a status or a status category (tenant:forge:write and, as a member, at least developer)GET /projects/{key}/items/{number}/links List the links of an item (tenant:forge:read)POST /projects/{key}/items/{number}/links Link an item to another item (tenant:forge:write and, as a member, at least developer)DELETE /projects/{key}/items/{number}/links/{id} Remove a link (tenant:forge:write and, as a member, at least developer)GET /projects/{key}/items/{number}/events History of an item (tenant:forge:read)PUT /projects/{key}/items/{number}/watch Watch an item (tenant:forge:read)DELETE /projects/{key}/items/{number}/watch Stop watching an item (tenant:forge:read)
Handoffs
Attachments
Comments
Sections
Agent