获取应用管理员的备注

aki发表于:2024年05月01日 11:08:29更新于:2024年05月08日 09:56:49

获取应用管理员的备注

获取应用管理员的备注及其设置。
使用此功能时,需启用“开发中的新功能”中的“用于获取或更新应用设置中应用管理员专用备注的REST API”。

URL

URL分正式环境和测试环境。

获取正式环境的设置时

  • 常规应用
    https://sample.cybozu.cn/k/v1/app/adminNotes.json

  • 来宾空间的应用
    https://sample.cybozu.cn/k/guest/GUEST_SPACE_ID/v1/app/adminNotes.json

获取测试环境的设置

  • 常规应用
    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 方法

GET

必要的访问权限

  • 应用管理权限

请求

参数

参数名称类型必须说明
app数值或字符串必须应用 ID

应答

属性

属性名称类型说明
content字符串应用管理员的备注正文
如未设置,返回空字符。
includeInTemplateAndDuplicates布尔值使用应用模版或通过重复利用来创建应用时,是否包含该备注内容
  • true:包含

  • false:不包含

revision字符串应用的设置的版本号
应答的范例
{
   "content": "<div>应用管理员的备注</div>",
   "includeInTemplateAndDuplicates": true,
   "revision": "2"
 }