更改应用管理员的备注
更改应用管理员的备注及其设置。
使用此功能时,需启用“开发中的新功能”中的“用于获取或更新应用设置中应用管理员专用备注的REST API”。
URL
常规应用
https://sample.cybozu.cn/k/v1/preview/app/adminNotes.json来宾空间的应用
https://sample.cybozu.cn/k/guest/GUEST_SPACE_ID
/v1/preview/app/adminNotes.json
HTTP 方法
PUT
必要的访问权限
应用管理员
请求
参数
参数名称 | 类型 | 必须 | 说明 |
---|---|---|---|
app | 数值或字符串 | 必须 | 应用 ID |
content | 字符串 | 可省略 | 应用管理员的备注 字符数必须在0~10,000个字符的范围内。 省略时不做更改。 |
includeInTemplateAndDuplicates | 布尔值或字符串 | 省略可 | 使用应用模版或通过重复利用的方式新建应用时,是否包含该备注内容。
|
revision | 数值或字符串 | 可省略 | 要更改的版本号 与实际版本号不一致时,将报错,不做更改。 值指定为“-1”时,或者不指定时,不对版本号进行验证。 |
请求范例
头部
{ "X-Cybozu-API-Token": "API_TOKEN", "Content-Type": "application/json" }
正文
{ "app": 1, "content": "<div>管理员的备注</div>", "includeInTemplateAndDuplicates": false, "revision": 2 }
应答
属性
属性名称 | 类型 | 说明 |
---|---|---|
revision | 字符串 | 更改应用设置之后的版本号。 |