Process-instances

Hiermee kunnen de procesinstanties van een cliënt beheerd worden.

Mogelijke HTTP methodes: GET, POST, PUT, DELETE

GET

Via de GET method kunnen alle lopende processen voor een kantoor, procesdefinitie, periode en/of cliënt gevonden worden. Ook is het mogelijk om op basis van een taak ID de bijhorende procesinstantie te vinden.

Parameter name

Value

Verplicht

X-action

process-instances

JA

X-apiKey

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

JA

X-taskId

Task instance ID zoals verkregen via de tasks action

NEE

X-clientId

ID van de client zoals verkregen via de clients action

NEE

X-periodStart

Datum periode start in het formaat yyyy-MM-dd

NEE

X-periodEnd

Datum periode end in het formaat yyyy-MM-dd

NEE

X-processKey

Proces Definition key

NEE

X-period

Periode van dit proces. Periodecode uit de Alley-Oop periode tabel.

NEE

X-year

Jaar van het process.

NEE

Response

[
  {
    "instanceId": "365005",
    "processKey": "SAMENSTELLEN_09",
    "processName": "Samenstellen 0.9",
"processDescription": "Samenstellen jaarrekening", "processVersion": 1, "periodStart": "2014-12-10", "periodEnd": "2015-01-01",
"period": "21",
"periodDescription": "1st quarter",
"year": "2015", "clientId": "60ab1cd6-e11f-4304-8434-c1bdd5cdcae3",
"isAdHoc": false,
"customProcessDescription": "Dit is een eigen omschrijving",
"documentLink": "https://ac.changetocomm.net/ac/redirect&target=file&clientkey=60CF6DB60A1F7EE7C1256D1E00305ED8&key=155622AA0973E01EC1257FCD00279D39&modulename=DOSSIER",
"documentDescription": "Jaarrekening 2015" "phaseInfo": [ { "phaseNumber": "9", "name": "Fase 9", "description": "Exit fase, einde workflow" }, { "phaseNumber": "8", "name": "Fase 8", "description": "Jaarrekening definitief" }, ..... } ]

Property name

Value

Type

Instance ID

Het ID van de proces instantie. Kan gebruikt worden om de instantie te verwijderen

String

Definition Key

Key van de procesdefinitie

String

Definition Name

Naam van de definitie

String

Definition

Versie nummet van de definitie

Integer 

Periode Start

Opgegeven start periode datum

String

Periode End

Opgegeven end periode datum

String

Client ID

Opgegeven cliënt ID

String

Period

Code van gegeven periode

String

Period description

Omschrijving van gegeven periode  String
Year Jaar van het proces

String

 

isAdHoc Geeft aan of de definitie van het proces een adhoc proces is.

boolean

customProcessDescription Op elk proces kan aanvullend nog een eigen beschrijving worden toegevoegd.

String

documentLink Vastgelegde link naar een document. Deze link bevat een volledige direct url naar een bijbehorend document.

String

documentDescription Een omschrijving van de link 'documentLink'

String

POST 

Via de POST method kan een nieuwe procesinstantie worden aangemaakt voor een client en een bepaalde periode op basis van een procesdefinitie. Dit kan alleen als het cliënt ID bekend is en als deze niet inactief is.

Er kan maximaal 1 proces per start/eind datum aangemaakt worden voor niet-adhoc proces definities.

Parameter name

Value

Verplicht

X-action

process-instances

JA

X-apiKey

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

JA

X-processKey

De key van het de starten procesdefinitie, kan verkregen worden via de process-definitions action

JA

X-clientId

ID van de client zoals verkregen via de clients action

JA

X-periodStart

Datum periode start in het formaat yyyy-MM-dd

JA

X-periodEnd

Datum periode end in het formaat yyyy-MM-dd

JA

X-customDescription

Een eigen omschrijving behorend bij proces. Deze omschrijving komt in de GET call ook weer terug.

NEE

X-documentLink

Volledige url inclusief domein naar een document.

NEE

X-documentDescription

Een korte omschrijving van het document indien er een url is meegeven

*Is verplicht indien er een documentlink is meegestuurd.

 

NEE* 

PUT 

Om de gegevens van een proces instantie te updaten, wordt er gebruik gemaakt van de PUT method. De JSON met gegevens van de process instance moet in de body worden meegegeven. instanceId is in dit geval verplicht.

Op dit moment is het alleen mogelijk om de periode, aangepaste omschrijving en jaar aan te passen via deze methode.

Als response wordt de process instance terug gegeven.

 

DELETE 

Via de DELETE method kan men een procesinstantie verwijderen. Het verwijderde proces zal wel terug te vinden zijn in de geschiedenis.

Parameter name

Value

Verplicht

X-action

process-instances

JA

X-apiKey

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

JA

X-instanceId

instance ID zoals verkregen via de GET method

JA

X-reason

Reden van het verwijderen, indien er geen reden wordt opgegeven ziet met ACTIVITI_DELETED in de history terug.

NEE

Response

Instance informatie in JSON formaat (zie GET)

Hebt u meer vragen? Een aanvraag indienen

0 Opmerkingen

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