REST routes overview
This page provides a complete list of all REST routes, along with brief descriptions and links to detailed documentation.
Before exploring the details of each route, it's a good idea to review Working with Server.
For easy navigation, you can use the tabs below or the side menu:
- The side menu groups routes by HTTP methods
- The tabs below help quickly identify which routes correspond to specific operations
- cards
- rows
- columns
- links
- uploads
These routes handle operations related to cards:
HTTP method | Route | Description |
---|---|---|
GET | /cards | Retrieves data for all cards and returns a JSON object containing an array of card objects |
POST | /cards | Creates a new card and returns a JSON object with the ID of the new card |
PUT | /cards | Updates the data of a specified card and returns an empty JSON object |
PUT | /cards/id/move | Moves cards to a specified position |
DELETE | /cards | Deletes the specified card data |
These routes are used for managing rows (swimlanes):
HTTP method | Route | Description |
---|---|---|
GET | /rows | Retrieves data for all rows and returns a JSON object with an array of row (swimlane) objects |
POST | /rows | Adds a new row and returns a JSON object containing the row ID |
PUT | /rows | Updates data for a specified row (swimlane) and returns an empty JSON object |
PUT | /rows/id/move | Moves a row to a specified position |
DELETE | /rows | Deletes the data of a specified row |
These routes allow managing columns:
HTTP method | Route | Description |
---|---|---|
GET | /columns | Retrieves data for all columns and returns a JSON object with an array of column objects |
POST | /columns | Adds a new column and returns a JSON object containing the column ID |
PUT | /columns | Updates data for a specified column and returns an empty JSON object |
PUT | /columns/id/move | Moves a column to a specified position |
DELETE | /columns | Deletes data for a specified column |