All endpoints expect an Authorization header in the following format:
Authorization: Bearer <your token here>
Refer to the token generation documentation if you are unsure how to generate a token.
GET app.visibuild.com.au/api/v2/projects
Returns basic information on all active projects, including IDs and names. IDs are universally unique and do not change over time.
Example response
{
"data": {
"projects": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Example Project"
},
{
"id": "00000000-0000-0000-000000000001",
"name": "Example Project 2"
}
]
}
}
GET app.visibuild.com.au/api/v2/projects/visi-counts
Under the visiCounts key there are keys for each Visi type. There are 8 keys for each set of counts: the 6 statuses plus complete and total. complete is always the sum of na, cantClose, and closed and provided for convenience.
total will always be the sum of all 6 statuses.
skippedHoldPoints counts the number of hold points across the entire project that have been skipped. That is, hold points that originated in a template that were still incomplete when a Visi that occurs after it in the template was completed. For example:
Example response
{
"data": {
"projects": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Example Project",
"visiCounts": {
"inspection": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"task": {
"open": 2,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 2
},
"incorrectWorks": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"ncr": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"defect": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"incompleteWorks": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"holdPoint": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"witnessPoint": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
}
},
"skippedHoldPoints": 0
}
]
}
}