This guide walks you through the process of container onboarding in Case Service, including Neutrinos BPM deployment, and API usage for process and case definition.
1. Create a Neutrinos BPM Flow
-
Design the Case Flow:
- Use your Neutrinos BPM designer to create the required flow for the case.
- Ensure all tasks, rules, and decision points are configured properly.
-
Save and Deploy the Flow:
- Save the designed process.
- Deploy the process to make it available for execution.
- You could go to execution servers to check if the flow is deployed correctly.
2. Retrieve Deployment Details
-
Access Process Definitions:
- Go to the Process Definitions section in your Neutrinos BPM dashboard.
- Locate the recently deployed process.
- Note Down Identifiers:
- Identify and note the Definition ID and Deployment. These details will be needed for invoking the BPM service.
3. Use the Bpm service API
- Go to the api-docs of the bpmservice:
- Use the following details:
- processDefinitionId:
- containerId:
- API Endpoint: ${DOMAIN}/bpmservice/api-docs#/Process%20Definition/ProcessDefinitionController_getById
4. Process Definition Creation and Case Definition
- API Response: Above API will return a response similar to this:
{
"processName": "Registration Review",
"processVersion": "1.0",
"processDefinitionId": "create-case.RegistrationReview",
"metadata": {
"containerId": "create-case_1.0.0-SNAPSHOT",
"variables": null,
"reusableSubProcesses": null,
"nodes": null,
"timers": null,
"tagsByVariable": null,
"package": "com.myspace.create_case",
"dynamic": false
},
"taskDefinitions": [
{
"taskName": "Registration",
"taskType": "Human Task",
"metadata": {
"owner": ["High"]
}
}
]
}
-
Process Definition API:
- Copy the above response.
- Use the POST ${DOMAIN}/caseservice/process/definition/create API.
- Paste the copied data and hit “Execute / Send”.
-
Obtain pdid:
- The API will return a pdid in the response.
Case Definition Creation:
-
Subprocess Handling:
- If your case involves a subprocess:
- Follow the same step as above.
- Copy the Definition ID and Deployment.
- Get the process definition by its ID.
- Use the response to create the process definition for the subprocess.
- If your case involves a subprocess:
-
Add the subprocess pdid to the subProccess array.
-
Use the obtained pdid to call the POST ${DOMAIN}/caseservice/case/definition/create API.
-
Example payload:
{
"caseDefinitionSchema": {
"caseSchema": {},
"pdid": "<PASTE_PDID_HERE>",
"subProccess": ["<SUBPROCESS_PDID>"],
"active": true
},
"caseType": "claim_registration",
"version": "string"
}
- Replace:
- <PASTE_PDID_HERE> with the pdid from the previous response.
- <SUBPROCESS_PDID> with subprocess IDs, if applicable.
- Add a unique caseType (e.g., claim_registration).
- Case definition response
- After completing these steps, you will successfully create a case using the specified case type.
Using the casetype, call the POST ${DOMAIN}/caseservice/case/instance/create
For creating a case.
Feel free to ask questions or share feedback below! 
