Anfang des Inhaltsbereichs

Hintergrunddokumentation Funktion: get Dokument im Navigationsbaum lokalisieren

Eine Content-Einheit einer Komponente bzw. ein Bereich der Content-Einheit wird aus dem Content-Repository geholt. Die Komponente wird durch contRep, docId und compId beschrieben. Der Bereich der Content-Einheit kann durch fromOffset und toOffset beschrieben werden.

Bei Erfolg wird die Content-Einheit vom Server zum Client als Entity-Body in der Antwort auf einen HTTP-GET-Request übertragen.

Wird eine compId nicht angegeben, müssen folgende Bedingungen in der entsprechenden Reihenfolge getestet werden:

    1. Existiert eine Komponente „data", wird diese zurückgegeben.
    2. Existiert eine Komponente „data1", wird diese zurückgegeben.

Die Funktion liefert den Fehler 404 (not found), wenn eine falsche oder keine compId angegeben wurde und keine der obigen Bedingungen erfüllt ist.

lesen (r)

Der Client sendet ein HTTP-GET-Request. In der URL sind folgende Parameter möglich:

Parameter

Angabenotwendigkeit

Default

signieren

contRep

obligatorisch

 

X

docId

obligatorisch

 

X

compId

optional

siehe oben

 

pVersion

obligatorisch

   

fromOffset

optional

0

 

toOffset

optional

-1

 

accessMode

s-mandatory

 

X

authId

s-mandatory

 

X

expiration

s-mandatory

 

X

secKey

optional

   

Hinweis

s-mandatory heißt, dass dieser Parameter nur angegeben werden muss, wenn die URL signiert wird.

http://pswdf009:1080/ContentServer/ContentServer.dll?get&pVersion=0045&contRep=K1&docId=361A524A3ECB5459E0000800099245EC&compId=data

Es wird die Komponente „data" des Dokuments angefordert.

Der Server antwortet auf den Request mit einem Response. Anhand des Statuscodes des Response kann der Erfolg des Aufrufs abgelesen werden.

HTTP-Statuscode

Bedeutung

200 (OK)

OK, Content-Einheit der Komponente wird übertragen

400 (bad request)

Unbekannte Funktion oder unbekannte Parameter

401 (unauthorized)

Sicherheitsverletzung

404 (not found)

Dokument/Komponente nicht gefunden

409 (conflict)

Dokument/Komponente ist nicht zugreifbar

500 (Internal Server Error)

Interner Fehler im Content-Server

 

Es werden folgende Standardinformationen zum Dokument im Header des Response angezeigt:

Schlüsselwort

Bedeutung

Content-Type

Content-Type

charset

Zeichensatz der Komponente (als Parameter von Content-Type)

version

Version der Komponente (als Parameter von Content-Type)

Content-Length

Gesamtlänge des tatsächlich übertragenen Bodys

Der Content-Type des Response richtet sich nach dem Content-Type der angeforderten Komponente. Wenn der charset einer Komponente bekannt ist, muss dieser als Parameter des Content-Type mit übertragen werden.

Ebenfalls muss der Parameter version (d. h. die Versionsnummer der Applikation, mit der der Inhalt der Komponente erstellt wurde – siehe Parameter und Schlüsselworte) einer Komponente als Parameter des Content-Type mit übertragen werden, wenn er bekannt ist.

Im Body des Response wird die Content-Einheit (oder ein Bereich) der Komponente übertragen.

Ende des Inhaltsbereichs