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

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

文章目录

​​第二十章 源代码文件 REST API 参考（二）​​​​GetMetaData​​

​​URL​​​​HTTP 返回码​​

​​GetCSPApps​​

​​URL​​​​URL Parameters​​​​JSON Messages​​​​HTTP 返回码​​

​​GetNamespace​​

​​URL​​​​JSON Messages​​​​HTTP 返回码​​

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

GetMetaData

此方法返回命名数据库的 ​​METADATA.zip​​​ 文件的二进制内容。 ​​Atelier​​ 使用此文件来存储索引信息，以便为将来的会话保留此信息。

URL

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

HTTP 返回码

​​HTTP 200​​ 如果正常。如果源代码文件不存在，则返回​​HTTP 404​​。​​HTTP 500​​ 如果发生意外错误（详细信息将在状态错误数组中）。

GetCSPApps

此方法返回在服务器上定义或为服务器上指定命名空间定义的 ​​Web​​ 应用程序列表。

URL

​​GET ​​Web​​ 应用程序。

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

URL Parameters

可以传递 ​​URL​​​ 参数 ​​?detail=1​​ 以返回包含更详细描述应用程序的对象的数组。

JSON Messages

以下返回的内容是一个列出已定义 ​​Web​​ 应用程序的数组：

{ "status": { "errors": [], "summary": "" }, "console": [], "result": { "content": [ "/csp/broker", "/csp/documatic", "/csp/sys", "/csp/sys/exp", "/csp/sys/mgr", "/csp/sys/op", "/csp/sys/sec", "/isc/studio/rules", "/isc/studio/templates", "/isc/studio/usertemplates", "/csp/user" ] }}

以下是 ​​detail=1​​ 的相同返回内容：

{ "status": { "errors": [], "summary": "" }, "console": [], "result": { "content": [ { "name": "/csp/broker", "default": false }, { "name": "/csp/documatic", "default": false }, { "name": "/csp/sys", "default": true }, { "name": "/csp/sys/exp", "default": false }, { "name": "/csp/sys/mgr", "default": false }, { "name": "/csp/sys/op", "default": false }, { "name": "/csp/sys/sec", "default": false }, { "name": "/isc/studio/rules", "default": false }, { "name": "/isc/studio/templates", "default": false }, { "name": "/isc/studio/usertemplates", "default": false }, { "name": "/csp/user", "default": true } ] }}

HTTP 返回码

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

GetNamespace

此方法返回有关特定命名空间的信息。

URL

​​GET Messages

以下是命名空间​​USER​​的返回内容信息：

{ "status": { "errors": [], "summary": "" }, "console": [], "result": { "content": { "name": "USER", "db": [ { "name": "USER", "crhash": "3A1A0E8B6C8", "default": true, "dbsys": false }, { "name": "IRISLIB", "crhash": "A56AAA8D5418", "default": false, "dbsys": true }, { "name": "IRISLOCALDATA", "crhash": "3A1A0551876", "default": false, "dbsys": false }, { "name": "IRISSYS", "crhash": "3A19FFD2EF0", "default": false, "dbsys": true } ], "features": [ { "name": "ENSEMBLE", "enabled": false } ] } }}

HTTP 返回码

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

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。