API
Work with a case through the API
Choose a case type, create a case, perform authorised work, and read the result.
Before you start
Use a published case type in a development tenant. Confirm the actor has the exact case actions needed by the journey.
Follow the journey
- List case types and select the intended definition.
- Read it and confirm the lifecycle state.
- Create a case with the smallest valid fictitious information.
- Keep the case identifier and request ID.
- Read the case and available plan items.
- Perform only an enabled and authorised plan item action.
- Read the case again and confirm the resulting state.
- Read any related files or events needed by the approved process.
Do not force lifecycle state
Use the specific transition or plan item action when one exists. Do not use a general update to bypass validation, required work, or an approval.
Handle conflict
Another actor or background action may change the case. Read current state, resolve the named conflict, and submit a deliberate new action.
Reference
Use the Cases and case types API reference for exact request and response fields.
Was this page helpful?
Your answer helps us improve the documentation.
Do not include personal information, customer information, passwords, or keys.