Procesos

List of public endpoints for process templates

Esta página aún no ha sido traducida al español.

Process Templates are the official name of processes that have been created for your organization.

Dont forget to include the Authorization and X-Organization headers in every request. They have been omitted from these endpoints for brevity.

Basic Endpoints

These endpoints allow you to index, view, update and delete process templates.

Index

GET https://api.seliom.com/process_templates/basic

This endpoint retrieves the process templates that your account has permissions to see.

Path Parameters

NameTypeDescription

launchable

string

If true, include only processes your user has permissions to create cases for.

.

Index - API Launchable

GET https://api.seliom.com/process_templates/basic/launchables

This endpoint retrieves the process templates that your account has permissions to see and create cases for via the API.

{
    "process_templates": [
        {
            "name": "Time-off Requests",
            "uuid": "5c7549b6-3f7b-4c96-8346-141326da5cf0",
            "launchable": true,
            "resource_type": "process",
            "automated": true
        }
    ]
}

Show Process Template

GET https://api.seliom.com/process_templates/basic/:template_uuid

This endpoint retrieves a specific process template that your account has permissions to see.

Path Parameters

NameTypeDescription

template_uuid

string

UUID of the process template

{
    "process_template": {
        "name": "Time-off Requests",
        "uuid": "5c7549b6-3f7b-4c96-8346-141326da5cf0",
        "automated": true
    },
    "can_launch": true
}

Update Process Template

PUT https://api.seliom.com/process_templates/basic/:template_uuid

Updates a given process template's name

Path Parameters

NameTypeDescription

template_uuid

string

UUID of the process template

Request Body

NameTypeDescription

name

string

New name for the process template

{
    "message": "Process updated successfully!"
}

Delete Process Template

DELETE https://api.seliom.com/process_templates/directory/:template_uuid

Updates a given process template's name

Path Parameters

NameTypeDescription

template_uuid

string

UUID of the process template

{
    "message": "You have successfully deleted the process"
}

Automation Endpoints

These endpoints allow you to request the information required by a process template in order to create a case for it.

Start Definition

GET https://api.seliom.com/process_templates/automation/:template_uuid/start_definition

This endpoint retrieves the information required by the start node of a process template in order to create a case for it.

Path Parameters

NameTypeDescription

template_uuid

string

UUID of the process template

{
    "process_template": {
        "name": "Time-off Requests",
        "uuid": "5c7549b6-3f7b-4c96-8346-141326da5cf0"
    }, 
    "manual_label": true,
    "definition_elements": [
        {
            "definition": {
                "label": "Start Date",
                "identifier": "0e49e482-b6f0-4f28-8a59-b5c506620760",
                "type": "date",
                "assignedID": "start_date",
                "required": true
            }
        },
        {
            "definition": {
                "label": "End Date",
                "identifier": "ad219870-183f-427c-b4c3-f2454447ecb6",
                "type": "date",
                "assignedID": "end_date",
                "required": true
            }
        }
    ]

Team Members - Start Definition

GET https://api.seliom.com/process_templates/automation/:template_uuid/definition_element/:definition_element_uuid/members

Team member form fields require another request in order to retrieve the list of users that can be selected from the dropdown menu.

Path Parameters

NameTypeDescription

definition_element_uuid

string

The UUID of the definition element of type team_members

template_uuid

string

UUID of the process template

{
    "members": [
        {
            "uuid": "3cd4ca21-fa4d-4bed-9217-fb495c748d0c",
            "first_name": "Clark",
            "last_name": "Kent",
            "invitation_status": "accepted",
            "deleted": false,
            "slug": "clark-kent"
        }
    ]
}

Last updated