Verifying a Workflow Version

Function

This API is used to verify a workflow version.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/validation

**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

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
mode	Yes	String	Definition Workflow verification type. BASIC: basic verification CIRCLE: cycle verification APP_PARAMS: parameter verification Constraints N/A Range BASIC CIRCLE APP_PARAMS Default Value N/A
taskconfig	Yes	String	Definition Parameters of the workflow topology. 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
aopworkflow_id	Yes	String	Definition Workflow ID. Constraints N/A Range N/A 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	data object	Workflow verification response result object.

**Table 5** data
Parameter	Type	Description
mode	String	Definition Workflow verification type. BASIC: basic verification CIRCLE: cycle verification APP_PARAMS: parameter verification Range BASIC CIRCLE APP_PARAMS
result	Boolean	Definition Parameter verification result. true: verification succeeded false: verification failed Range true false
detail	String	Definition Parameter verification result description. Range N/A. If the verification fails, the failure cause will be provided.

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

Verify a workflow.

/v1/15645222e8744afa985c93dab6341da6/workspaces/985c8a9f-de13-4af2-9109-fabc1719387c/soc/workflows/validation

{
  "aopworkflow_id" : "91355942-aa54-46d3-b7a8-c7ac8408192f",
  "taskflow" : "eyJlbGVtZW50VHlwZSI6Int9Iiwid29ya2Zsb3ciOnsiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmRlZmluaXRpb25zIiwiYXR0cmlidXRlcyI6eyJ4bWxuczp4c2kiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSIsInhtbG5zOmJwbW4yIjoiaHR0cDovL3d3dy5vbWcub3JnL3NwZWMvQlBNTi8yMDEwMDUyNC9NT0RFTCIsInhtbG5zOmJwbW5kaSI6Imh0dHA6Ly93d3cub21nLm9yZy9zcGVjL0JQTU4vMjAxMDA1MjQvREkiLCJ4bWxuczpkYyI6Imh0dHA6Ly93d3cub21nLm9yZy9zcGVjL0RELzIwMTAwNTI0L0RDIiwieG1sbnM6ZGkiOiJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9ERC8yMDEwMDUyNC9ESSIsInhtbG5zOnNvYXIiOiJodHRwczovL3NvYy5jbG91ZHNyZS5jb20vc29hci92MiIsImlkIjoiZGlhZ3JhbV9Qcm9jZXNzXzE3NTUyMzk1MjQ1MzgiLCJ0YXJnZXROYW1lc3BhY2UiOiJodHRwOi8vZmxvd2FibGUub3JnL2JwbW4iLCJ4c2k6c2NoZW1hTG9jYXRpb24iOiJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9CUE1OLzIwMTAwNTI0L01PREVMIEJQTU4yMC54c2QifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOnByb2Nlc3MiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiUHJvY2Vzc18xNzU1MjM5NTI0NTM4IiwibmFtZSI6IlNlcnZpY2VfUHJvY2VzczE3NTUyMzk1MjQ1MzgiLCJpc0V4ZWN1dGFibGUiOiJ0cnVlIn0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJicG1uMjpzdGFydEV2ZW50IiwiYXR0cmlidXRlcyI6eyJpZCI6IkV2ZW50XzB2dWl6YjcifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOm91dGdvaW5nIiwiZWxlbWVudHMiOlt7InR5cGUiOiJ0ZXh0IiwidGV4dCI6IkZsb3dfMHBqZjA1aiJ9XX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmVuZEV2ZW50IiwiYXR0cmlidXRlcyI6eyJpZCI6IkV2ZW50XzFvNTdqYzEifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmluY29taW5nIiwiZWxlbWVudHMiOlt7InR5cGUiOiJ0ZXh0IiwidGV4dCI6IkZsb3dfMHBqZjA1aiJ9XX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOnNlcXVlbmNlRmxvdyIsImF0dHJpYnV0ZXMiOnsiaWQiOiJGbG93XzBwamYwNWoiLCJzb3VyY2VSZWYiOiJFdmVudF8wdnVpemI3IiwidGFyZ2V0UmVmIjoiRXZlbnRfMW81N2pjMSJ9fV19LHsidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5EaWFncmFtIiwiYXR0cmlidXRlcyI6eyJpZCI6IkJQTU5EaWFncmFtXzEifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW5kaTpCUE1OUGxhbmUiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiQlBNTlBsYW5lXzEiLCJicG1uRWxlbWVudCI6IlByb2Nlc3NfMTc1NTIzOTUyNDUzOCJ9LCJlbGVtZW50cyI6W3sidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5TaGFwZSIsImF0dHJpYnV0ZXMiOnsiaWQiOiJFdmVudF8wdnVpemI3X2RpIiwiYnBtbkVsZW1lbnQiOiJFdmVudF8wdnVpemI3In0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJkYzpCb3VuZHMiLCJhdHRyaWJ1dGVzIjp7IngiOiItMjY4IiwieSI6Ii0xNzgiLCJ3aWR0aCI6IjM2IiwiaGVpZ2h0IjoiMzYifX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW5kaTpCUE1OU2hhcGUiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiRXZlbnRfMW81N2pjMV9kaSIsImJwbW5FbGVtZW50IjoiRXZlbnRfMW81N2pjMSJ9LCJlbGVtZW50cyI6W3sidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiZGM6Qm91bmRzIiwiYXR0cmlidXRlcyI6eyJ4IjoiNzIiLCJ5IjoiLTE3OCIsIndpZHRoIjoiMzYiLCJoZWlnaHQiOiIzNiJ9fV19LHsidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5FZGdlIiwiYXR0cmlidXRlcyI6eyJpZCI6IkZsb3dfMHBqZjA1al9kaSIsImJwbW5FbGVtZW50IjoiRmxvd18wcGpmMDVqIn0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJkaTp3YXlwb2ludCIsImF0dHJpYnV0ZXMiOnsieCI6Ii0yMzIiLCJ5IjoiLTE2MCJ9fSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImRpOndheXBvaW50IiwiYXR0cmlidXRlcyI6eyJ4IjoiNzIiLCJ5IjoiLTE2MCJ9fV19XX1dfV19XX19",
  "taskconfig" : "{\"node_info\":{},\"usertask_info\":{}}",
  "mode" : "CIRCLE"
}

Example Responses

Status code: 200

Response to the request for verifying a workflow version.

{
  "code" : "00000000",
  "data" : {
    "detail" : "Pass",
    "mode" : "CIRCLE",
    "result" : true
  },
  "message" : "",
  "request_id" : "",
  "success" : true
}