PI Board Items — Field reference
Properties returned by the /items endpoint. Parent items are Features; child items are Stories. Remember that fields with no value are omitted from the response.
Parent item (Feature) properties
| Parameter |
Type |
Description |
Example |
itemType |
String |
Issue type of the parent item |
Epic |
iterationPath |
String |
Iteration path of the parent item |
ART Project level 1/ Sprint 2 |
createdOn |
Double |
Creation date (long date format) |
1721943914681 |
kendisId |
Double |
ID of the parent item |
64bd1e57e87523ghjD442Fe2 |
azureId |
Double |
Unique key for parent item in Azure |
37665 |
summary |
String |
Summary / title of the parent item |
Improve DWH Nightly Sync |
updatedBy |
String |
Username of the item editor |
sample@kendis.io |
teamsAndSprints |
String |
Sprint details as ID & associated team name ID |
1879e6d2-43ea-… |
cardType |
String |
Issue type of the parent item in Azure |
User Story |
updatedOn |
Double |
Item update date (long date format) |
1721943914681 |
createdBy |
String |
Username of the item creator |
sample@kendis.io |
areaPath |
String |
Area path of the parent item |
ART Project level 1/ Row 3 |
status |
String |
ID for the parent item status |
66a2c67609da964694561e7d |
children |
JSON |
Child items for the feature |
— |
externalKey |
String |
Typed external key for Kendis-only cards |
MPLP-281 |
externalUrl |
String |
Typed external URL for Kendis-only cards |
http://sampleURL.com |
pageSize |
Double |
Page size for pagination (default 50) |
50 |
pageStart |
Double |
Page number (default 0) |
0 |
parentDescription |
String |
Title of the parent item of the child |
CRM system updates v1.5 |
estimates |
Double |
Completion estimates for the parent item |
1.0 |
Child item (Story) properties
| Parameter |
Type |
Description |
Example |
summary |
String |
Title of the child item |
Improve DWH Nightly Sync |
kendisId |
String |
Unique key for the child item in Kendis |
64bd1e57e87123ghjD1974f0 |
parentId |
String |
Parent ID of the child item |
89ce2184f87123fdeD1951c3 |
estimates |
Double |
Completion estimates for the child item |
2.0 |
status |
String |
Status ID of the child item |
89ce2184f87123fdeD1951c3 |
azureId |
Double |
Unique key for the child item in Azure |
389 |
teamsAndSprints |
Double |
Sprint ID & team ID of the child item |
00d7e-57e87123-1e10jD1-9fr132 |
externalKey |
String |
Typed external key |
MPLP-281 |
externalUrl |
String |
Typed external URL |
http://sampleURL.com |
pageSize |
Double |
Page size for pagination (default 50) |
50 |
pageStart |
Double |
Page number (default 0) |
0 |
Default fields
If you don't pass a fields array, these defaults are returned. Add any field from the tables above to a
fields array for a more detailed response.
| For Features |
For Stories |
itemType |
kendisId |
iterationPath |
azureId |
kendisId |
parentId |
azureId |
summary |
summary |
status → ID |
teamsAndSprints |
estimates |
areaPath |
teamsAndSprints |
cardType |
externalKey |
updatedOn |
externalUrl |
status |
|
externalKey |
|
externalUrl |
|
Sprint properties
| Parameter |
Type |
Description |
Example |
id |
Double |
Unique key for the sprint |
68fe3e57e86863miD132K16 |
label |
String |
Prefix of the sprint |
S2 |
title |
String |
Title of the sprint |
Iteration 3 |
isIPSprint |
Double |
Flag for IP Sprint |
False |
Team properties
| Parameter |
Type |
Description |
Example |
id |
Double |
Unique ID associated with the team |
66a2c44309da962391161e65 |
color |
Double |
Hex colour code for the team |
#1947pa |
label |
String |
Prefix for the team |
Dev |
title |
String |
Title of the team |
Team Dev |
Status properties
Parent and child statuses share the same shape:
| Parameter |
Type |
Description |
Example |
id |
String |
Unique ID associated with the status |
68fe1e45e13293frtD905mL2 |
rowStatus |
Double |
Row status |
0 |
source |
Double |
Source of the status |
0 |
title |
String |
Title of the status |
Closed |
color |
Double |
Hex colour for the status |
#2001nr |
updated |
String |
Updation status |
True |
category |
String |
Status category |
ToDo |