更新时间:2022-06-15 GMT+08:00
分享

更新workflow

功能介绍

更新自定义流程。

URI

PUT /v1/workflows /{workflow_id}

表1 参数说明

参数

是否必选

参数类型

描述

workflow_id

String

流程id,即创建workflow的返回值。

请求消息

请求参数

请求参数如表2 请求参数所示。

表2 请求参数

参数

是否必选

参数类型

描述

resource

表3

流程请求参数,resource为空,表明不更新流程的名称、描述信息、发布者、scope。resource和archive_content不可同时为空

archive_content

binary

本地上传流程文件需要,如果为空,表明流程文件不更新,resource和archive_content不可同时为空。流程名称必须以大小写字母数字开头,以.yaml/.yml结尾,允许输入字母、数字、点(.),下划线(_)和中划线(-),长度在64个字符以内。

表3 resource请求参数

参数

是否必选

参数类型

描述

name

String

流程名。

description

String

流程描述,如果未填写,则表明流程描述文件不更新。输入字符最大长度为255,中文算单个字符,不能包含<>#%&字符。

logo

String

logo图片。

vendor

String

流程上传者,如果未填写,则表明流程发布者不更新。

输入字符最大长度为64,中文算单个字符,不能包含<>()#%&/字符。

filename

String

流程yaml文件名。

image

String

若采用GCS设计器更新,image表示更新后的svg文本内容。

scope

String

流程使用范围,默认值为“domain“。

支持选项:

  • “domain”:仅当前租户可见可用
  • “public”:流程所有租户可见可用(public级别仅能由GCS创建,普通用户不能创public级别流程)。

请求示例

PUT /v1/workflows/0e7196ae-fdbf-84e4-d751-28554dcd7572 HTTP/1.1 
Host:Host Server   
Content-Length:1111
Content-Type:multipart/form-data
resource=
'{
    "description": "update gcs workflow description"
}'

响应消息

响应参数

请求成功的响应参数如表3所示。

响应示例

{
    "id": "e19d3faf-9f04-9685-e5c0-fbe8d40b96cd"
}

请求失败的响应参数如表9所示。

状态码

  • 正常

    状态码如表4所示。

表4 状态码

状态码

描述

201

流程更新成功

相关文档