文档首页> 应用魔方 AppCube> API参考> API> 脚本> 获取脚本签名信息
更新时间:2022-04-27 GMT+08:00
分享

获取脚本签名信息

功能介绍

获取脚本签名信息。获取脚本的名称、输入参数、输出参数、声明的类名、方法名等相关信息。

只有用户保存或另存脚本时会调用该接口,当脚本中定义的输入参数或输出参数的类型错误时,该接口会执行报错。

该接口是同步接口。

URI

GET AppCube域名/u-route/baas/script/v1.0/signature/{scriptName}{?version=1.0.1}

参数说明请参见表1

表1 参数说明

参数

是否必选

描述

scriptName

脚本名称。

version

取值为脚本的版本号信息,表示获取具体版本号对应的脚本签名信息。

可选参数。不填写表示最新版本的脚本。

请求参数

响应参数

响应参数如表2所示。

表2 响应参数

参数

参数类型

描述

resCode

String

返回码,如果返回“0”代表请求成功,其他错误码说明请参考错误码

resMsg

String

返回消息,如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。

result

Object

在成功请求时会有内容返回。详情请参见表3

表3 result参数说明

参数

参数类型

描述

description

String

脚本的描述信息。

script

String

脚本名称。

methodName

String

方法名称。在脚本使用@action.method注解后才会有方法名。

methodObject

String

方法所属的类。

input

String

输入类型。一般为Input。

output

String

输出类型。一般为Output。

label

String

脚本标签。

inputs

Array of objects

输入类型中的变量信息描述。请参考表4

outputs

Array of objects

输出类型中的变量信息描述。请参考表4

types

Object

脚本中使用@action.param注解的类名。

表4 inputs和ouputs参数说明

参数

参数类型

描述

description

String

脚本的描述信息。

name

String

脚本名称。

label

String

方法名称。在脚本使用@action.method注解后才会有方法名。

message

String

运行脚本参数不合法输入时,返回的错误信息。

isCollection

String

变量类型是否是集合。

pattern

String

输入变量值需要满足的正则表达式。

valueType

String

变量的类型。

required

String

变量是否必填。

请求示例

获取脚本“trq1__editEquipment”签名信息。
GET https://AppCube域名/u-route/baas/script/v1.0/signature/trq1__editEquipment

响应示例

{
    "resCode": "0",
    "resMsg": "成功",
    "result": {
        "description": "",
        "input": "ActionInput",
        "inputs": [
            {
                "description": "",
                "isCollection": false,
                "label": "equipment",
                "lengthInCharacter": false,…
            }
        ],
        "label": "",
        "methodName": "editEquipment",
        "methodObject": "EditEquipment",
        "output": "ActionOutput",
        "outputs": [
            {
                "description": "",
                "isCollection": false,
                "label": "",
                "lengthInCharacter": false,…
            }
        ],
        "script": "trq1__editEquipment",
        "types": {
            "ActionInput": [
                {
                    "description": "",
                    "isCollection": false,
                    "label": "equipment",
                    "lengthInCharacter": false,…
                }
            ],
            "ActionOutput": [
                {
                    "description": "",
                    "isCollection": false,
                    "label": "",
                    "lengthInCharacter": false,…
                }
            ]
        }
    }
}

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

close