Creating a Workflow Version

Function

This API is used to create a workflow version.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/{workflow_id}/versions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Definition Workspace ID. Range N/A
workflow_id	Yes	String	Definition Workflow ID. Range N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A
content-type	Yes	String	Definition Content type. application/json;charset=UTF-8: common API request type Constraints N/A Range application/json;charset=UTF-8 Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Workflow name. Constraints N/A Range N/A Default Value N/A
description	Yes	String	Definition Workflow description. Constraints N/A Range N/A Default Value N/A
taskconfig	Yes	String	Definition Parameters of the workflow topology. Constraints N/A Range N/A Default Value N/A
input	No	String	Definition Workflow input. Constraints N/A Range N/A Default Value N/A
output	No	String	Definition Workflow output. Constraints N/A Range N/A Default Value N/A
taskflow	Yes	String	Definition Base64 code of the workflow topology. Constraints N/A Range N/A Default Value N/A
taskflow_type	Yes	String	Definition Workflow type. Constraints N/A Range JSON Default Value N/A
aop_type	Yes	String	Definition Workflow type. NORMAL: general SURVEY: investigation HEMOSTASIS: prevention EASE: mitigation Constraints N/A Range NORMAL SURVEY HEMOSTASIS EASE Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A
success	Boolean	Definition Whether the request is successful. Range true: successful false: failed
request_id	String	Definition Request ID. Constraints N/A
data	AopWorkflowVersionInfo object	Workflow version details.

**Table 5** AopWorkflowVersionInfo
Parameter	Type	Description
id	String	Definition Workflow version ID. Constraints N/A
version_id	String	Definition Workflow version ID. Constraints N/A
name	String	Definition Workflow version name. Constraints N/A
aopworkflow_id	String	Definition Workflow ID. Constraints N/A
description	String	Definition Workflow version description. Range N/A
project_id	String	Definition Tenant project ID. Constraints N/A
owner_id	String	Definition Owner ID. Constraints N/A
creator_id	String	Definition Creator ID. Range N/A
creator_name	String	Definition Name of the creator. Range N/A
create_time	String	Definition Creation time. Range N/A
modifier_id	String	Definition ID of the updater. Range N/A
modifier_name	String	Definition Name of the updater. Range N/A
update_time	String	Definition Update time. Range N/A
enabled	Boolean	Definition Enabled or not. Constraints N/A Range true: enabled false: disabled Default Value false
status	String	Definition Workflow status. pending_submit: draft pending_approval: pending review publishing: being published publish_failed: publishing failed not_activated: not activated activated: activated rejected: rejected Range pending_submit pending_approval publishing publish_failed not_activated activated rejected
version	String	Definition Version of the current workflow. Constraints N/A Range N/A Default Value N/A
taskconfig	String	Definition Parameters of the workflow topology. Constraints N/A Range N/A Default Value N/A
taskflow	String	Definition Base64 code of the workflow topology. Constraints N/A Range N/A Default Value N/A
taskflow_type	String	Definition Workflow type. Constraints N/A Range JSON Default Value N/A
aop_type	String	Definition Workflow type. NORMAL: general SURVEY: investigation HEMOSTASIS: prevention EASE: mitigation Constraints N/A Range NORMAL SURVEY HEMOSTASIS EASE Default Value N/A
input	String	Definition Workflow input. Constraints N/A Range N/A Default Value N/A
output	String	Definition Workflow output. Constraints N/A Range N/A Default Value N/A
dataclass_id	String	Definition Data class ID. Range N/A
dataclass_name	String	Definition Data class name. Range N/A
workspace_id	String	Definition Workspace ID. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

Example Requests

Create a workflow version.

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/workflows/c19470f3-5eaf-4572-82e8-2ff094495919/versions

{
  "name" : "Test_aop",
  "description" : "Aop workflow description Test",
  "input" : "",
  "output" : "",
  "taskconfig" : "{\"trigger\":{\"advanced\":{\"retry_times\":0,\"retry_interval\":\"30\",\"log_level\":\"Info\"}},\"node_info\":{},\"usertask_info\":{}}",
  "taskflow" : "eyJlbGVtZW50VHlwZSI6Int9Iiwid29ya2Zsb3ciOnsiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmRlZmluaXRpb25zIiwiYXR0cmlidXRlcyI6eyJ4bWxuczp4c2kiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSIsInhtbG5zOmJwbW4yIjoiaHR0cDovL3d3dy5vbWcub3JnL3NwZWMvQlBNTi8yMDEwMDUyNC9NT0RFTCIsInhtbG5zOmJwbW5kaSI6Imh0dHA6Ly93d3cub21nLm9yZy9zcGVjL0JQTU4vMjAxMDA1MjQvREkiLCJ4bWxuczpkYyI6Imh0dHA6Ly93d3cub21nLm9yZy9zcGVjL0RELzIwMTAwNTI0L0RDIiwieG1sbnM6ZGkiOiJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9ERC8yMDEwMDUyNC9ESSIsInhtbG5zOnNvYXIiOiJodHRwczovL3NvYy5jbG91ZHNyZS5jb20vc29hci92MiIsImlkIjoiZGlhZ3JhbV9Qcm9jZXNzXzE3NTI4MjEwODY3OTgiLCJ0YXJnZXROYW1lc3BhY2UiOiJodHRwOi8vZmxvd2FibGUub3JnL2JwbW4iLCJ4c2k6c2NoZW1hTG9jYXRpb24iOiJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9CUE1OLzIwMTAwNTI0L01PREVMIEJQTU4yMC54c2QifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOnByb2Nlc3MiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiUHJvY2Vzc18xNzUyODIxMDg2Nzk4IiwibmFtZSI6IlNlcnZpY2VfUHJvY2VzczE3NTI4MjEwODY3OTgiLCJpc0V4ZWN1dGFibGUiOiJ0cnVlIn0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJicG1uMjpzdGFydEV2ZW50IiwiYXR0cmlidXRlcyI6eyJpZCI6IkV2ZW50XzA2anZhbjUifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOm91dGdvaW5nIiwiZWxlbWVudHMiOlt7InR5cGUiOiJ0ZXh0IiwidGV4dCI6IkZsb3dfMTRrbm1nbiJ9XX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmVuZEV2ZW50IiwiYXR0cmlidXRlcyI6eyJpZCI6IkV2ZW50XzFvZGE3dGcifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmluY29taW5nIiwiZWxlbWVudHMiOlt7InR5cGUiOiJ0ZXh0IiwidGV4dCI6IkZsb3dfMTRrbm1nbiJ9XX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOnNlcXVlbmNlRmxvdyIsImF0dHJpYnV0ZXMiOnsiaWQiOiJGbG93XzE0a25tZ24iLCJzb3VyY2VSZWYiOiJFdmVudF8wNmp2YW41IiwidGFyZ2V0UmVmIjoiRXZlbnRfMW9kYTd0ZyJ9fV19LHsidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5EaWFncmFtIiwiYXR0cmlidXRlcyI6eyJpZCI6IkJQTU5EaWFncmFtXzEifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW5kaTpCUE1OUGxhbmUiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiQlBNTlBsYW5lXzEiLCJicG1uRWxlbWVudCI6IlByb2Nlc3NfMTc1MjgyMTA4Njc5OCJ9LCJlbGVtZW50cyI6W3sidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5TaGFwZSIsImF0dHJpYnV0ZXMiOnsiaWQiOiJFdmVudF8wNmp2YW41X2RpIiwiYnBtbkVsZW1lbnQiOiJFdmVudF8wNmp2YW41In0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJkYzpCb3VuZHMiLCJhdHRyaWJ1dGVzIjp7IngiOiItMzM4IiwieSI6Ii05OCIsIndpZHRoIjoiMzYiLCJoZWlnaHQiOiIzNiJ9fV19LHsidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5TaGFwZSIsImF0dHJpYnV0ZXMiOnsiaWQiOiJFdmVudF8xb2RhN3RnX2RpIiwiYnBtbkVsZW1lbnQiOiJFdmVudF8xb2RhN3RnIn0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJkYzpCb3VuZHMiLCJhdHRyaWJ1dGVzIjp7IngiOiI0MiIsInkiOiItOTgiLCJ3aWR0aCI6IjM2IiwiaGVpZ2h0IjoiMzYifX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW5kaTpCUE1ORWRnZSIsImF0dHJpYnV0ZXMiOnsiaWQiOiJGbG93XzE0a25tZ25fZGkiLCJicG1uRWxlbWVudCI6IkZsb3dfMTRrbm1nbiJ9LCJlbGVtZW50cyI6W3sidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiZGk6d2F5cG9pbnQiLCJhdHRyaWJ1dGVzIjp7IngiOiItMzAyIiwieSI6Ii04MCJ9fSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImRpOndheXBvaW50IiwiYXR0cmlidXRlcyI6eyJ4IjoiNDIiLCJ5IjoiLTgwIn19XX1dfV19XX1dfX0=",
  "taskflow_type" : "JSON",
  "aop_type" : "NORMAL"
}

Example Responses

Status code: 200

Response to the request for creating a workflow version

{
  "code" : "00000000",
  "data" : {
    "aop_type" : "NORMAL",
    "aopworkflow_id" : "c19470f3-5eaf-4572-82e8-2ff094495919",
    "create_time" : "2025-07-18T14:55:47.084Z+0800",
    "creator_id" : "5857617f6b8b4981baef587c08ab8b68",
    "creator_name" : "xxxx",
    "dataclass_id" : "",
    "dataclass_name" : "",
    "description" : "Aop workflow description Test",
    "enabled" : null,
    "id" : "f0739f7d-bbc4-46ca-ba79-c29158e0ab8c",
    "input" : "",
    "modifier_id" : "",
    "modifier_name" : "",
    "name" : "Test_aop",
    "output" : "",
    "owner_id" : "",
    "project_id" : "f69081793d9e4ea8a2f479dcef961989",
    "status" : "pending_submit",
    "taskconfig" : "{\"trigger\":{\"advanced\":{\"retry_times\":0,\"retry_interval\":\"30\",\"log_level\":\"Info\"}},\"node_info\":{},\"usertask_info\":{}}",
    "taskflow" : "eyJlbGVtZW50VHlwZSI6Int9Iiwid29ya2Zsb3ciOnsiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmRlZmluaXRpb25zIiwiYXR0cmlidXRlcyI6eyJ4bWxuczp4c2kiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSIsInhtbG5zOmJwbW4yIjoiaHR0cDovL3d3dy5vbWcub3JnL3NwZWMvQlBNTi8yMDEwMDUyNC9NT0RFTCIsInhtbG5zOmJwbW5kaSI6Imh0dHA6Ly93d3cub21nLm9yZy9zcGVjL0JQTU4vMjAxMDA1MjQvREkiLCJ4bWxuczpkYyI6Imh0dHA6Ly93d3cub21nLm9yZy9zcGVjL0RELzIwMTAwNTI0L0RDIiwieG1sbnM6ZGkiOiJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9ERC8yMDEwMDUyNC9ESSIsInhtbG5zOnNvYXIiOiJodHRwczovL3NvYy5jbG91ZHNyZS5jb20vc29hci92MiIsImlkIjoiZGlhZ3JhbV9Qcm9jZXNzXzE3NTI4MjEwODY3OTgiLCJ0YXJnZXROYW1lc3BhY2UiOiJodHRwOi8vZmxvd2FibGUub3JnL2JwbW4iLCJ4c2k6c2NoZW1hTG9jYXRpb24iOiJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9CUE1OLzIwMTAwNTI0L01PREVMIEJQTU4yMC54c2QifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOnByb2Nlc3MiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiUHJvY2Vzc18xNzUyODIxMDg2Nzk4IiwibmFtZSI6IlNlcnZpY2VfUHJvY2VzczE3NTI4MjEwODY3OTgiLCJpc0V4ZWN1dGFibGUiOiJ0cnVlIn0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJicG1uMjpzdGFydEV2ZW50IiwiYXR0cmlidXRlcyI6eyJpZCI6IkV2ZW50XzA2anZhbjUifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOm91dGdvaW5nIiwiZWxlbWVudHMiOlt7InR5cGUiOiJ0ZXh0IiwidGV4dCI6IkZsb3dfMTRrbm1nbiJ9XX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmVuZEV2ZW50IiwiYXR0cmlidXRlcyI6eyJpZCI6IkV2ZW50XzFvZGE3dGcifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmluY29taW5nIiwiZWxlbWVudHMiOlt7InR5cGUiOiJ0ZXh0IiwidGV4dCI6IkZsb3dfMTRrbm1nbiJ9XX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOnNlcXVlbmNlRmxvdyIsImF0dHJpYnV0ZXMiOnsiaWQiOiJGbG93XzE0a25tZ24iLCJzb3VyY2VSZWYiOiJFdmVudF8wNmp2YW41IiwidGFyZ2V0UmVmIjoiRXZlbnRfMW9kYTd0ZyJ9fV19LHsidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5EaWFncmFtIiwiYXR0cmlidXRlcyI6eyJpZCI6IkJQTU5EaWFncmFtXzEifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW5kaTpCUE1OUGxhbmUiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiQlBNTlBsYW5lXzEiLCJicG1uRWxlbWVudCI6IlByb2Nlc3NfMTc1MjgyMTA4Njc5OCJ9LCJlbGVtZW50cyI6W3sidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5TaGFwZSIsImF0dHJpYnV0ZXMiOnsiaWQiOiJFdmVudF8wNmp2YW41X2RpIiwiYnBtbkVsZW1lbnQiOiJFdmVudF8wNmp2YW41In0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJkYzpCb3VuZHMiLCJhdHRyaWJ1dGVzIjp7IngiOiItMzM4IiwieSI6Ii05OCIsIndpZHRoIjoiMzYiLCJoZWlnaHQiOiIzNiJ9fV19LHsidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5TaGFwZSIsImF0dHJpYnV0ZXMiOnsiaWQiOiJFdmVudF8xb2RhN3RnX2RpIiwiYnBtbkVsZW1lbnQiOiJFdmVudF8xb2RhN3RnIn0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJkYzpCb3VuZHMiLCJhdHRyaWJ1dGVzIjp7IngiOiI0MiIsInkiOiItOTgiLCJ3aWR0aCI6IjM2IiwiaGVpZ2h0IjoiMzYifX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW5kaTpCUE1ORWRnZSIsImF0dHJpYnV0ZXMiOnsiaWQiOiJGbG93XzE0a25tZ25fZGkiLCJicG1uRWxlbWVudCI6IkZsb3dfMTRrbm1nbiJ9LCJlbGVtZW50cyI6W3sidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiZGk6d2F5cG9pbnQiLCJhdHRyaWJ1dGVzIjp7IngiOiItMzAyIiwieSI6Ii04MCJ9fSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImRpOndheXBvaW50IiwiYXR0cmlidXRlcyI6eyJ4IjoiNDIiLCJ5IjoiLTgwIn19XX1dfV19XX1dfX0=",
    "taskflow_type" : "JSON",
    "update_time" : "2025-07-18T14:55:47.084Z+0800",
    "version" : "",
    "version_id" : "f0739f7d-bbc4-46ca-ba79-c29158e0ab8c",
    "workspace_id" : "f44065f5-557b-4376-ae02-8c65ef1960f4"
  },
  "message" : "",
  "request_id" : "",
  "success" : true
}