To get an ordered list of entities for a board (hardwired max 500 entities):
Kanban board entities
<th>
Description
</th>
<th>
Example
</th>
<th>
More info
</th>
</tr>
<td>
The API area
</td>
<td>
kanbanboard.json
</td>
</tr>
<tr>
<td>
Action
</td>
<td>
Entities
</td>
<td>
&action=entities
</td>
</tr>
<tr>
<td>
General
</td>
<td>
Parameters described in overview
</td>
<td>
user=user&password=user&version=3.3
</td>
<td>
[Overview](ref:overview-2)
</td>
</tr>
<tr>
<td>
Company
</td>
<td>
Company number
</td>
<td>
company=1
</td>
</tr>
<tr>
<td>
View
</td>
<td>
Stored filter applied
</td>
<td>
view=-1700
</td>
<td>
[Using views](ref:models)
</td>
</tr>
<tr>
<td>
<input mandatory>UUID
</td>
<td>
Kanban Board UUID
</td>
<td>
&uuid=26E08BFD3AF56A4FB9C5C843281A490D
</td>
</tr>
<tr>
<td>
<input optional>Date Range
</td>
<td>
Kanban Date Range
</td>
<td>
&daterange=34
</td>
</tr>
<tr>
<td>
<input optional>Kanban Status
</td>
<td>
Kanban Status
</td>
<td>
&kanbanstatus=TODO
</td>
</tr>
<tr>
<td>
<input optional>Search
</td>
<td>
Kanban Search
</td>
<td>
&search="note details"
</td>
</tr>
<tr>
<td>
Response
</td>
<td>
Returned data
</td>
<td>
A JSON string containing the data
</td>
</tr>
Parameter |
---|
API |
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"
}