List Workflow Directories¶
Get all the content in the workflow directory of the current organization (OU), including workflow files and sub-directories.
Prerequisite¶
The user must belong to the OU which the target directories belong to.
Request Format¶
GET https://{apigw-address}/dataflow-batch-service/v2.0/directories?action=listWorkFlowDirs
Request Parameters (URI)¶
| Name | Location (Path/Query) | Mandatory/Optional | Data Type | Description |
|---|---|---|---|---|
| userId | Query | Mandatory | String | The user ID. How to get userId>> |
| orgId | Query | Mandatory | String | The organization ID which the user belongs to. How to get orgId>> |
Response Parameters¶
| Name | Data Type | Description |
|---|---|---|
| data | Array of WorkFlowDir Structs | The list of the workFlowDir structs, including all the workflow files and sub-directories. For more information, see WorkFlowDir Struct |
WorkFlowDir Struct¶
Sample¶
{
"children": [],
"title":"Workflow",
"type": 1,
"key": "249a33bd419a4710b1567f5088f8955b",
"isDirectory": true
}
Parameters¶
| Name | Data Type | Description |
|---|---|---|
| children | Array of WorkFlowDir Structs | The list of the files or sub-directories. |
| title | String | The name of the files or sub-directories. |
| type | String | The type of directory.
|
| key | String | The directory ID. |
| isDirectory | Boolean |
|
Error Code¶
| Code | Message | Description |
|---|---|---|
| 62109 | Server internal exception | Internal server exception. |
For other error codes, see Common Error Codes.
Samples¶
Request Sample¶
url: https://{apigw-address}/dataflow-batch-service/v2.0/directories?action=listWorkFlowDirs&userId=yourUserId&orgId=yourOrgId
method: GET
Return Sample¶
"status": 0,
"msg": " Success",
"data": [
{
"children": [
{
"children": [],
"title": "String1",
"type": 1,
"key": "***************",
"isDirectory": true
},
{
"children": [
{
"editable": true,
"title": "workflow1",
"type": 1,
"key": 2512,
"isDirectory": false
}
],
"title": "ffdir",
"type": 1,
"key": "**************",
"isDirectory": true
},
{
"children": [],
"title": "dirt",
"type": 1,
"key": "************",
"isDirectory": true
}
],
"title": "Workflow",
"type": 1,
"key": "***************",
"isDirectory": true
}
]
}