Knowledge Base

Search documentation by Keyword

5.1.3 Kanban items (data)

Items of the Kanban

When the project is started and the request to get the columns is send and received, BOA will fill the board with the existing items. The request is send to the onclick endpoint from the kanban json data.

Request: url/onclick.endpoint?key=itemid&labels=1

Sample: url/files/projdata?key=EON&labels=1

Result: items for the Kanban project.

{
"file": "projdata",
"labels": [
{
"display": "",
"fieldname": "id",
"length": 8,
"inputtype": "hidden"
},
{
"display": "Label:",
"tooltip": "",
"fieldname": "label",
"length": 2,
"pattern": "[0-9]{1,2}",
"inputtype": "text",
"kanbantype": "tags",
"newline": true,
"labelwidth": 2,
"fieldwidth": 2
},
{
"display": "Subject:",
"tooltip": "",
"fieldname": "subject",
"length": 40,
"inputtype": "text",
"kanbantype": "text",
"newline": true,
"labelwidth": 2,
"fieldwidth": 8
},
{
"display": "Description",
"tooltip": "",
"fieldname": "descrip",
"length": 0,
"inputtype": "multiline",
"kanbantype": "content",
"newline": true,
"labelwidth": 2,
"fieldwidth": 4,
"fieldheight": 10
},
{
"display": "Status:",
"tooltip": "",
"fieldname": "status",
"length": 1,
"pattern": "[0-9]{1}",
"inputtype": "text",
"kanbantype": "status",
"newline": true,
"labelwidth": 2,
"fieldwidth": 4
},
{
"display": "Color:",
"tooltip": "",
"fieldname": "color",
"length": 7,
"inputtype": "text",
"kanbantype": "color",
"newline": true,
"labelwidth": 2,
"fieldwidth": 2
},
{
"display": "Sort Order:",
"tooltip": "",
"fieldname": "sortorder",
"length": 8,
"inputtype": "sort",
"newline": true,
"labelwidth": 2,
"fieldwidth": 2
}
],
"data": [
{
"id": "4",
"label": 1,
"subject": "Status 2 Label 1",
"descrip": "Status 2 Label 1",
"status": "1",
"color": "#5dc3f0",
"sortorder": 4
},
{
"id": "35",
"label": 5,
"subject": "Testing kanban",
"descrip": "Description for testing",
"status": "1",
"color": " ",
"sortorder": 35
},
{
"id": "39",
"label": 5,
"subject": "BBB1",
"descrip": "BBB12222",
"status": "2",
"color": " ",
"sortorder": 39
}

]
]
}
  • file: name of the used data table
  • labels: labels as used with the forms. See the documentation for the form definitions..
  • widgettype: this is a special type specific for the Kanban. Each item has several elements. These elements are named widgettype. This way the different elements can be named:
    • text: the subject of the item. This comes in the header.
    • content: the content of the item, this is the body of the item.
    • tags: keywords to place in the footer of the item.
    • status: defines in which column the item must be shown. See the column configuration for the definition of the status. When an item is moved from one column to another, the status will change. This will be updated by a PUT.
    • color: color value in hex. format.

inputtype sort: this is a form element to define the sortorder in the columns. An item can be moved in the column. To save the new position there is a special inputtype needed. This will be send to the endpoint with a PUT. When an item is moved in a column, all the items from that column can get a new order. In that case all the new positions will be send to the endpoint in one request.

data: There can be extra data elements that can be used when editing or adding an item. A complete form will appear, and all the data can be filled in. So also data that isn’t visible in the project board itself.