工作流相关接口
/api/v1/workflows¶
POST¶
Summary:¶
创建工作流
Description:¶
创建工作流
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | data | Yes | dto.WorkflowInsertReq |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "message": "success"} | response.Response |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
DELETE¶
Summary:¶
删除工作流
Description:¶
删除工作流
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | uids | No | dto.WorkflowDeleteReq |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "message": "success"} | response.Response |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
GET¶
Summary:¶
分页工作流列表数据
Description:¶
工作流列表
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| displayName | query | 工作流名称 | No | string |
| type | query | 类型 | No | string |
| page | query | 页条数 | No | integer |
| limit | query | 页码 | No | integer |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "data": [...]} | response.Response & object |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
/api/v1/workflows/{uid}¶
GET¶
Summary:¶
查询工作流
Description:¶
查询工作流
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| uid | path | uid | No | string |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "data": [...]} | response.Response & object |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
PUT¶
Summary:¶
更新工作流
Description:¶
更新工作流
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | body | Yes | dto.WorkflowUpdateReq |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "message": "success"} | response.Response |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
dto.WorkflowInsertReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| argonWorkflowID | string | Argon 工作流ID | No |
| argonWorkflowSpec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| description | string | 工作流描述 | No |
| displayName | string | 工作流名称 | No |
| executionMode | integer | 工作流执行模式 | No |
| spec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| type | integer | 工作流类型 1：系统预置工作流，2：用户定义工作流，99：系统内置工作流 | No |
| uid | string | No |
dto.WorkflowDeleteReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| uids | [ string ] | No |
dto.WorkflowUpdateReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| argonClusterWorkflow | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| argonWorkflowID | string | Argon WorkflowID | No |
| argonWorkflowSpec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| description | string | 工作流描述 | No |
| displayName | string | 工作流名称 | No |
| spec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| type | integer | 工作流类型 1：系统预置工作流，2：用户定义工作流，99：系统内置工作流 | No |
| uid | string | No |
models.WorkflowRecord¶
| Name | Type | Description | Required |
|---|---|---|---|
| argonClusterWorkflow | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| argonWorkflowID | string | Argon 工作流ID | No |
| argonWorkflowSpec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| createdAt | models.LocalTime | No | |
| description | string | 工作流描述 | No |
| displayName | string | 工作流名称 | No |
| executionMode | integer | 工作流执行模式 | No |
| spec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| type | integer | 工作流类型 1：系统预置工作流，2：用户定义工作流，99：系统内置工作流 | No |
| uid | string | 唯一uuid | No |
| updatedAt | models.LocalTime | No |