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

GetMetaData

This method returns the named database METADATA.zip 文件的二进制内容. Atelier Use this file to store indexing information,in order to preserve this information for future sessions.

URL

GET http://server:port/api/atelier/v1/%25SYS/metadata/database

注意：因为 % 是 URL 特殊字符,So specify text %,must be followed by 25（Hexadecimal code for the percent character）.因此,必须使用 %25SYS to specify text %SYS.

HTTP 返回码

• HTTP 200 如果正常.
• If the source code file does not exist,则返回 HTTP 404.
• HTTP 500 If an unexpected error occurs（Details will be in the status error array）.

GetCSPApps

This method returns the definitions defined on the server or for the specified namespace on the server Web 应用程序列表.

URL

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

GET http://server:port/api/atelier/v1/%25SYS/cspapps/namespace

其中：

namespace

Specifies the name of the namespace.如果未指定命名空间,then this method returns all namespaces Web 应用程序.

注意：因为 % 是 URL 特殊字符,So specify text %,must be followed by 25（Hexadecimal code for the percent character）.因此,必须使用 %25SYS to specify text %SYS.

URL Parameters

可以传递 URL 参数 ?detail=1 to return an array containing objects describing the application in more detail.

JSON Messages

What is returned below is a list of already defined Web An array of applications：

{
    
  "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 the same return content：

{
    
  "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 If an unexpected error occurs（Details will be in the status error array）.

GetNamespace

This method returns information about a specific namespace.

URL

GET http://server:port/api/atelier/v1/namespace

JSON Messages

Following are the namespacesUSERreturn content information：

{
    
    "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 If an unexpected error occurs（Details will be in the status error array）.