Modul na volání TASu - TAS 2 TAS (zakládání procesů přes API)

Endpoint Start Process API umožňuje jedním voláním vytvořit nový případ z existující šablony, naplnit proměnné vstupními daty a okamžitě spustit workflow. Operace je atomická — případ buď vznikne kompletně, nebo vůbec.

Dostupné v pluginu apiExtensions od verze 5.7.75 a 5.17

Endpoint

Method: POST

URL: /api/plugins/api-extensions/start-process

Autentizace

Každé volání musí obsahovat Bearer token v HTTP hlavičce:

Authorization: Bearer <accessToken>
Content-Type: application/json

Tělo požadavku

{
  "processId": 27, //ID hlavičky (headerId) spouštěného procesu
  "data": {
    "processVariable1": "value1",
    "processVariable2": "value2"
  }
}

Pole

Typ

Popis

processId

number

ID hlavičky (šablony) procesu, ze které se případ zakládá

data

object

Klíč–hodnota párů odpovídající proměnným šablony

Podporované typy hodnot v data

Typ

Příklad

String

"value1"

Number

100

Datum (YYYY-MM-DD)

"2025-01-01"

Pole musí existovat na dané šabloně. U výčtových hodnot (LOV) je nutné použít jednu z existujících hodnot, kterou proměnná LOV na šabloně obsahuje — jinak dojde k chybě a případ se nevytvoří.

Příklad volání

try {
    const accessToken = 'xxxxxx';
    const configStartNewProces = {
        method: "post",
        url: `/api/plugins/api-extensions/start-process`,
        headers: {
            "Authorization": `Bearer ${accessToken}`,
            "Content-Type": "application/json"
        },
        data: JSON.stringify({
            processId: 27, //ID hlavičky (headerId) spouštěného procesu
            data: {
                "processVariable1": "value1",
                "processVariable2": "value2"
            }
        })
    };
    const requestStartNewProces = axios.getAxios().requestRaw(configStartNewProces);
    proc.warn(`requestStartNewProces Result`, { requestStartNewProces });
} catch (error) {
    proc.warn(`requestStartNewProces error`, { error });
}

Kód nesmí obsahovat async/await — transpiler je doplní automaticky. Ruční použití způsobí chybu při spuštění.

Doporučení pro administrátora

  • Do objektu data doporučujeme přidat proměnnou _isCaseCreatedByAPI s hodnotou "true". Šablona tak okamžitě rozpozná, že případ vznikl přes API, a může na to reagovat v podmínkách nebo routingu.
  • Všechny hodnoty z data jsou dostupné již v úkolu Start — workflow s nimi může pracovat okamžitě (podmínky, routing, rozhodování) bez nutnosti čekat na další krok.

Příklad: "_isCaseCreatedByAPI": "true" — přidej tuto proměnnou do šablony jako textové pole a workflow ji může číst hned od startu.

Chování při chybě

Pokud dojde k jakékoliv chybě (nevalidní vstup, neexistující processId, problém při startu workflow):

  • případ se nevytvoří,
  • žádná data se neuloží,
  • v systému nezůstanou neúplné ani „rozbité" procesy.

Frantisek Brych Updated by Frantisek Brych

DocuSign

DB View

Contact

Team assistant (opens in a new tab)

Powered by HelpDocs (opens in a new tab)