知行之桥 2023

API 中的资源默认使用 JSON 格式的 OData 作为访问数据的 REST 协议，也支持其他 Web 服务格式，包括 OData（Atom），SOAP，HTML 和 CSV。

资源通常是项目集合的接口，可以使用以下 HTTP 方法访问：

HTTP GET 请求用于从指定的资源中检索数据。如果资源是对象的集合，GET 请求可用于检索服务器特定对象或整个对象集合。

HTTP POST 请求用于在资源中创建新对象，请求必须包含实体的信息。此方法仅适用于对象集合的资源。

HTTP PUT 请求用于更新资源。

HTTP DELETE 请求用于删除资源。此方法仅适用于对象集合的资源。

函数用来扩展资源上的函数集，也可用来在服务器上执行不相关的函数。

200 OK	服务器已成功处理请求。
201 Created	请求成功，服务器已创建指定的资源。
204 No Content	如果请求的资源有空值，或者服务使用首选项 return=minimal，则请求返回此状态。
400 Bad Request	请求未被理解或缺少必需的参数。
401 Unauthorized	用户未经身份认证或未经授权访问此资源。
403 Forbidden	此资源拒绝访问。
404 Not Found	此响应表示资源不存在。
405 Method Not Allowed	不允许使用指定的 HTTP 方法访问此资源。
501 Not Implemented	服务器不支持完成请求所需的功能。

身份认证令牌（Authtoken）是用户向 API进行身份认证的唯一标识符。如需使用身份认证令牌（Authtoken），请以管理员身份登录，并单击用户管理。在本节中，可以管理用户的权限和身份认证令牌（Authtoken），还可以指定访问 API 的 IP 地址。

调用 API，可以通过多种方式指定身份认证令牌（Authtoken）。

使用基本身份认证时，用户的身份认证令牌（Authtoken）作为密码。

将带有身份认证令牌（Authtoken）的 "x-cdata-authtoken" 添加到 HTTP 头请求中。

将身份认证令牌（Authtoken）指定为“@authtoken”，作为 HTTP 表单发布数据或查询参数的一部分。

所有 API 资源和操作都默认支持 JSON OData 格式，并且支持以下 Web service 格式。“输入”列描述了请求特定格式所需的其他输入。