Overview
This API locks or unlocks a workflow. When a workflow is locked, it cannot be modified.
HTTP Request
POST http://magnus.viantinc.com/remote
Request Body
{
"c": string,
"configuration": {
"lockWorkflows": {
"workflowIds": [
string
],
"comment": string
},
"unlockWorkflows": {
"workflowIds": [
string
],
"comment": string
}
}
}
|
Property name |
Value |
Description |
|
c |
· 6f570e7l: To lock workflows · 6f570e7u: To unlock workflows |
[Required] Command to lock or unlock workflows |
|
configuration |
object |
[Required] Configuration of the request |
|
lockWorkflows |
object |
[Pick one] Configuration to lock workflows |
|
unlockWorkflows |
object |
[Pick one] Configuration to unlock workflows |
|
lockWorkflows.workflowIds |
list of strings |
[Required] Ids of workflows to lock |
|
lockWorkflows.comment |
string |
[Optional] Save comment |
|
unlockWorkflows.workflowIds |
list of strings |
[Required] Ids of workflows to unlock |
|
unlockWorkflows.comment |
string |
[Optional] Save comment |
HTTP Response
If the request is submitted successfully, the following response body will be returned.
{
"status": "ok",
"result": {
"updatedWorkflows": [
string
],
"errors": [
string
]
}
}
|
Property name |
Value |
Description |
|
status |
string |
Status of the API request. · ok: the request is submitted successfully. · failed: the request is invalid. |
|
result |
object |
Result from the API request |
|
updatedWorkflows |
list of strings |
The ids of the workflows that were successfully updated. |
|
errors |
list of strings |
Errors from the API request. If present, this indicates that some workflows have failed to be updated. |
Permission
Only org admins are allowed to call this API.
Errors
|
Error reason |
HTTP code |
Description |
|
invalid |
400 |
This error is returned when: 1. the workflowIds is empty 2. the input command is invalid |
|
accessDenied |
403 |
This error is returned when caller is not org admin. |
|
backendError |
500 |
This error is returned when there is backend error in Magnus. |