curl --request POST \
--url https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
response = requests.post(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore",
headers={"x-service-key": "{YOUR_SERVICE_KEY}"},
)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore",
{
method: "POST",
headers: { "x-service-key": "{YOUR_SERVICE_KEY}" },
}
);
const data = await response.json();
console.log(data);
{
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isArchived": false
}
Workflows
Restore a Workflow
Un-archive a workflow, returning it to listings
POST
/
api
/
v1
/
workflow
/
{workflowId}
/
restore
curl --request POST \
--url https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
response = requests.post(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore",
headers={"x-service-key": "{YOUR_SERVICE_KEY}"},
)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore",
{
method: "POST",
headers: { "x-service-key": "{YOUR_SERVICE_KEY}" },
}
);
const data = await response.json();
console.log(data);
{
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isArchived": false
}
Un-archive a workflow, returning it to listings. This is the inverse of Archive a Workflow.
Requires the Workflow: Full permission on the workflow.
Restoring is idempotent in the same way archiving is: restoring a workflow that is not archived succeeds and changes nothing.
Path Parameters
string
required
The ID of the workflow to restore
Headers
string
required
Your API authentication key
Response
string
required
The workflow ID that was restored — the same ID you supplied in the path
boolean
required
Archive status after the call. Always
false on a 2xx response.This is the mirror of Archive a Workflow, so you can read the result of an archive and a restore the same way.
archivedAt and archivedBy are deliberately not returned here — on a restore they are cleared by definition, and returning two always-null fields would suggest “unknown” rather than “not applicable”.Errors
Unauthorized
Missing, invalid, or expired API key.
Forbidden
No access to this workflow.
Not Found
The workflow does not exist.
curl --request POST \
--url https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
response = requests.post(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore",
headers={"x-service-key": "{YOUR_SERVICE_KEY}"},
)
print(response.json())
const response = await fetch(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}/restore",
{
method: "POST",
headers: { "x-service-key": "{YOUR_SERVICE_KEY}" },
}
);
const data = await response.json();
console.log(data);
{
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isArchived": false
}
Was this page helpful?