Verwendung

Die CLARC FILEPLAN API ermöglicht es Aktenplanstrukturen vom CLARC FILEPLAN Server abzurufen.

Übersicht

Die Übergabe der Daten erfolgt über den FILEPLAN Web-Service via HTTP-GET als XML (Beispiel siehe unten).

Funktionen

Es stehen folgende Funktionen im Web-Service zur Verfügung:

/CCGETCLIENTS

Abruf aller im System definierten Aktenplan-Mandanten.

/CCGETNODELIST

Abruf aller Knotenelemente eines bestimmten Aktenplan-Pfades.

Übergabeparameter: path

Beispiel:

http(s)://<Server>:<Port>/ccgetnodelist?path=/MyClientExample

Beispiel-Metadaten-XML:

<?xml version="1.0" encoding="UTF-8"?>
<ccNodes RootNode="/MyClientExample">
  <Node ChildNodes="True" Reference="1.">Organe</Node>
  <Node ChildNodes="True" Reference="2.">Öffentlichkeitsarbeit</Node>
  <Node ChildNodes="True" Reference="3.">Organisation</Node>
  <Node ChildNodes="True" Reference="4.">Einkauf</Node>
  <Node ChildNodes="True" Reference="5.">Finanzen</Node>
  <Node ChildNodes="True" Reference="6.">Vertrieb</Node>
  <Node ChildNodes="False" Reference="7.">Bestandsdokumentation</Node>
</ccNodes>

Aus dem XML können alle Knotennamen, die jeweilige Referenz und das Vorhandensein von Unterknoten ermittelt werden.

/CCGETREFERENCE

Über ccgetrefrence wird die Referenznummer eines Pfades abgerufen. Die Referenznummer ist eine Aktenplannummer wie beispielsweise "1.1.2.3".

Die Referenznummer kann automatisch aufgebaut oder manuell vom Aktenplan-Administrator vergeben werden.