You need to enable JavaScript to run this app.
导航

GetTRSWorkflowInfo - 查询TRS协议工作流信息

最近更新时间2024.04.23 14:21:06

首次发布时间2024.01.04 09:53:16

查询TRS协议工作流信息

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

GetTRSWorkflowInfo

要执行的操作,取值:GetTRSWorkflowInfo。

Version
String

2021-03-04

API的版本,取值:2021-03-04。

TRSServer
String

https://dockstore.org

trs server地址

ID
String

#workflow/github.com/aaa/bbb/ccc

trs id

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Name
String

name

trs工作流名称

Description
String

description

trs工作流描述

VersionsInfo
Array of TRSWorkflowVersionInfo

[]

trs工作流具体版本信息

请求示例

POST /?Action=GetTRSWorkflowInfo&Version=2021-03-04
Content-Type:application/json
{
    "TRSServer": "https://dockstore.org",
    "ID": "#workflow/github.com/aaa/bbb/ccc"
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "GetTRSWorkflowInfo",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "Name": "name",
        "Description": "description",
        "VersionsInfo": [
            {
                "Name": "master",
                "Language": "WDL"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
ParamErr
<透传错误内容>

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

404
NotFoundErr
<资源类型>[<具体资源id>] not found

资源不存在

500
InternalErr
<透传错误内容>

内部错误