Start of Content Area

This graphic is explained in the accompanying text Function: serverInfo  Locate the document in its SAP Library structure

This function supplies information about the status of the Content Server and the content repositories that the Content Server administrates.

The standard information is returned to the content server and the content repositories that it manages. The results are given in ASCII format.

-

The client sends an HTTP-GET-Request. The following parameters are possible:

Parameter

Optional/Mandatory

Default

Sign

contRep

optional

All repositories

 

pVersion

mandatory

   

resultAs

optional

ascii

 

http://pswdf009:1080/ContentServer/ContentServer.dll?serverInfo&
pVersion=0046

In the example, information about the content server and all the content repositories it manages is requested.

The server answers the request with a response. The response status code indicates the outcome of the call.

HTTP Status Code

Meaning

200 (OK)

OK

400 (bad request)

Unknown function or unknown parameter

500 (Internal Server Error)

Internal error on Content Server

 

The following information about the content server status is displayed:

Keyword

Format

Meaning

serverStatus

 

Status of content server (running/ stopped/ error)

serverVendorId

 

Manufacturer and software version

serverVersion

 

Version of server

serverBuild

 

Build of server

serverTime

HH:MM:SS

Content server time (UTC)

serverDate

YYYY-MM-DD

Content server date (UTC)

serverStatusDescription

 

Text describing server status

pVersion

 

Content server interface version

 

The following information about the status of each content repository is displayed:

Keyword

Format

Meaning

contRep

 

Content repository

contRepDescription

 

Text describing content of the repository content

contRepStatus

 

Status of content repository (running/ stopped/ error)

contRepStatusDescription

 

Text describing content repository status

Note

These parameters are mandatory. The parameter list is designed so that it can be extended, if required.

For each function call, all information about the content server is provided. If no content repository is addressed, information on all content repositories is provided. ContRep can be used to limit the content repository information to a single content repository.

There are two methods of coding the results in the response body. These methods are explained below. The parameter resultAs controls coding.

  1. resultAs=ascii (default)

A pure ASCII text is returned. The information about the content server is at the start of the string, followed by the information about the content repositories. The following format is used:

serverStatus="string";serverVendorId="string";serverTime="string";serverDate="string";serverErrorDescription="string";pVersion="0046";CRLF

contRep="string";contRepDescription="string";contRepStatus=
"string";pVersion="0046";CRLF

If no value is entered, the value remains free.

contRepDescription="";contRepStatus="string";...

The order of the key words does not matter, but there must not be any blank characters. The key words (together with their values) are separated from each other by a semicolon. The corresponding values are in quotation marks.

  1. resultAs=html

If resultAs=html is set, the server sends an HTML page. The structure of the HTML page is not specified, which means that graphical elements can be used as much as required.

 

 

 

End of Content Area