GetBuildingStatus
This API can be used to get Build Installer status of either AhsayCBS build or Client’s build.
The settings can be found on the AhsayCBS web console at:
- System Settings > Basic > Administrative Access > %system_user% > Rebrand Web Console > Build Installers
- System Settings > Basic > Administrative Access > %system_user% > Rebrand Clients > Build Installers
URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetBuildingStatus.do?product=%product%
https://CBS.EXAMPLE.COM/cbs/api/json/GetBuildingStatus.do?product=%product%&mode=single
https://CBS.EXAMPLE.COM/cbs/api/json/GetBuildingStatus.do?product=%product%&mode=all
https://CBS.EXAMPLE.COM/cbs/api/json/GetBuildingStatus.do?product=OBC&mode=single&sBuildAdminName=SubAdmin
Available Since Version: 9.1
Parameters
Key | Type | Description |
---|---|---|
SysUser | String | Username of an AhsayCBS System User with Admin, API or Read-Only API role. |
SysPwd | String | Password matching SysUser. |
Query Parameters
Key | Type | Description |
---|---|---|
product | String | Either CBS or OBC |
mode | String | (optional) all or single |
Return Values
When mode is not set to "all"
Key | Type | Description |
---|---|---|
Status | String | "OK" or "Error" |
lastUpdateTime | String | Last update time of the build process, in yyyy-MM-dd hh:mm:ss |
message | String | Last updated message for the build process. |
status | String | Build status: uploaded, waiting (idle), queued, building, finished. |
Message | String | Error message, it only appears if "status" displays "Error". |
When mode is set to "all"
Key | Type | Description |
---|---|---|
Status | String | "OK" or "Error" |
buildStatus | Array of BuildStatus | A list of build status for the System Users. |
Message | String | Error message, it only appears if "status" displays "Error". |
JSON Objects
Array:BuildStatus
Key | Type | Description |
---|---|---|
lastUpdateTime | String | Last update time of the build process, in yyyy-MM-dd hh:mm:ss |
message | String | Last updated message for the build process. |
status | String | Build status: uploaded, waiting (idle), queued, building, finished. |
Id | String | System user ID (0='system' username). |
Examples
Example 1: Product is CBS (Input = ?product=CBS)
INPUT
{
"SysUser":"api_user",
"SysPwd":"qWeRtY123456!@#$%"
}
OUTPUT
{
"Status":"OK",
"lastUpdatedTime":"2024-05-05 07:40:57",
"message":"",
"status":"waiting"
}
Example 2: Mode is set to all (Input = ?product=OBC&mode=all)
INPUT
{
"SysUser":"api_user",
"SysPwd":"qWeRtY123456!@#$%"
}
OUTPUT
{
"Status":"OK",
"buildStatus": [
{
"lastUpdatedTime":"2024-06-03 12:20:10",
"id":"0",
"message":"",
"status":"waiting"
}
]
}