Verwendung

Der CLARC QHIX Daemon stellt Services für Client-orientierte Dokumenten- und Indexierungs-Prozesse bereit.

Über die hier vorgestellte Web-Service Schnittstelle kann auf die verwalteten Inhalte des QHIX-Servers zugegriffen werden. Die hier vorgestellten Methoden und Attribute stellen jedoch nur einen Teil der verfügbaren Funktionalität dar. Alle weiteren Funktionen sind non-public.

Die API

Genereller Aufbau einer Url:

http(s)://<server>:<port>/<function>?<parameter>

Die Parameter einer Url sollten verschlüsselt übertragen werden. Im Umfeld von CLARC ENTEPRIRSE gibt es dazu verschiedende Verschlüsselungsmethoden.

Das Ergebnis einer Anfrage wird, sofern nicht anders angegeben, im CLARC Fast XML Format zurückgeliefert.

Ein erfolgreicher Aufruf einer Web-Service Methode wird stets mit einem HTTP 200 oder HTTP 201 bestätigt. 

(GET) CCCREATESESSION

Diese Methode generiert eine neue QHIX Session oder verbindet sich zu einer bestehenden.

(GET) CCCLOSESESSION

Diese Methode beendet eine QHIX Session.

(GET) CCGETOEMINFOS

Diese Methode liefert die entsprechenden OEM Informationen. Weitere Informationen zur OEMisierung finden Sie in der entsprechenden Dokumentation.

(GET) CCGETBASICS

Diese Methode liefert die Basis-Server-Informationen.

(GET) CCGETUSERINFO

Diese Methode liefert alle Informationen zum angegebenen Benutzer.

(GET) CCGETPERMOBJECTS

Diese Methode liefert alle verfügbaren Berechtigungsobjekte zum angegebenen Benutzer.

(GET) CCGETSAPWORKQUEUEID

Diese Methode liefert die für den angegebenen Benutzer passende und verfügbare SAP Applikations-Id.

(GET) CCREGISTERSESSION

Diese Methode registriert eine Anwendungssitzung für das angegebene Objekt.

(GET) CCRELEASESESSION

Diese Methode gibt eine registrierte Anwendungssitzung für das angegebene Objekt frei.

(GET) CCSESSIONHEARTBEAT

Diese Methode zeigt die Aktivität des Clients an. Der Heartbeat darf einen maximalen zeitlichen Abstand von 10 Minuten haben.

(GET) CCGETBLOBLIST

Diese Methode ruft eine Liste von Blobs aus dem angegebenen Bereich ab. 

<?xml version="1.0" encoding="UTF-8" ?>
<ccBlobs>
  <Blob Id="..." TackId="..." SortId="0" Extension=".pdf" DocType="" MimeType="application/pdf" Size="827823" Date="000B3B9Dh0336106Eh">Example</Blob>
  <Blob Id="..." TackId="..." SortId="1" Extension=".pdf" DocType="" MimeType="application/pdf" Size="835421" Date="000B3B9Dh0336106Eh">MoreExample</Blob>
  ...  
</ccBlobs>

(GET) CCGETBLOB

Diese Methode ruft ein angegebenes Blob vom Server ab. Das Ergebnis ist der entsprechende Bytestream mit dem MimeType des angeforderten Dokuments.

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

• BlobId
• BlobHash

(GET) CCDELETEBLOB

Diese Methode löscht das angegebene Blob vom Server.

(GET) CCCHANGEBLOB

Diese Methode ändert das angegebene Blob am Server.

(GET) CCGETTACKLIST

Diese Methode ruft eine Liste von Blobs aus dem angegebenen Bereich ab. 

<?xml version="1.0" encoding="UTF-8" ?>
<ccDocuments>
  <Document Id="..." Date="000B3B9Dh0336106Eh" Blobs="3">
    <Subject>Betreff des Dokuments</Subject>
    <Messages>Hinweise zum Dokument</Messages>
  </Document>
  ...  
</ccDocuments>

(GET) CCGETTACK

Diese Methode ruft ein angegebenes Dokument vom Server ab. Das Ergebnis ist der entsprechende XML Bytestream des angegebenen Dokuments im CLARC Document XML Format.

(GET) CCDELETETACK

Diese Methode löscht das angegebene Dokument vom Server.

(GET) CCGETAPPPROPERTIES

Diese Methode ruft detaillierte Informationen zur angegebenen Anwendung vom Server ab.

(GET) CCGETAPPINFOS

Diese Methode ruft allgemeine Informationen zur angegebenen Anwendung vom Server ab.

(GET) CCGETFIELDSCHEME

Diese Methode ruft das angegebene Feldschema vom Server ab.

(GET) CCGETSCANPROFILES

Diese Methode ruft einer Liste der verfügbaren Scannerprofile für den jeweiligen Host vom Server ab.

(GET) CCGETSCANPROFILE

Diese Methode ruft das angegebene Scannerprofil für den jeweiligen Host vom Server ab.

(GET) CCDELETESCANPROFILE

Diese Methode löscht das angegebene Scannerprofil für den jeweiligen Host vom Server.

(GET) CCGETSTACKLIST

Diese Methode ruft einer Liste der verfügbaren Stapel für die angegebene Anwendung vom Server ab.

(GET) CCGETSTACKID

Diese Methode ruft eine neue StapelId vom Server ab.

(PUT) CCBLOBUPLOAD

Diese Methode überträgt ein Blob als Bytestream an den Server und verknüpft es mit der entsprechenden Anwendung und Benutzer.

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

• BlobId
• BlobHash

(PUT) CCDOCUMENTUPLOAD

Diese Methode überträgt ein Dokument als XML Bytestream im CLARC Document XML Format.

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

• DocId

(PUT) CCDOCUMENTUPDATE

Diese Methode überträgt ein Dokument als XML Bytestream im CLARC Document XML Format und ersetzt das bestehende Dokument damit.

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

• DocId

(PUT) CCEXPORT

Diese Methode übermittelt eine Liste an Dokumenten-Id's in Form eines XML's welche dem entsprechend konfigurierten Nachfolgeprozess zugeführt werden sollen.

Das XML hat folgenden Aufbau:

<?xml version="1.0" encoding="UTF-8"?>
<ccExport FormatVersion="1.7" Compressed="false" Encoding="none">
  <Id>...</Id>
  <Id>...</Id>
  ...
</ccExport >

(PUT) CCCHANGEBLOBS

Diese Methode übermittelt eine Liste an Blob-Id's in Form eines XML's mit entsprechenden Informationen zur Änderung.

Das XML hat folgenden Aufbau:

<?xml version="1.0" encoding="UTF-8"?>
<ccBlobs FormatVersion="1.7" Compressed="false" Encoding="none">
  <Id TId="[TackId]" SId="[SortId]" State="[ONHOLD|IDLE]">[BlobId]></Id>
  ...
</ccBlobs>

(PUT) CCSETTRAININGDATA

Diese Methode übermittelt Trainingsinformationen in Form eines XML's.

Das XML hat folgenden Aufbau:

<?xml version="1.0" encoding="UTF-8"?>
<ccTraining FormatVersion="1.7" Compressed="false" Encoding="none">
  <[FieldName] DataType="[DataType]" Page="[PageId]" TwipsZone="[L,T,R,B]">[BlobId]>[Trained Value]</[FieldName]>
  ...
</ccTraining >

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

• DocId

(PUT) CCSETSCANPROFILE

Diese Methode übermittelt ein Scanner-Profil in Form eines XML's an den Server.

Siehe auch

• CLARC QHIX Daemon
• CLARC EWORK