Get App Admin Notes
Gets notes for app administrators and their settings.
Pre-live settings
Apps may hold pre-live settings that have not yet been deployed to the live App.
Access the pre-live settings with the below URL.
| URL |
https://{subdomain}.kintone.com/k/v1/preview/app/adminNotes.json |
| URL(guest space) |
https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/adminNotes.json |
Permissions
- App Management Permissions are needed.
Request Parameters
| Parameter |
Value |
Required |
Description |
| app |
Integer or String |
Yes |
The App ID. |
Sample Request
1
2
3
4
5
6
7
8
9
10
11
|
var body = {
'app': 1
};
kintone.api(kintone.api.url('/k/v1/app/adminNotes.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 url = 'https://{subdomain}.kintone.com/k/v1/app/adminNotes.json?app=1';
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 |
| content |
String |
The content of the notes. If not set, an empty string is returned. |
| includeInTemplateAndDuplicates |
Boolean |
The permission settings to include this note in app templates or duplicatestrue: includefalse: do not include
|
| revision |
String |
The revision number of the App settings. |
Sample Response
1
2
3
4
5
|
{
"content": "Notes for app administrators",
"includeInTemplateAndDuplicates": true,
"revision": "2"
}
|
