Gets the deployment status of the App settings for multiple Apps.
Permissions
- App Management Permissions are needed.
Request Parameters
| Parameter |
Value |
Required |
Description |
| apps |
Array |
Required |
The list of Apps to check the deploy statuses of. The Maximum limit is 300.
If Apps in Guest Spaces are specified, all Apps specified in the request must belong to that Guest Space. |
Sample Request
1
2
3
4
5
6
7
8
9
10
11
|
var body = {
'apps': [1, 1001]
};
kintone.api(kintone.api.url('/k/v1/preview/app/deploy.json', true), 'GET', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});
|
XMLHttpRequest
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
var params = '?apps[0]=1&apps[1]=1001';
var url = 'https://{subdomain}.kintone.com/k/v1/preview/app/deploy.json' + params;
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
if (xhr.status === 200) {
// success
console.log(JSON.parse(xhr.responseText));
} else {
// error
console.log(JSON.parse(xhr.responseText));
}
};
xhr.send();
|
Response Parameters
| Parameter |
Type |
Description |
| apps |
Array |
A list of objects with data of deploy statuses. |
| apps[].app |
String |
The App ID. |
| apps[].status |
String |
The status of the deployment of App settings.- PROCESSING: The App settings are being deployed.
- SUCCESS: The App settings have been deployed.
- FAIL: An error occurred, and the deployment of App settings failed.
- CANCEL: The deployment of App settings was canceled, due to the deployment of other App settings failing.
|
Sample Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
{
"apps": [
{
"app": "8",
"status": "PROCESSING"
},
{
"app": "9",
"status": "PROCESSING"
},
{
"app": "10",
"status": "PROCESSING"
}
]
}
|
