To get an ordered list of entities for a board (hardwired max 500 entities):
Kanban board entities
Parameter | Description | Example | More info |
---|---|---|---|
API | The API area | kanbanboard.json | |
Action | Entities | &action=entities | |
General | Parameters described in overview | user=user&password=user&version=3.3 | |
Company | Company number | company=1 | |
View | Stored filter applied | view=-1700 | |
| Kanban Board UUID | &uuid=26E08BFD3AF56A4FB9C5C843281A490D | |
| Kanban Date Range | &daterange=34 | |
| Kanban Status | &kanbanstatus=TODO | |
| Kanban Search | &search="note details" | |
Response | Returned data | A JSON string containing the data |
Example request:
Request for data (list of records using specified model)
http://<SERVER>/jsonAPI/kanbanboard.json?user=user&password=user&version=3.3&company=3&action=entities&uuid=26E08BFD3AF56A4FB9C5C843281A490D&search=&view=45083&daterange=34&kanbanstatus=TODO&search="notes details"
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 18,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"kbentityAttachments": "1",
"kbentityAvatar": "/custom/User_5.jpg",
"kbentityChecklistsItemsTotal": 2,
"kbentityChecklistsItemsComplete": 1,
"kbentityClientCode": "3/BASS",
"kbentityClientName": "Company - this is it's name",
"kbentityColumnOrder": 1,
"kbentityCommentsTotal": 0,
"kbentityDateUtc": "2018-10-04",
"kbentityDescription": "",
"kbentityDetails": "",
"kbentityHeading": "8016",
"kbentityHoursRequested": 0,
"kbentityJob": "3/00001017",
"kbentityJobDescription1st": " 0.00",
"kbentityJobPhase": "",
"kbentityJobPhaseSimple": "",
"kbentityJobSimple": "1017",
"kbentityOrder": 65536,
"kbentityPhaseDescription1st": "",
"kbentityPriorityDescription": "Med",
"kbentityStatus": "OPEN",
"kbentityStatusCode": "TODO",
"kbentityTimeUtc": "07:00:00",
"kbentityType": "ACTIVITY",
"kbentityTypeDescription": "Requisition",
"kbentityUserName": "Mike Pender",
"kbentityUserIsWatching": false,
"kbentityUuid": "B8E72E12F4B51648A2B2FA14C43749D1"
}