第十九章 源代码文件 REST API 参考（一）

源代码文件 REST 接口支持以下方法：

• GetServer：返回有关服务器的信息。
• HeadServer：返回服务器的 HttpHeader。
• GetJobs：返回正在运行的jobs列表。
• GetMetaData：返回命名数据库的 METADATA.zip 文件的内容。
• GetCSPApps：返回 Web 应用程序列表。
• GetNamespace：返回有关特定命名空间的信息。
• GetDocNames：返回源代码文件名列表。
• GetModifiedDocNames：返回自数据库具有指定哈希值以来已修改的源代码文件列表。
• PutDoc：保存提供的源代码文件。
• GetDoc：返回指定源代码文件的文本。
• DeleteDoc：删除命名的源代码文件。
• HeadDoc：返回命名源代码文件的 HttpHeader。
• GetDocs：返回所有指定源代码文件的文本。
• DeleteDocs：删除命名源代码文件列表。
• Compile编译：编译您指定的源代码文件。
• Index索引：返回有关指定源代码文件的摘要信息。
• Query查询：对任何表执行 SQL 查询并返回结果。
• Search搜索：在数据库中搜索源代码文件。
• GetEnsClassType：返回用于创建作品的类的名称列表。可以指定要获取的类的类型，例如业务服务类。
• GetAdpInputOutputClass：返回适配器的输入和输出类型。

GetServer

此方法返回有关服务器的信息，包括服务器上可用的 源代码文件 REST API 版本和名称空间。

URL

GET http://server:port/api/atelier/
1

JSON Messages

{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [],
  "result": {
    "content": {
      "version": "IRIS for Windows (x86-64) 2018.1.1 (Build 515U) Mon Feb 5 2018 08:24:13 EST",
      "id": "98E1697E-13F9-4D6A-8B73-827873D1D61C",
      "api": 2,
      "features": [
...
      ],
      "namespaces": [
        "%SYS",
        "USER"
      ]
    }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

HTTP 返回码

• HTTP 200 如果正常。
• HTTP 500 如果发生意外错误（详细信息将在状态错误数组中）。

HeadServer Method

此方法返回服务器的 HttpHeader。

URL

HEAD http://server:port/api/atelier/

JSON Messages

没有返回内容。

HTTP 返回码

• HTTP 200 如果正常。
• HTTP 500 如果发生意外错误（详细信息将在状态错误数组中）。

GetJobs

此方法返回实例上正在运行的作业列表。

URL

GET http://server:port/api/atelier/v1/%25SYS/jobs
1

注意：因为 % 是 URL 特殊字符，所以要指定文字 %，必须在其后跟 25（百分号字符的十六进制代码）。因此，必须使用 %25SYS 来指定文字 %SYS。

JSON Messages

以下返回的内容是作业描述符数组：

{
  "status": {
  "errors": [],
  "summary": ""
  },
  "console": [],
  "result": {
  "content": [
    {
    "pid": 1394,
    "namespace": "%SYS",
    "routine": "%Studio.Debugger.1",
    "state": "RUN",
    "device": "|TCP|1972|1394"
    },
    {
    "pid": 1345,
    "namespace": "%SYS",
    "routine": "RECEIVE",
    "state": "HANG",
    "device": "/dev/null"
    },
    {
    "pid": 1364,
    "namespace": "%SYS",
    "routine": "%SYS.TaskSuper.1",
    "state": "SELECTW",
    "device": "/dev/null"
    },
    {
    "pid": 1396,
    "namespace": "%SYS",
    "routine": "%SYS.cspServer3",
    "state": "READ",
    "device": "|TCP|1972|1396"
    },
    {
    "pid": 1346,
    "namespace": "%SYS",
    "routine": "ECPWork",
    "state": "RUNW",
    "device": "/dev/null"
    },
      {
        "pid": 1417,
        "namespace": "%SYS",
        "routine": "%SYS.BINDSRV",
        "state": "READ",
        "device": "|TCP|1972|1417"
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

HTTP 返回码

• HTTP 200 如果正常。
• HTTP 500 如果发生意外错误（详细信息将在状态错误数组中）。