通用说明

GET 请求参数

在没特殊说明情况下,以下所有应用接口遵循 JSON API 规范,同时也支持以下 JSON API 中约定的参数。

参数 说明 适用接口
include 关联资源属性 没特别说明情况,可适用所有列表或单个实体查看接口
sort 列表排序属性 没特别说明情况,可适用所有列表接口,降序在字段前加-表示
page 分页属性 没特别说明情况,可适用所有列表接口
filter 过滤属性 根据具体接口说明使用

目前不支持 JSON API 中提到的 fields 参数

此外,支持 page 参数的接口,一般情况下也会支持 per_page 参数,此参数不在 JSON API 规范中。

参数 说明 适用接口
per_page 每页返回数 没特别说明情况,支持1-100之间所有整数,不传入时默认为20

POST/PATCH 请求参数

当第三方需要创建/更新资源时,需要向服务器提交一个符合 JSON API 规范的document。 由于拼凑标准格式也有一定复杂,本文提供的 SDK 中会进行一层封装,降低接入门槛。

开发者也可以从 JSON API 官网中选择合适的代码库进行开发。

响应参数

为让乐享更好地和公司OA等网站更好地结合,乐享开放接口的部分资源中返回乐享页面地址,如下示例所示。

links":{
    "platform":"https://xxx.lexiangla.com/teams/k00001/docs/docid_123456"
}