Wizards¶
Wizards are the forms an end user fills in outside the Case Manager. Another system can start one and hand the person the link to it.
Start a creation wizard¶
POST /api/1/wizard_templates/{wizard_template_uuid}/start_creation_wizard
Creates a case and its instance, and answers with the link to the wizard that fills them in. The person lands on the entry step the wizard names, so the link needs no body and no instance.
Example
curl -X POST \
-H "Authorization: Api-Key $ATFINITY_API_KEY" \
https://your-tenant.atfinity.app/api/1/wizard_templates/<wizard_template_uuid>/start_creation_wizard
Response 201
The case the wizard runs on and the link to hand to the end user.
data(object)case_id(integer)link(string)url(string)wizard_uuid(string, uuid)
{
"data": {
"case_id": 4711,
"link": "/wc/0c8a6d1e-6d3f-4a4e-9b0e-2f0f6a1a77c2",
"url": "https://wizard.example.com/wc/0c8a6d1e-6d3f-4a4e-9b0e-2f0f6a1a77c2",
"wizard_uuid": "0c8a6d1e-6d3f-4a4e-9b0e-2f0f6a1a77c2"
}
}
Start an ongoing wizard for an instance¶
POST /api/1/wizard_templates/{wizard_template_uuid}/start_lifecycle_wizard
Creates a case for one instance of a lifecycle process, and answers with the link to the wizard that continues it. Name the instance either by its Atfinity id or by the external identifier the wizard names.
Request body
instance_id(integer)instance_identifier(string)skip_authentication(boolean)
Send at least one of instance_id, instance_identifier.
Example
curl -X POST \
-H "Authorization: Api-Key $ATFINITY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"instance_identifier": "CH93-0076-2011-6238-5295-7", "skip_authentication": true}' \
https://your-tenant.atfinity.app/api/1/wizard_templates/<wizard_template_uuid>/start_lifecycle_wizard
Response 201
The case the wizard runs on and the link to hand to the end user.
data(object)case_id(integer)link(string)url(string)wizard_uuid(string, uuid)