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.

get
Index

https://api.seliom.com/process_monitor/process_instances
This endpoint retrieves all the cases that the user has permissions to see.
Request
Response
Request
Query Parameters
sort_by
optional
string
Sort the resulting cases by: status, newest, oldest.
created_before
optional
string
Date in ISO 8601 to filter by.
created_after
optional
string
Date in ISO 8601 to filter by.
status
optional
array
Array of statuses to filter by: running, error, stopped, completed, paused.
process_type
optional
array
Array of UUIDs of the process templates to filter by
cursor
optional
string
Cursor used for pagination
Response
200: OK
Process instances successfully retrieved.
{
"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
}

get
Show Case

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.
Request
Response
Request
Path Parameters
process_instance_uuid
required
string
UUID of the process instance
Response
200: OK
Process instance successfully retrieved.
{
"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"
]
}
403: Forbidden
Not allowed to see the process instance requested.
{
"message": "You do not have permissions to view this process instance"
}
404: Not Found
Process instance not found
{
"message": "Process instance not found"
}

get
List Case Documents

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.
Request
Response
Request
Path Parameters
process_instance_uuid
required
string
UUID of the process instance
Response
200: OK
Process instance documents successfully retrieved.
{
"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"
}
]
}
]
}
]
}

post
Create New Case

https://api.seliom.com/process_instances
This endpoint creates a new case based on a given process template.
Request
Response
Request
Body Parameters
label
optional
string
Label for the new case. Required if it has not been automated in the process template.
submission_elements
required
object
Form elements required to create a case for the given process template
process_template_uuid
required
string
UUID of the process template
Response
200: OK
Case created successfully.
{
"message": "Process launched successfully!",
"process_instance_uuid": "972a4cb0-8f4e-43b3-9e54-99c952f8531e"
}
400: Bad Request
Label is required for the process template
{
"message": "Please provide a label"
}
401: Unauthorized
User does not have necessary permissions
{
"message": "You do not have permissions to launch this process"
}

put
Pause Case

https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid/pause
This endpoint pauses a process instance that is currently running.
Request
Response
Request
Response
200: OK
{
"message": "Your process instance has been paused"
}

put
Stop Case

https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid/stop
This endpoint stops a process instance that is currently running.
Request
Response
Request
Response
200: OK
{
"message": "Your process instance has been stopped"
}

put
Resume Case

https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid/resume
This endpoint resumes a process instance that was previously stopped or paused.
Request
Response
Request
Response
200: OK
{
"message": "Your process instance has been resumed"
}

delete
Delete Case

https://api.seliom.com/process_monitor/process_instances/:process_instance_uuid
This endpoint permanently deletes a process instance.
Request
Response
Request
Response
200: OK
{
"message": "Your process instance has been deleted"
}