第二十三章 源代码文件 REST API 参考（五）

DeleteDoc

此方法删除指定命名空间中的命名源代码文件。它返回相应的源代码文件对象。

与源代码文件有关的错误将在源代码文件对象的状态属性中。

有关示例和其他详细信息，请参阅本手册教程章节中的删除文件。

URL

DELETE http://server:port/api/atelier/v1/namespace/doc/doc-name

注意：如果要删除 CSP 文件 ，则 doc-name 的值包括 /（斜杠）字符。这就是定义 DeleteDoc 的 URLMap 包含此参数名称的 (.*) 而不是 :docname 的原因。有关详细信息，请参阅创建 REST 服务中的“为 REST 创建 URL 映射”。

JSON Messages

以下是源代码文件 xyz.mac 的 DELETE 的返回内容：

{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [],
  "result": {
    "name": "xyz.mac",
    "db": "INVENTORYR",
    "ts": "",
    "cat": "RTN",
    "status": "",
    "enc": false,
    "flags": 0,
    "content": []
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

HTTP 返回码

• HTTP 200 如果正常。
• 如果命名资源不是有效的源代码文件名，则返回 HTTP 400。
• 如果源代码文件不存在，则返回 HTTP 404。
• 如果资源被锁定，HTTP 423。
• HTTP 500 如果发生意外错误（详细信息将在状态错误数组中）。

HeadDoc

此方法返回命名源代码文件和命名空间的 HttpHeader。此标头包含一个时间戳，可用于检测服务器和客户端版本之间的差异。

URL

HEAD http://server:port/api/atelier/v1/namespace/doc/doc-name

注意：如果正在获取 CSP 文件的 HTTP 标头，则 doc-name 的值包括 /（斜杠）字符。这就是定义 HeadDoc 的 URLMap 包含此参数名称的 (.*) 而不是 :docname 的原因。有关详细信息，请参阅创建 REST 服务中的“为 REST 创建 URL 映射”

HTTP 返回码

• HTTP 200 如果正常。
• 如果资源名称是无效的源代码文件名，则返回 HTTP 400。
• 如果找不到资源，则返回 HTTP 404。
• HTTP 500 如果发生意外错误（详细信息将在状态错误数组中）。

GetDocs

此方法返回命名空间中所有指定源代码文件的文本。

URL

POST http://server:port/api/atelier/v1/namespace/docs

要获取的源代码文件列表在 http 请求的正文中传递。请求正文是要获取的源代码文件名称的 JSON 数组。例如，[ "%Api.DocDB.cls", ... ]。

此调用需要标头 Content-Type application/json。

JSON Messages

返回内容是源代码文件对象的数组。有关源代码文件对象结构的示例，请参见 GetDoc 方法。

与源代码文件有关的错误将出现在每个源代码文件对象的状态属性中。此方法不支持 storageOnly 标志。它也不进行 ETAG 检查（因此在任何情况下都不会返回 HTTP 304）。

HTTP 返回码

• HTTP 200 如果正常。
• 如果传递的内容类型不是 application/json，则 HTTP 415。
• HTTP 500 如果发生意外错误（详细信息将在状态错误数组中）。

DeleteDocs

此方法删除命名源代码文件的列表。它返回相应的源代码文件对象数组。

URL

DELETE http://server:port/api/atelier/v1/namespace/docs

要删除的文件列表作为 JSON 数组在 http 请求的正文中传递。例如，[ "%Api.DocDB.cls", ... ]。

此调用需要标头 Content-Type application/json。

JSON Messages

以下是源代码文件 xyz.mac 和不存在的类 noteexist.cls 的 DELETE 的返回内容：

{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [
  ],
  "result": [
    {
      "name": "xyz.mac",
      "db": "INVENTORYR",
      "status": ""
    },
    {
      "name": "notexist.cls",
      "db": "",
      "status": "ERROR #5001: Document Does Not Exist: User.notexist.cls [zExistsDoc+3^%Atelier.v1.Utils.General.1:%SYS]"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

与每个源代码文件有关的错误将在每个返回的源代码文件对象的状态属性中。如果状态为空字符串，则源代码文件已成功删除。否则源代码文件不会被删除。

对于已删除的源代码文件，db 属性将指示文档是从哪个数据库中删除的。

HTTP 返回码

• HTTP 200 如果正常。
• 如果发布的数据不包含 JSON 数组，则为 HTTP 400。
• 如果传递的内容类型不是 application/json，则 HTTP 415。
• HTTP 500 如果发生意外错误（详细信息将在状态错误数组中）。