Signals

Mogelijk sinds versie 4.2

Om een taak af te kunnen melden met de call tasks, PUT moet er een “X-signal” worden meegegeven. De mogelijke signalen van het huidige proces die doorgegeven kunnen worden, kunnen met deze call per taak worden opgevraagd.

Mogelijke HTTP methodes: GET

 

GET

Via de GET method kan een overzicht van beschikbare signalen worden opgevraagd op basis van een taskId. Als er geen parameters worden meegegeven worden alle mogelijke signalen van alle actieve taken teruggegeven

Parameter name

Value

Verplicht

X-action

signals

JA

X-apiKey

71C41004-6E3E-11E4-8C1A-F7BB2492C704

JA

X-taskId

ID van de taak waarvoor de signalen opgehaald kunnen worden.

NEE

 

Response

[
  {
    "signalKey": "SAMENSTELLEN_09-AANMAKEN_LIJST",
    "taskKey": "aanmaken_lijst",
    "choiceName": "",
    "choiceKey": "",
    "processKey": "SAMENSTELLEN_09",
    "choiceDescription": "",
"choiceText:"" }, { "signalKey": "SAMENSTELLEN_09-AANPASSEN_CONCEPT_JRK", "taskKey": "aanpassen_concept_jrk", "choiceName": "", "choiceKey": "", "processKey": "SAMENSTELLEN_09", "choiceDescription": "",
"choiceText": "Aanpassen concept jaarrekening" }, { "signalKey": "SAMENSTELLEN_09-AANPASSEN_PUBLICATIE_SBR", "taskKey": "aanpassen_publicatie_SBR", "choiceName": "", "choiceKey": "", "processKey": "SAMENSTELLEN_09", "choiceDescription": "",
"choiceText":"" }, ...

Property name

Value

Type

signalKey

Dit is de key dat gebruikt wordt om een taak af te ronden. Zie X-signal in de tasks documentatie

String

taskKey

De taskkey van de taak binnen het proces.

String

choiceName

Op basis van dit gegeven kunnen meerdere signalen met elkaar gekoppeld worden. Dit is van toepassing op zodra de huidige stap in het proces een splitising kent en er een keuze gemaakt moet worden   

String
choiceDescription Op basis van 'choiceName' is dit een keuze mogelijkheid die aan de eindgebruiker kan worden gesteld. Bijvoorbeeld 'stoppen' en 'doorgaan'. String
processKey   De key van het proces waar dit signaal bij hoort.  String
choiceKey Elke choiceDescription bevat een unieke code (of key). String
choiceText Een duidelijke omschrijving van de taak. Momenteel wordt dit gebruikt om op basis van dit signaal een filter of dashboard applicatie te vullen. String
Hebt u meer vragen? Een aanvraag indienen

0 Opmerkingen

U moet u aanmelden om een opmerking te plaatsen.
Mogelijk gemaakt door Zendesk