Get Basic Task Information

Use this API to retrieve detailed information about a specified task.

Request URL: /openapi/v1/workflow/detail

HTTP method: GET

Request parameters

Parameter	Type	Required	Description	Example
workflowId	String	Yes	Task ID.	"ex-dd6xemv3mnca"

Response parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request was successful.	true
requestId	String	Request ID.	"Ih9n1PMZ-cihckWKncjgs9DUdeff7LMM"
data	Object	Task details.	N/A
name	String	Task name.	"test task"
createTime	String	Task creation time.	"2025-10-22 07:15:50Z"
module	String	Task type: sqlTask: SQL task dataExport: Data export task	sqlTask
submitterId	String	ID of the user who submitted the task.	"1030799091781335"
status	String	Task status: notStarted: Not started preChecking: Pre-checking preCheckSkip: Pre-check skipped preCheckSuccess: Pre-check passed preCheckFailed: Pre-check failed ruleChecking: Rule checking ruleCheckSuccess: Rule check passed ruleCheckFailed: Rule check failed toApprove: Pending approval approved: Approval passed approveRejected: Approval rejected running: Running waiting: Waiting for scheduling scheduling: Scheduling suspended: Suspended stopped: Terminated success: Successful failed: Failed finished: Finished canceled: Withdrawn executeCanceled: Execution canceled skipped: Skipped	notStarted
statusDesc	String	Description of the task status.	"Not started"
executeTime	String	Task execution time.	"2025-10-22 07:16:10Z"
datasourceId	String	ID of the associated data source.	"ds-ddduea45j638"
dbName	String	Name of the associated database.	"ght"
dbGroupId	String	ID of the associated database group.	"group1"
schemaName	String	Name of the associated schema.	"public"
bizData	Object	Task details based on the module value. For details, see bizData response parameters (SQL task) or bizData response parameters (data export).	N/A
errorCode	String	Error code.	N/A
message	String	Error message.	N/A

bizData response parameters (SQL task)

Parameter	Type	Description	Example
sqlText	String	SQL text. If an SQL file was uploaded, this field contains the file ID.	"ds-dbiddumxp4h"
sqlInputType	String	SQL input type: text: SQL text file: SQL file	"text"
executorType	String	Executor type: creator: The submitter executes the task approver: The approver executes the task auto: The task is executed automatically <executor name>: The name of the executor is displayed directly	"ght"
estimatedAffectedRows	Integer	Estimated number of affected rows.	1
rollbackText	String	Rollback text.	"insert into date_time_test1 (datetime_col) values (now());"
rollbackTextType	String	Rollback text type: text: SQL text file: SQL file	"text"

bizData response parameters (data export)

Parameter	Type	Description	Example
reason	String	Reason for the export.	"test"
charset	String	Character set of the exported file.	"utf8"
executorType	String	Executor type: creator: The submitter executes the task approver: The approver executes the task auto: The task is executed automatically <executor name>: The name of the executor is displayed directly	"creator"
sqlStatement	String	Export SQL statement, returned when the export type is sql.	"db.all_type.find()"
sqlExtOption	Array	Additional export options. compress: Compresses multiple INSERT statements into one larger INSERT statement to improve insertion efficiency.	"compress"
type	String	Export type: sql: Export as SQL statements database: Export a database table: Export a table	"sql"
contentType	String	Export content: data: Data only structure: Structure only dataAndStructure: Data and structure	"data"
fileType	String	Export file type: sql: Export as an SQL file excel: Export as an Excel file csv: Export as a CSV file	"sql"

Successful response example

SQL task

{
    "success": true,
    "requestId": "Ih9n1PMZ-cihckWKncjgs9DUdeff7LMM",
    "data": {
        "createTime": "2025-10-22 07:15:50Z",
        "module": "sqlTask",
        "submitterId": "1030799091781335",
        "status": "success",
        "statusDesc": "",
        "executeTime": "2025-10-22 07:16:10Z",
        "datasourceId": "ds-ddduea45j638",
        "dbName": "ght",
        "bizData": {
            "sqlText": "insert into date_time_test1 (datetime_col) values (now());",
            "executorType": "creator",
            "estimatedAffectedRows": 1,
            "sqlInputType": "text"
        }
    }
}

Data export

{
    "success": true,
    "requestId": "By6m0RZC-BHGBbVWnCABf9OFdIEc1QQH",
    "data": {
        "createTime": "2025-09-24 09:34:13Z",
        "module": "dataExport",
        "submitterId": "1030799091781335",
        "status": "finished",
        "statusDesc": "",
        "executeTime": "2025-09-24 09:34:27Z",
        "datasourceId": "ds-dbiid6umxp4h",
        "dbName": "ght",
        "bizData": {
            "reason": "11",
            "charset": "utf8",
            "executorType": "creator",
            "sqlStatement": "select version();",
            "sqlExtOption": ["compress"],
            "type": "sql",
            "contentType": "data",
            "fileType": "sql"
        }
    }
}