REST routes overview
This page gives you the list of all REST routes with their short description and links to pages with more details.
Before you dive into each route description, it's recommended to read about Working with Server.
For quick navigation you can use either the tabs below or the side menu:
- The side menu shows routes grouped by HTTP methods
- To quickly find which routes to use for which operations, use the tabs below
- cards
- rows
- columns
- links
- uploads
Use the next routes to perform operations on cards:
HTTP method | Route | Description |
---|---|---|
GET | /cards | Gets data on all cards and returns a json object with an array of cards objects |
POST | /cards | Creates a new card and returns a json object with a new card ID |
PUT | /cards | Updates data on a specified card and returns an empty json object |
PUT | /cards/id/move | Moves cards to a specified position |
DELETE | /cards | Deletes data on a card |
Use the next routes to perform operations on rows (swimlanes):
HTTP method | Route | Description |
---|---|---|
GET | /rows | Gets data on all rows and returns a json object with an array of objects with rows (swimlanes) data |
POST | /rows | Adds a new row and returns a json object with the row ID in it |
PUT | /rows | Updates data on a specified row (swimlane) and returns an empty json object |
PUT | /rows/id/move | Moves a row to a specified position |
DELETE | /rows | Deletes data on a row |
Use the next routes to perform operations on columns:
HTTP method | Route | Description |
---|---|---|
GET | /columns | Gets data on all columns and returns a json object with an array of objects with columns data |
POST | /columns | Adds a new column and returns a json object with the row ID in it |
PUT | /columns | Updates data on a specified column and returns an empty json object |
PUT | /columns/id/move | Moves a column to a specified position |
DELETE | /columns | Deletes data on a column |