Koppelprofiel Zaaksysteem API - Bewerkingsoverzicht

Admin: /* Instellingen */

2019-06-05T09:13:50Z

‎Instellingen

Admin: /* Instellingen */

2017-05-01T07:42:01Z

‎Instellingen

Admin: /* Meer zoekresultaten ontvangen */

2016-11-18T13:50:24Z

‎Meer zoekresultaten ontvangen

Admin: /* Instructie voor UNIX / Mac omgeving */

2016-11-18T13:49:48Z

‎Instructie voor UNIX / Mac omgeving

Admin: Typofix

2016-11-07T13:32:25Z

Typofix

Admin: /* Instructie voor Windows omgeving */

2016-11-02T12:42:35Z

‎Instructie voor Windows omgeving

Admin: /* Instructie voor Windows omgeving */

2016-11-02T12:41:02Z

‎Instructie voor Windows omgeving

Admin: /* Instructie voor Windows omgeving */

2016-10-27T08:05:22Z

‎Instructie voor Windows omgeving

Admin: /* Troubleshooting */

2016-10-05T14:11:47Z

‎Troubleshooting

Admin: /* Instellingen */

2016-10-05T11:54:46Z

‎Instellingen

@@ Regel 65: / Regel 65: @@
 |Trigger CA Certificaat
 |Eventueel het certificaat voor de trigger URL
 |-
 |API URI

@@ Regel 54: / Regel 54: @@
 Deze informatieset wordt uitgebreid met alle informatie die zichtbaar is binnen de geselecteerde zoekopdracht (dus op basis van de geselecteerde filters en kolommen).
 |-
 |Trigger URL
@@ Regel 72: / Regel 75: @@
 |Met dit unix commando (curl) kan de output van de ingestelde zoekopdracht geëxporteerd worden als CSV.
 |}
 = API v1 =
 Zaaksysteem biedt de mogelijkheid om een opgeslagen zoekopdracht te selecteren die vervolgens op te vragen is door <omgeving>/api/v1/case te bezoeken.

@@ Regel 124: / Regel 124: @@
 <pre>curl --header "API-Interface-Id: 71" --header "API-Key: 1234" "https://quarterly.zaaksysteem.nl/app/api2csv?rows_per_page=50&page=1"
 of:
-powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient); $cmd.Headers.Add(\"API-Interface-Id\",\"71\"); $cmd.Headers.Add(\"API-Key\",\"1234\"); $cmd.DownloadString(\"https://quarterly.zaaksysteem.nl/app/api2csv?rows_per_page=50&page=1\");</pre>
+powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient); $cmd.Headers.Add(\"API-Interface-Id\",\"71\");
 === Troubleshooting ===
 Wanneer er geen resultaten zijn moet eerst gecontroleerd worden of de gebruiker die ingesteld staat bij 'Medewerker' in het Zaaksysteem API koppelprofiel überhaupt resultaten krijgt in Uitgebreid Zoeken. Daarna kan gecontroleerd worden of de medewerker wel raadpleegrechten heeft tot de zaaktype(n).

@@ Regel 108: / Regel 108: @@
 curl --header "API-Interface-Id: 71" --header "API-Key: 1234" "https://quarterly.zaaksysteem.nl/app/api2csv" > file.txt
 </pre>
 === Troubleshooting ===
 Wanneer er geen resultaten zijn moet eerst gecontroleerd worden of de gebruiker die ingesteld staat bij 'Medewerker' in het Zaaksysteem API koppelprofiel überhaupt resultaten krijgt in Uitgebreid Zoeken. Daarna kan gecontroleerd worden of de medewerker wel raadpleegrechten heeft tot de zaaktype(n).

@@ Regel 69: / Regel 69: @@
 |Met dit windows commando (powershell) kan de output van de ingestelde zoekopdracht geëxporteerd worden als CSV.
 |-
-|Examlple: CSV via Curl
+|Example: CSV via Curl
 |Met dit unix commando (curl) kan de output van de ingestelde zoekopdracht geëxporteerd worden als CSV.
 |}

@@ Regel 85: / Regel 85: @@
 Voer het volgende Powershell commando uit in een terminal (anders dan de Powershell terminal):
 <pre>
-powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient); $cmd.Headers.Add(\"API-Interface-Id\",\"71\"); $cmd.Headers.Add(\"API-Key\",\"1234\"); $cmd.DownloadString(\"https://quarterly.zaaksysteem.nl/app/api2csv\");
+powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient);
 </pre>
 Het resultaat is de output van de opgeslagen zoekopdracht in CSV formaat. Deze kan gekopiëerd worden voor gebruik in een andere applicatie. De response kan ook direct opgeslagen worden door aan het Powershell commando '  | Out-File –FilePath c:\folder\structuur\bestandsnaam.csv toe te voegen.
 <pre>
-powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient); $cmd.Headers.Add(\"API-Interface-Id\",\"71\"); $cmd.Headers.Add(\"API-Key\",\"1234\"); $cmd.DownloadString(\"https://quarterly.zaaksysteem.nl/app/api2csv\"); | Out-File –FilePath c:\path\bestandsnaam.csv
+powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient);
 </pre>

@@ Regel 83: / Regel 83: @@
 === Instructie voor Windows omgeving ===
-Voer het volgende Powershell commando uit in een terminal:
+Voer het volgende Powershell commando uit in een terminal (anders dan de Powershell terminal):
 <pre>
 powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient); $cmd.Headers.Add(\"API-Interface-Id\",\"71\"); $cmd.Headers.Add(\"API-Key\",\"1234\"); $cmd.DownloadString(\"https://quarterly.zaaksysteem.nl/app/api2csv\");

← Oudere versie		Versie van 5 okt 2016 om 14:11
Regel 101:		Regel 101:

	=== Troubleshooting ===		=== Troubleshooting ===
−	Wanneer er geen resultaten zijn moet eerst gecontroleerd worden of de gebruiker die ingesteld staat bij 'Medewerker' in het Zaaksysteem API koppelprofiel überhaupt resultaten krijgt in Uitgebreid Zoeken. Daarna kan gecontroleerd worden of de medewerker wel ~~beheerrechten~~ heeft tot de zaaktype(n).	+	Wanneer er geen resultaten zijn moet eerst gecontroleerd worden of de gebruiker die ingesteld staat bij 'Medewerker' in het Zaaksysteem API koppelprofiel überhaupt resultaten krijgt in Uitgebreid Zoeken. Daarna kan gecontroleerd worden of de medewerker wel raadpleegrechten heeft tot de zaaktype(n).

← Oudere versie		Versie van 5 okt 2016 om 11:54
Regel 72:		Regel 72:
	\|Met dit unix commando (curl) kan de output van de ingestelde zoekopdracht geëxporteerd worden als CSV.		\|Met dit unix commando (curl) kan de output van de ingestelde zoekopdracht geëxporteerd worden als CSV.
	\|}		\|}
		+	= API v1 =
		+	Zaaksysteem biedt de mogelijkheid om een opgeslagen zoekopdracht te selecteren die vervolgens op te vragen is door <omgeving>/api/v1/case te bezoeken.
		+	De uitvoer van <omgeving>/api/v1/case is in JSON formaat.
		+
		+	= API2CSV =
		+	Om de integratie met andere systemen makkelijker te maken biedt Zaaksysteem ook de mogelijkheid om de API v1 uitvoer in een comma separated value (CSV) formaat uit te voeren.
		+	Op deze pagina staat beschreven hoe beheerders deze functionaliteit op hun omgeving kunnen installeren, en hoe gebruikers de uitvoer in CSV kunnen opvragen.
		+
		+	Let op: Integratie met andere applicaties is mogelijk. Deze applicaties moeten een http get commando uit kunnen voeren waarbij enkele headers meegegeven dienen te worden (zie het Curl commando voor meer info voor welke headers).
		+
		+	=== Instructie voor Windows omgeving ===
		+	Voer het volgende Powershell commando uit in een terminal:
		+	<pre>
		+	powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient); $cmd.Headers.Add(\"API-Interface-Id\",\"71\"); $cmd.Headers.Add(\"API-Key\",\"1234\"); $cmd.DownloadString(\"https://quarterly.zaaksysteem.nl/app/api2csv\");
		+	</pre>
		+
		+	=== Instructie voor UNIX / Mac omgeving ===
		+	Voer het volgende Powershell commando uit in een terminal:
		+	<pre>
		+	curl --header "API-Interface-Id: 71" --header "API-Key: 1234" "https://quarterly.zaaksysteem.nl/app/api2csv"
		+	</pre>
		+
		+	Het resultaat is de output van de opgeslagen zoekopdracht in CSV formaat. Deze kan gekopiëerd worden voor gebruik in een andere applicatie. De response kan ook direct opgeslagen worden door aan het Curl commando ' bestandsnaam.txt' toe te voegen.
		+
		+	<pre>
		+	curl --header "API-Interface-Id: 71" --header "API-Key: 1234" "https://quarterly.zaaksysteem.nl/app/api2csv" > file.txt
		+	</pre>
		+
		+	=== Troubleshooting ===
		+	Wanneer er geen resultaten zijn moet eerst gecontroleerd worden of de gebruiker die ingesteld staat bij 'Medewerker' in het Zaaksysteem API koppelprofiel überhaupt resultaten krijgt in Uitgebreid Zoeken. Daarna kan gecontroleerd worden of de medewerker wel beheerrechten heeft tot de zaaktype(n).