Tasks

Hiermee kunnen taken worden beheerd. Taken kunnen worden opgevraagd en worden afgevinkt. 

Mogelijke HTTP methodes: GET,  PUT

GET*

Via de GET method kunnen de actieve taken worden opgevraagd. Zonder filtering worden alle actieve taken worden geretourneerd. Taken kunnen worden gefilterd op client, periode, groep en procesdefinitie. 

*Deze call maakt gebruik van paging. Het maximaal aantal resultaten is daarmee gelimiteerd.

Parameter name

Value

Verplicht

X-action

tasks

JA

X-apiKey

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

JA

X-signal

Het signaal voor de taak. Dit is een string waar mee een taak en indien van toepassing een uitkomst van een taak te herleiden valt. (zie appendix proces informatie)

NEE

X-clientId

ID van de client zoals verkregen via de clients action

NEE

X-periodStart

Datum periode start van het proces in het formaat yyyy-MM-dd. Taken in het proces vanaf deze datum worden teruggegeven.

NEE

X-periodEnd

Datum periode end van het proces in het formaat yyyy-MM-dd. Taken in het proces tot en met deze datum worden teruggegeven.

NEE

X-group

Taak groep (zie appendix I)

NEE

X-processKey

Key van de procesdefinitie

NEE

X-taskKey

Technische task key

NEE

X-claimedBy

De naam die eerder is gebruikt in call "CLAIM-TASK".

NEE

X-claimedByReferId

De id (personeelsnummer) die eerder is gebruikt in call "CLAIM-TASK".

NEE
X-claimedByEmail

Het emailadres dat eerder is gebruikt in call "CLAIM-TASK".

NEE

 

Response

[
    {
    "taskId": "675013",
    "processInstanceId": "645055",
    "clientId": "2a42c6cb-9dce-4997-a345-897647349095",
    "periodStart": "2015-04-09",
    "periodEnd": "2016-10-12",
    "group": "Samensteller",
    "key": "informatie_in_dossier",
    "name": "Informatie in dossier",
    "owner": "Ferry Kranenburg/ChangeToComm",
    "ownerReferId": "8888",
    "ownerEmail": "[email protected]",
    "startDate": "2015-11-11",
"dueDate": "2015-12-11", "standardDuration": "200", "phase": "7", "duration": "0", "comments": [ { "date": "2015-11-11 19:58:53", "message": "claim door Ferry" }, { "date": "2015-11-11 19:58:43", "message": "null" }, { "date": "2015-11-11 19:58:43", "message": "null" }, { "date": "2015-11-11 19:55:00", "message": "Opnieuw door Ferry geclaimed" }, { "date": "2015-11-11 19:54:47", "message": "null" }, { "date": "2015-11-11 19:54:46", "message": "null" } ], "signals": [ { "signalKey": "SAMENSTELLEN_09-INFORMATIE_IN_DOSSIER", "taskKey": "informatie_in_dossier", "choiceName": "", "choiceKey": "", "processKey": "SAMENSTELLEN_09", "choiceDescription": "" } ], "instance": { "instanceId": "645055", "processKey": "SAMENSTELLEN_09", "processName": "Samenstellen 0.9", "processDescription": "Samenstellen jaarrekening", "processVersion": 1, "periodStart": "2015-04-09", "periodEnd": "2016-10-12", "clientId": "2a42c6cb-9dce-4997-a345-897647349095", "phaseInfo": [ { "phaseNumber": "9", "name": "Fase 9", "description": "Exit fase, einde workflow" }, { "phaseNumber": "8", "name": "Fase 8", "description": "Jaarrek. (def.) samenstelverklaring en pub. jaarrek." }, { "phaseNumber": "7", "name": "Fase 7", "description": "Jaarrek. (def.) concept en opvragen LOR" }, { "phaseNumber": "6", "name": "Fase 6", "description": "Bespreking cliënt" }, { "phaseNumber": "5", "name": "Fase 5", "description": "Jaarrek. in concept" }, { "phaseNumber": "4", "name": "Fase 4", "description": "Uitvoering" }, { "phaseNumber": "3", "name": "Fase 3", "description": "Planning" }, { "phaseNumber": "2", "name": "Fase 2", "description": "Verzamelen info" }, { "phaseNumber": "1", "name": "Fase 1", "description": "Voorbereiding" } ] }, "client": { "clientId": "2a42c6cb-9dce-4997-a345-897647349095", "name": "Big Data BV", "referId": "4100200", "rsin": "", "bsn": "", "vat": "", "wage": "", "kvk": "", "inactive": false } ]

Property name

Value

Type

Instance ID

Het ID van de taakinstantie. Kan gebruikt worden om een proces instantie te vinden of om een taak af te vinken

String

Proces Instance ID

Het ID van de procesinstantie

String

Client ID

Opgegeven cliënt ID

String

Periode Start

Opgegeven start periode datum

String

Periode End

Opgegeven end periode datum

String

Duration

Lengte in dagen van looptijd taak.

String

Instance

Alle informatie over de bijbehorende proces instantie.

Object: zie process-instance

Signals

Lijst van mogelijke signalen om een stap verder in het proces te doorlopen.

Array: zie signals

Group

Groep waar tot de taak behoord

String

Key

Key van de taak

String

Name

Naam van de taak

String

Owner

Naam van de toegewezen medewerker, dit is een losse string welke geen relatie heeft tot gebruikers beheer.

String

OwnerReferId

Nummer of personeelsnummer van persoon of groep toegewezen.

String

OwnerEmail E-mailadres van persoon of groep toegewezen. String

Comments/Date

Datum/Tijd waar op de comment toegevoegd is

String

Comments/Message

De Comment text

String

 

PUT 

Via de PUT method kunnen taken worden afgevinkt. Een taak wordt afgevinkt door een 'signal' te versturen in combinatie met of:

  • Een taskID: dit is het unieke ID van een taak binnen een procesinstantie. Dit ID komt dus over het hele systeem maar 1 keer voor.
  • Een periode start/eind + een cliënt ID + proces Key. Deze combinatie leidt immers tot een unieke procesinstantie, waar op dat moment een taak actief is.

Het is afhankelijk van de use case welke methode te prefereren is.

Parameter name

Value

Verplicht

X-action

tasks

JA

X-apiKey

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

JA

X-signal

Het signaal voor de taak. Dit is een string waar mee een taak en indien van toepassing een uitkomst van een taak te herleiden valt. (zie appendix proces informatie)

Om de mogelijke signalen op te vragen is de call Signals beschikbaar.

JA

X-clientId

ID van de client zoals verkregen via de clients action

NEE

X-periodStart

Datum periode start van het proces in het formaat yyyy-MM-dd

NEE

X-periodEnd

Datum periode end van het proces in het formaat yyyy-MM-dd

NEE

X-taskId

Id van de taak zo als verkregen via GET tasks

NEE

X-processKey

Key van de procesdefinitie

 

 

Response

{}

Hebt u meer vragen? Een aanvraag indienen

0 Opmerkingen

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