Introduction

Pagination query params are as follows: page[size]=10&page[number]=1

Base URL: http://base.sf.local

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {ENVIRONMENT_AUTH_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Use environment auth token for authentication.

Business Process Models

List Business Process Models

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://base.sf.local/api/v2/environment/business-process-models',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'published'=> '54fd-adg-aa',
            'sort'=> 'name,-created_at,-updated_at',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/business-process-models"
);

const params = {
    "published": "54fd-adg-aa",
    "sort": "name,-created_at,-updated_at",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "http://base.sf.local/api/v2/environment/business-process-models?published=54fd-adg-aa&sort=name%2C-created_at%2C-updated_at" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


{
    "data": [
        {
            "owner_id": "b5556cf0-b85e-11ed-97bf-9f9abe984826",
            "organization_id": "b559de10-b85e-11ed-9ea6-f9097a60dc17",
            "category_id": 273318,
            "business_process_id": 11225,
            "name": "in",
            "_lft": 1281503956,
            "_rgt": 1240258686,
            "summary": "I dare say you never even introduced to a lobster--' (Alice began to tremble. Alice looked all round the hall, but they were IN the well,' Alice said to herself 'Suppose it should be free of them at.",
            "type": "process",
            "_key": null
        },
        {
            "owner_id": "b56fc510-b85e-11ed-8d92-1b0899fa2b22",
            "organization_id": "b5729540-b85e-11ed-883a-6913232e12e4",
            "category_id": 273320,
            "business_process_id": 11226,
            "name": "dolorum",
            "_lft": 1665961527,
            "_rgt": 1716473316,
            "summary": "And yesterday things went on in these words: 'Yes, we went to school in the middle, wondering how she was about a whiting to a mouse: she had someone to listen to me! When I used to know. Let me.",
            "type": "process",
            "_key": null
        }
    ]
}

Received response:

Request failed with error:

Request

GET api/v2/environment/business-process-models

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Query Parameters

published string optional

Filter only ones that published within specified environment. Example: 54fd-adg-aa

sort string optional

Sorting by specified criteria. Example: name,-created_at,-updated_at

View Business Process Submission Form

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://base.sf.local/api/v2/environment/business-process-models/0c74dad0-861e-11ed-b164-8b1fed5618f1/form',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/business-process-models/0c74dad0-861e-11ed-b164-8b1fed5618f1/form"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "http://base.sf.local/api/v2/environment/business-process-models/0c74dad0-861e-11ed-b164-8b1fed5618f1/form" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


{
    "data": [
        [],
        []
    ]
}

Example response (200):


{
  "data": {
    "some_string_property": {
      "attribute": {
        "reference": "some_string_property",
        "engine_reference": "someStringProperty",
        "type": "string",
        "label": "Some String Property",
      "value": "122",
    },
    "some_integer_property": {
      "attribute": {
        "reference": "some_integer_property",
        "engine_reference": "someIntegerProperty",
        "type": "integer",
        "label": "Some Integer Property",
      "value": 122,
    },
    "some_float_property": {
      "attribute": {
        "reference": "some_float_property",
        "engine_reference": "someFloatProperty",
        "type": "float",
        "label": "Some Float Property",
        "value": 122.0
    },
    "some_boolean_property": {
      "attribute": {
        "reference": "some_boolean_property",
        "engine_reference": "someBooleanProperty",
        "type": "boolean",
        "label": "Some Boolean Property",
        "value": true
    },
    "some_date_property": {
      "attribute": {
        "reference": "some_date_property",
        "engine_reference": "someDateProperty",
        "type": "date",
        "label": "Some Date Property",
        "value": "2035-01-01"
    },
    "some_date_time_property": {
      "attribute": {
        "reference": "some_date_time_property",
        "engine_reference": "someDateTimeProperty",
        "type": "date_time",
        "label": "Some Date Time Property",
        "value": "2035-01-01T00:00:00Z"
    },
  }
}

Received response:

Request failed with error:

Request

GET api/v2/environment/business-process-models/{business_process_model}/form

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

business_process_model string

Example: 0c74dad0-861e-11ed-b164-8b1fed5618f1

Start Business Process

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/business-process-models/0c74dad0-861e-11ed-b164-8b1fed5618f1/start',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'submission' => [
                'accusamus',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/business-process-models/0c74dad0-861e-11ed-b164-8b1fed5618f1/start"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "submission": [
        "accusamus"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/business-process-models/0c74dad0-861e-11ed-b164-8b1fed5618f1/start" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"submission\": [
        \"accusamus\"
    ]
}"

Example response (200):


{
    "data": {
        "owner_id": "b58b8300-b85e-11ed-83f4-695ada5edd2e",
        "organization_id": "b58e59e0-b85e-11ed-b1c1-a5050e73bfbb",
        "category_id": 273322,
        "business_process_id": 11227,
        "name": "debitis",
        "_lft": 1088754132,
        "_rgt": 355415545,
        "summary": "At last the Dodo managed it.) First it marked out a box of comfits, (luckily the salt water had not a VERY unpleasant state of mind, she turned to the other paw, 'lives a Hatter: and in THAT.",
        "type": "process",
        "_key": null
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/business-process-models/{business_process_model}/start

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

business_process_model string

Example: 0c74dad0-861e-11ed-b164-8b1fed5618f1

Body Parameters

submission string[]

Environment

View Current Environment

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://base.sf.local/api/v2/environment',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "http://base.sf.local/api/v2/environment" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


{
    "data": {
        "organization_id": "b535bba0-b85e-11ed-a045-f5b82382dc97",
        "engine_id": "b53dd490-b85e-11ed-be60-659869b0827a",
        "engine_reference": "3458b752-6633-3f00-b0b5-f0d9408445b1",
        "production": true,
        "name": "eaque",
        "auth_token": "397fcab5-85c7-3bc1-b72a-9b9366beb11d",
        "_key": null
    }
}

Received response:

Request failed with error:

Events

Send Message

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/events/message',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'reference' => 'et',
            'context' => 'occaecati',
            'submission' => [
                'voluptas',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/events/message"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reference": "et",
    "context": "occaecati",
    "submission": [
        "voluptas"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/events/message" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reference\": \"et\",
    \"context\": \"occaecati\",
    \"submission\": [
        \"voluptas\"
    ]
}"

Example response (200):


{
    "data": {
        "name": "error",
        "type": "et"
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/events/message

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

reference string

Example: et

context string

Example: occaecati

submission string[]

Send Message

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/events/signal',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'reference' => 'quia',
            'submission' => [
                'tenetur',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/events/signal"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reference": "quia",
    "submission": [
        "tenetur"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/events/signal" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reference\": \"quia\",
    \"submission\": [
        \"tenetur\"
    ]
}"

Example response (200):


{
    "data": {
        "name": "quis",
        "type": "odio"
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/events/signal

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

reference string

Example: quia

submission string[]

Service Tasks

Lock Service Tasks

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/service-tasks',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'lock' => 'perspiciatis',
            'topic' => 'iste',
            'duration' => 856.34211,
            'limit' => 3.0145,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/service-tasks"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lock": "perspiciatis",
    "topic": "iste",
    "duration": 856.34211,
    "limit": 3.0145
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/service-tasks" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lock\": \"perspiciatis\",
    \"topic\": \"iste\",
    \"duration\": 856.34211,
    \"limit\": 3.0145
}"

Example response (200):


{
    "data": [
        {
            "reference": "odit",
            "topic": "accusamus",
            "suspended": false,
            "priority": 33,
            "environment": {
                "organization_id": "b63635c0-b85e-11ed-bd4b-fdac9eee3752",
                "engine_id": "b6371f60-b85e-11ed-a710-e10e26996435",
                "engine_reference": "c925e661-9625-3a34-b566-e41b6c522784",
                "production": false,
                "name": "et",
                "auth_token": "e9726457-0db4-3096-bbe3-c3ca711ae397"
            },
            "activity": {
                "name": "debitis",
                "reference": "tempora"
            },
            "instance": {
                "reference": "iure",
                "startedAt": {
                    "date": "1981-12-12 14:11:37.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "endedAt": {
                    "date": "1972-11-30 00:32:55.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "publication": {
                    "business_model_diagram_id": "b64d82b0-b85e-11ed-82f2-e1ca1bc3c3ba",
                    "engine_deployment_reference": "be7434f2-81e3-30c5-a55f-463982403e37",
                    "engine_diagram_reference": "7dfa7264-6b40-3b0e-9da8-6bd6f4eb6b3b",
                    "engine_model_reference": "Process_QuiEaEtUtUt."
                },
                "context": "id",
                "attributes": []
            },
            "attributes": []
        },
        {
            "reference": "ea",
            "topic": "sint",
            "suspended": true,
            "priority": 922,
            "environment": {
                "organization_id": "b64ec120-b85e-11ed-8a94-65cd63fa3fdb",
                "engine_id": "b64f8f20-b85e-11ed-9fec-0380730f4dd2",
                "engine_reference": "1e30bba7-64b8-3336-b6f7-39d454bec175",
                "production": true,
                "name": "rem",
                "auth_token": "5e848b66-ebf7-34af-9aad-d608215e6fdb"
            },
            "activity": {
                "name": "sequi",
                "reference": "sit"
            },
            "instance": {
                "reference": "hic",
                "startedAt": {
                    "date": "2014-11-05 10:44:51.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "endedAt": {
                    "date": "1999-06-20 00:49:33.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "publication": {
                    "business_model_diagram_id": "b6663ad0-b85e-11ed-949d-8535336e2d24",
                    "engine_deployment_reference": "bfd04322-69f0-3762-b4a2-3e0218bf7e31",
                    "engine_diagram_reference": "9ba8d4d4-f161-35ee-b0b1-81bc1c14f374",
                    "engine_model_reference": "Process_MinimaBeataeQuam."
                },
                "context": "et",
                "attributes": []
            },
            "attributes": []
        }
    ]
}

Received response:

Request failed with error:

Request

POST api/v2/environment/service-tasks

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

lock string

Example: perspiciatis

topic string

Example: iste

duration number

Example: 856.34211

limit number

Example: 3.0145

Serve Service Task

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/service-tasks/3688e6c0-1a56-11ec-8366/serve',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'lock' => 'in',
            'submission' => [
                'consequuntur',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/service-tasks/3688e6c0-1a56-11ec-8366/serve"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lock": "in",
    "submission": [
        "consequuntur"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/service-tasks/3688e6c0-1a56-11ec-8366/serve" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lock\": \"in\",
    \"submission\": [
        \"consequuntur\"
    ]
}"

Example response (200):


{
    "data": {
        "reference": "deserunt",
        "topic": "sit",
        "suspended": true,
        "priority": 37212930,
        "environment": {
            "organization_id": "b6696c30-b85e-11ed-b9d1-2f759b40ad32",
            "engine_id": "b66a3ec0-b85e-11ed-89cf-93dfd69fe721",
            "engine_reference": "aa9961a2-5a1d-3337-8787-137257bd21c8",
            "production": false,
            "name": "facilis",
            "auth_token": "7356e7ab-aa9e-3e32-bbe4-4a06ed538b93"
        },
        "activity": {
            "name": "commodi",
            "reference": "similique"
        },
        "instance": {
            "reference": "natus",
            "startedAt": {
                "date": "2002-11-20 22:53:47.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "endedAt": {
                "date": "2000-01-16 07:54:45.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "publication": {
                "business_model_diagram_id": "b6817b30-b85e-11ed-96fb-d1bc9edbf695",
                "engine_deployment_reference": "d12f2e60-2d74-30cc-9e29-d100eadcf81a",
                "engine_diagram_reference": "450d4afa-a715-368c-97b1-b869960f3505",
                "engine_model_reference": "Process_ExSunt."
            },
            "context": "est",
            "attributes": []
        },
        "attributes": []
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/service-tasks/{reference}/serve

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

reference string

The reference of a service task. Example: 3688e6c0-1a56-11ec-8366

Body Parameters

lock string

Example: in

submission string[]

Serve Multiple Service Tasks

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/service-tasks/SOME_SERVICE_TASK/serve-multiple',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'lock' => 'sequi',
            'external_execution_reference' => 'sed',
            'submission' => [
                'aut',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/service-tasks/SOME_SERVICE_TASK/serve-multiple"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lock": "sequi",
    "external_execution_reference": "sed",
    "submission": [
        "aut"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/service-tasks/SOME_SERVICE_TASK/serve-multiple" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lock\": \"sequi\",
    \"external_execution_reference\": \"sed\",
    \"submission\": [
        \"aut\"
    ]
}"

Example response (200):


{
    "data": {
        "reference": "facere",
        "topic": "commodi",
        "suspended": false,
        "priority": 24278,
        "environment": {
            "organization_id": "b6846370-b85e-11ed-8f26-4db7b6079e5c",
            "engine_id": "b6853dd0-b85e-11ed-8450-7990586ced93",
            "engine_reference": "736912dc-b32f-30c8-863a-d99f4de06a23",
            "production": false,
            "name": "at",
            "auth_token": "be164d90-1cb1-37e6-ac62-dc8e55109687"
        },
        "activity": {
            "name": "et",
            "reference": "est"
        },
        "instance": {
            "reference": "libero",
            "startedAt": {
                "date": "2016-05-16 20:09:17.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "endedAt": {
                "date": "1993-08-21 00:58:54.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "publication": {
                "business_model_diagram_id": "b69bdd70-b85e-11ed-aa77-a9cca6ea746c",
                "engine_deployment_reference": "39ff3520-2a64-3dc9-9732-af9a6c65d163",
                "engine_diagram_reference": "5f13954c-c6e7-3c4b-a7ba-8556a7e84d70",
                "engine_model_reference": "Process_ReiciendisAutHic."
            },
            "context": "aliquam",
            "attributes": []
        },
        "attributes": []
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/service-tasks/{topic}/serve-multiple

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

topic string

The topic of a service task. Example: SOME_SERVICE_TASK

Body Parameters

lock string optional

This field is required when external_execution_reference is null. Example: sequi

external_execution_reference string optional

Example: sed

submission string[]

Unlock Service Task

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/service-tasks/3688e6c0-1a56-11ec-8366/unlock',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'lock' => 'officia',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/service-tasks/3688e6c0-1a56-11ec-8366/unlock"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lock": "officia"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/service-tasks/3688e6c0-1a56-11ec-8366/unlock" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lock\": \"officia\"
}"

Example response (200):


{
    "data": {
        "reference": "quis",
        "topic": "consequatur",
        "suspended": true,
        "priority": 15,
        "environment": {
            "organization_id": "b69e3810-b85e-11ed-92fb-3d26655c4faa",
            "engine_id": "b69f1a70-b85e-11ed-aa26-176a5d115235",
            "engine_reference": "90e57420-295d-3e62-9e16-1903828b3868",
            "production": true,
            "name": "nemo",
            "auth_token": "eb9a8cb3-e30a-34ad-a4c3-c9b013dd20f9"
        },
        "activity": {
            "name": "voluptatem",
            "reference": "laboriosam"
        },
        "instance": {
            "reference": "sit",
            "startedAt": {
                "date": "1997-02-05 17:19:31.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "endedAt": {
                "date": "1983-09-03 15:03:16.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "publication": {
                "business_model_diagram_id": "b6b5ca20-b85e-11ed-b2df-d5c8bab3a380",
                "engine_deployment_reference": "1575bb01-afb9-3cd3-a475-593b21f32429",
                "engine_diagram_reference": "9de61877-0cbb-33ed-800f-2e9b26f47db7",
                "engine_model_reference": "Process_NesciuntBlanditiis."
            },
            "context": "explicabo",
            "attributes": []
        },
        "attributes": []
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/service-tasks/{reference}/unlock

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

reference string

The reference of a service task. Example: 3688e6c0-1a56-11ec-8366

Body Parameters

lock string

Example: officia

User Tasks

List User Tasks

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://base.sf.local/api/v2/environment/user-tasks',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'activity' => 'dolorem',
            'created_at_from' => '2023-03-01T18:27:23',
            'created_at_till' => '2023-03-01T18:27:23',
            'active_only' => false,
            'sort_by' => 'unde',
            'sort_order' => 'desc',
            'page' => [
                'number' => 5,
                'size' => 1,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/user-tasks"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "activity": "dolorem",
    "created_at_from": "2023-03-01T18:27:23",
    "created_at_till": "2023-03-01T18:27:23",
    "active_only": false,
    "sort_by": "unde",
    "sort_order": "desc",
    "page": {
        "number": 5,
        "size": 1
    }
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request GET \
    --get "http://base.sf.local/api/v2/environment/user-tasks" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"activity\": \"dolorem\",
    \"created_at_from\": \"2023-03-01T18:27:23\",
    \"created_at_till\": \"2023-03-01T18:27:23\",
    \"active_only\": false,
    \"sort_by\": \"unde\",
    \"sort_order\": \"desc\",
    \"page\": {
        \"number\": 5,
        \"size\": 1
    }
}"

Example response (200):


{
    "data": [
        {
            "processInstanceReference": "sit",
            "businessProcessModelPublication": {
                "business_model_diagram_id": "b5b37df0-b85e-11ed-a789-3bc826c306cd",
                "engine_deployment_reference": "7f5fde29-5bc8-3904-a9b7-af23aa4e5d35",
                "engine_diagram_reference": "00a04ddd-4448-3f2a-a836-23c3f294c719",
                "engine_model_reference": "Process_AutEtNihilAutem."
            },
            "reference": "ducimus",
            "definition": "sint",
            "subject": "dolor",
            "description": "et",
            "priority": 8789,
            "createdAt": {
                "date": "2002-11-16 16:01:26.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "followUpAt": {
                "date": "1977-11-08 03:27:55.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "dueAt": {
                "date": "2009-02-07 15:04:14.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "attributes": [],
            "fields": [],
            "eligibleUsers": [],
            "eligibleOrganizationUnits": []
        },
        {
            "processInstanceReference": "dignissimos",
            "businessProcessModelPublication": {
                "business_model_diagram_id": "b5cae740-b85e-11ed-94c2-9b72c6a41143",
                "engine_deployment_reference": "6304532a-ac40-3520-8778-a28fdb7da348",
                "engine_diagram_reference": "fb2a13c4-ac32-300a-8cde-fa8686d63e2d",
                "engine_model_reference": "Process_EosIpsamExpedita."
            },
            "reference": "minus",
            "definition": "eligendi",
            "subject": "reprehenderit",
            "description": "tempore",
            "priority": 334,
            "createdAt": {
                "date": "2021-05-05 22:25:39.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "followUpAt": {
                "date": "2018-07-01 13:58:30.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "dueAt": {
                "date": "2016-11-28 16:31:33.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "attributes": [],
            "fields": [],
            "eligibleUsers": [],
            "eligibleOrganizationUnits": []
        }
    ]
}

Received response:

Request failed with error:

Request

GET api/v2/environment/user-tasks

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

activity string optional

Example: dolorem

created_at_from string optional

Must be a valid date. Example: 2023-03-01T18:27:23

created_at_till string optional

Must be a valid date. Example: 2023-03-01T18:27:23

active_only boolean optional true false

Example: false

sort_by string optional

Example: unde

sort_order string optional

Must be one of asc or desc. Example: desc

page object optional

number integer optional

Example: 5

size integer optional

Example: 1

View User Task

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://base.sf.local/api/v2/environment/user-tasks/ullam',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/user-tasks/ullam"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "http://base.sf.local/api/v2/environment/user-tasks/ullam" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


{
    "data": {
        "processInstanceReference": "aut",
        "businessProcessModelPublication": {
            "business_model_diagram_id": "b5e36720-b85e-11ed-9e87-efbace80e7d3",
            "engine_deployment_reference": "6a0b3782-3fad-3907-96d3-b51998348d73",
            "engine_diagram_reference": "298b5153-a8d2-3fd0-b1e6-9a1a3af35043",
            "engine_model_reference": "Process_DistinctioCulpa."
        },
        "reference": "fugit",
        "definition": "tenetur",
        "subject": "ipsam",
        "description": "est",
        "priority": 31298,
        "createdAt": {
            "date": "2013-05-18 08:44:46.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "followUpAt": {
            "date": "2022-08-26 03:11:47.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "dueAt": {
            "date": "2002-03-28 21:15:20.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "attributes": [],
        "fields": [],
        "eligibleUsers": [],
        "eligibleOrganizationUnits": []
    }
}

Received response:

Request failed with error:

Complete User Task

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/user-tasks/quaerat/complete',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'submission' => [
                [
                    'type' => 'date',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/user-tasks/quaerat/complete"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "submission": [
        {
            "type": "date"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/user-tasks/quaerat/complete" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"submission\": [
        {
            \"type\": \"date\"
        }
    ]
}"

Example response (200):


{
    "data": {
        "processInstanceReference": "beatae",
        "businessProcessModelPublication": {
            "business_model_diagram_id": "b5fcca80-b85e-11ed-89f0-d1f4134766c9",
            "engine_deployment_reference": "4201f9fa-4755-3ab0-8daf-5abd0d266948",
            "engine_diagram_reference": "d9ebefd4-5191-366e-8e47-ffda8b111521",
            "engine_model_reference": "Process_UtMollitia."
        },
        "reference": "illum",
        "definition": "minus",
        "subject": "rerum",
        "description": "voluptatem",
        "priority": 93933,
        "createdAt": {
            "date": "1977-03-17 21:43:12.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "followUpAt": {
            "date": "1999-03-01 19:48:43.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "dueAt": {
            "date": "1974-01-21 06:48:35.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "attributes": [],
        "fields": [],
        "eligibleUsers": [],
        "eligibleOrganizationUnits": []
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/user-tasks/{id}/complete

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user task. Example: quaerat

Body Parameters

submission object[] optional

type string

Must be one of collection, object, string, integer, float, double, boolean, date, or date_time. Example: date

value string optional

Escalate User Task

requires authentication

Reports an escalation in the context of a running task by id. The escalation code must be specified to identify the escalation handler.

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/user-tasks/quam/escalate',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'code' => 'sed',
            'submission' => [
                [
                    'type' => 'date',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/user-tasks/quam/escalate"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "sed",
    "submission": [
        {
            "type": "date"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/user-tasks/quam/escalate" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"sed\",
    \"submission\": [
        {
            \"type\": \"date\"
        }
    ]
}"

Example response (200):


{
    "data": {
        "processInstanceReference": "totam",
        "businessProcessModelPublication": {
            "business_model_diagram_id": "b6166760-b85e-11ed-a17c-2fbea32df58a",
            "engine_deployment_reference": "23a178b4-217f-317b-ad46-a06bf7f3b9af",
            "engine_diagram_reference": "1f74637a-3728-39a0-a680-9006c442915b",
            "engine_model_reference": "Process_MagniDolorOptio."
        },
        "reference": "impedit",
        "definition": "ut",
        "subject": "non",
        "description": "numquam",
        "priority": 78,
        "createdAt": {
            "date": "1988-02-27 12:42:09.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "followUpAt": {
            "date": "2013-02-11 04:44:56.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "dueAt": {
            "date": "1996-11-17 06:17:49.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "attributes": [],
        "fields": [],
        "eligibleUsers": [],
        "eligibleOrganizationUnits": []
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/user-tasks/{id}/escalate

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user task. Example: quam

Body Parameters

code string

Example: sed

submission object[] optional

type string

Must be one of collection, object, string, integer, float, double, boolean, date, or date_time. Example: date

value string optional

Errorize User Task

requires authentication

Reports a business error in the context of a running task by id. The error code must be specified to identify the BPMN error handler.

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://base.sf.local/api/v2/environment/user-tasks/autem/errorize',
    [
        'headers' => [
            'Authorization' => 'Bearer {ENVIRONMENT_AUTH_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'code' => 'nostrum',
            'message' => 'quia',
            'submission' => [
                [
                    'type' => 'collection',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://base.sf.local/api/v2/environment/user-tasks/autem/errorize"
);

const headers = {
    "Authorization": "Bearer {ENVIRONMENT_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "nostrum",
    "message": "quia",
    "submission": [
        {
            "type": "collection"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://base.sf.local/api/v2/environment/user-tasks/autem/errorize" \
    --header "Authorization: Bearer {ENVIRONMENT_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"nostrum\",
    \"message\": \"quia\",
    \"submission\": [
        {
            \"type\": \"collection\"
        }
    ]
}"

Example response (200):


{
    "data": {
        "processInstanceReference": "est",
        "businessProcessModelPublication": {
            "business_model_diagram_id": "b62ee7e0-b85e-11ed-b6f3-4b917097bfb8",
            "engine_deployment_reference": "588769a4-aeae-33f5-9198-dde3bc059f90",
            "engine_diagram_reference": "03333a98-2c07-33a6-a8a4-51673e7b5b40",
            "engine_model_reference": "Process_EstQuiaCulpa."
        },
        "reference": "accusamus",
        "definition": "ut",
        "subject": "aliquid",
        "description": "delectus",
        "priority": 21701,
        "createdAt": {
            "date": "2022-01-01 14:01:52.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "followUpAt": {
            "date": "1981-02-26 12:18:37.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "dueAt": {
            "date": "1980-02-09 23:15:31.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "attributes": [],
        "fields": [],
        "eligibleUsers": [],
        "eligibleOrganizationUnits": []
    }
}

Received response:

Request failed with error:

Request

POST api/v2/environment/user-tasks/{id}/errorize

Headers

Authorization

Example: Bearer {ENVIRONMENT_AUTH_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the user task. Example: autem

Body Parameters

code string

Example: nostrum

message string optional

Example: quia

submission object[] optional

type string

Must be one of collection, object, string, integer, float, double, boolean, date, or date_time. Example: collection

value string optional