Casos List of public endpoints for cases
Esta página aún no ha sido traducida al español.
Cases represent instances of your process templates. For example, if you have a process template called Purchase Order Approval , a case would be a specific purchase order that needs to be approved.
In Seliom's API, cases also receive the name of Process Instances.
Dont forget to include the Authorization and X-Organization headers in every request. They have been omitted from these endpoints for brevity.
Index
GET
https://api.seliom.com/process_monitor/process_instances
This endpoint retrieves all the cases that the user has permissions to see.
Query Parameters
200 Process instances successfully retrieved.
Copy {
"processes": [
"name": "My first time-off request",
"created_at": "2021-02-22 18:37:25 UTC",
"uuid": "23d6ff0b-717c-4712-b988-ab3e5c9732f3",
"completed_date": null,
"status": "running",
"sequential_id": 1,
"process_template": {
"name": "Time-off Requests",
"uuid": "5c7549b6-3f7b-4c96-8346-141326da5cf0",
"launchable": true,
"resource_type": "process",
"automated": true
},
"launcher" : {
"first_name": "Clark",
"last_name": "Kent",
"uuid": "3cd4ca21-fa4d-4bed-9217-fb495c748d0c"
}
],
"next_cursor": null,
"prev_cursor": null,
"total": 1,
"limit": 15,
"page": 1
}
Show Case
GET
https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid
This endpoint retrieves a specific case and the permissions your user has for it.
Path Parameters
200 Process instance successfully retrieved. 403 Not allowed to see the process instance requested. 404 Process instance not found
Copy {
"process_instance": {
"name": "My first time-off request",
"created_at": "2021-02-22 18:37:25 UTC",
"uuid": "23d6ff0b-717c-4712-b988-ab3e5c9732f3",
"completed_date": null,
"status": "running",
"sequential_id": 1,
"process_template": {
"name": "Time-off Requests",
"uuid": "5c7549b6-3f7b-4c96-8346-141326da5cf0",
"launchable": true,
"resource_type": "process",
"automated": true
},
"launcher" : {
"first_name": "Clark",
"last_name": "Kent",
"uuid": "3cd4ca21-fa4d-4bed-9217-fb495c748d0c"
}
},
"permissions": [
"Edit tasks",
"Perform actions",
"Delete instance",
"Edit comments",
"View process instance",
"Manage case permissions",
"Rollback case"
]
}
Copy {
"message": "You do not have permissions to view this process instance"
}
Copy {
"message": "Process instance not found"
}
List Case Documents
GET
https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid/documents
This endpoint retrieves all task submissions associated to a case that contain documents.
Path Parameters
200 Process instance documents successfully retrieved.
Copy {
"docs": [
{
"id": "a340197d-7eab-49d5-9880-1da29fefaa35",
"status": "completed",
"assignee_type": "member",
"member": {
"first_name": "Clark",
"last_name": "Kent",
"uuid": "23d6ff0b-717c-4712-b988-ab3e5c9732f3"
},
"task_definition": {
"id": "cade268a-443e-44d8-9c71-667079bb7ac5",
"name": "Upload customer documentation",
"task_type": "task"
},
"documents_info": [
"field_name": "Customer documents",
"content": {
"type": "attachment",
"files": [
{
"originalName": "mydocs.pdf",
"storageName": "cade268a-443e-44d8-9c71-667079bb7ac5/1572657277933_mydocs.pdf"
}
]
}
]
}
]
}
Create New Case
POST
https://api.seliom.com/process_instances
This endpoint creates a new case based on a given process template.
Request Body
200 Case created successfully. 400 Label is required for the process template 401 User does not have necessary permissions
Copy {
"message": "Process launched successfully!",
"process_instance_uuid": "972a4cb0-8f4e-43b3-9e54-99c952f8531e"
}
Copy {
"message": "Please provide a label"
}
Copy {
"message": "You do not have permissions to launch this process"
}
Pause Case
PUT
https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid/pause
This endpoint pauses a process instance that is currently running.
200
Copy {
"message": "Your process instance has been paused"
}
Stop Case
PUT
https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid/stop
This endpoint stops a process instance that is currently running.
200
Copy {
"message": "Your process instance has been stopped"
}
Resume Case
PUT
https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid/resume
This endpoint resumes a process instance that was previously stopped or paused.
200
Copy {
"message": "Your process instance has been resumed"
}
Delete Case
DELETE
https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid
This endpoint permanently deletes a process instance.
200
Copy {
"message": "Your process instance has been deleted"
}