Retrieves a list of business processes.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
No |
The page number, starting from 1. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Valid values: 1 to 100. Default value: 10. |
10 |
| ProjectId |
integer |
Yes |
The workspace ID. |
10000 |
| TenantId |
integer |
No |
The tenant ID. This parameter is deprecated. |
10001 |
| GroupNameKeyword |
string |
No |
The keyword used to filter business processes whose names contain the keyword. |
Test business process |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
0000-ABCD-EF**** |
| GroupPagingResult |
object |
The paginated list of business processes. |
|
| PageNumber |
integer |
The page number. Same as the PageNumber parameter in the request. |
1 |
| PageSize |
integer |
The number of entries per page. Valid values: 1 to 100. Default value: 10. |
10 |
| TotalCount |
integer |
The total number of entries returned. |
100 |
| Groups |
array<object> |
The business processes. |
|
|
object |
|||
| ModifiedTime |
string |
The time when the business process was modified. |
2020-09-24T18:37:51+0800 |
| Description |
string |
The description of the business process. |
Business process description |
| GroupName |
string |
The name of the business process. |
Business process name |
| GroupId |
string |
The business process ID. |
ds_123abc |
| ProjectId |
integer |
The workspace ID. |
10002 |
| ApiGatewayGroupId |
string |
The ID of the API Gateway group bound to the workflow. |
100abc |
| CreatorId |
string |
The UID of the business process creator. May be empty for some existing business processes. |
10001 |
| CreatedTime |
string |
The time when the business process was created. |
2020-09-24T18:37:51+0800 |
| TenantId |
integer |
The tenant ID. |
10003 |
Examples
Success response
JSON format
{
"RequestId": "0000-ABCD-EF****",
"GroupPagingResult": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Groups": [
{
"ModifiedTime": "2020-09-24T18:37:51+0800",
"Description": "Business process description",
"GroupName": "Business process name",
"GroupId": "ds_123abc",
"ProjectId": 10002,
"ApiGatewayGroupId": "100abc",
"CreatorId": "10001",
"CreatedTime": "2020-09-24T18:37:51+0800",
"TenantId": 10003
}
]
}
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.