Performing a Batch Offline Operation
Function
This API is used to perform a batch offline operation.
URI
POST /v2/{project_id}/design/approvals/batch-offline
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
biz_infos |
Yes |
Array of BizInfoVO objects |
List of business information |
|
approver_user_id |
Yes |
String |
Approver ID |
|
approver_user_name |
Yes |
String |
Approver username |
|
|
No |
String |
Approver email address |
|
fast_approval |
No |
Boolean |
Fast approval for quick experience in informal scenario. This function is available only when you have the approval permission. Default: false |
|
schedule_time |
No |
String |
Job scheduling time |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
biz_id |
Yes |
Long |
Business ID |
|
biz_type |
Yes |
String |
Business types Enumeration values:
|
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
Long |
ID |
|
tenant_id |
String |
tenant id |
|
group_id |
Long |
group id |
|
biz_name |
String |
Business name |
|
biz_id |
Long |
Business ID |
|
operation_status |
String |
Enumeration values:
|
|
operation_type |
String |
Operation type |
|
biz_info |
String |
Business information |
|
create_by |
String |
Creator |
|
remark |
String |
Remarks |
|
total |
Integer |
Total number of operations Default: 0 |
|
success |
Integer |
Number of successful operations Default: 0 |
|
failed |
Integer |
Number of failed operations Default: 0 |
|
rate |
String |
Progress Default: 0 |
|
logs |
String |
Logs |
|
groups |
Array of BatchOperationVO objects |
Groups |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.000 which indicates that the request was successfully processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.000 which indicates that the request was successfully processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.000 which indicates that the request was successfully processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.000 which indicates that the request was successfully processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data |
Example Requests
{
"approver_user_id" : "7b71e498e75d44048c9a22dd3c54f978",
"approver_user_name" : "ei_dlg",
"biz_infos" : [ {
"biz_id" : "885123875376193536",
"biz_type" : "CODE_TABLE"
}, {
"biz_id" : "885123958788317184",
"biz_type" : "CODE_TABLE"
} ],
"email" : null,
"fast_approval" : true
}
Example Responses
Status code: 200
The operation succeeds. The BatchOperationVO object in the BatchOperationVO.group attribute is returned.
{
"data" : {
"value" : {
"SUCCESS" : [ "name1-id", "name2-id" ],
"errors" : "[{id: 111, reason: exceptions}]"
}
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The operation succeeds. The BatchOperationVO object in the BatchOperationVO.group attribute is returned. |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.