Functions
Functions
This section describes the available functions and their parameters. The effect of each function, its parameters, and an example are given.
‘Effect’ describes the executed function. The individual parameters are also explained.
‘Default’ describes the effect of transferring only the mandatory parameters of a multi-parameter function.
‘Access mode’ specifies the access mode for the function.
‘Client → Server’ lists and specifies as optional or mandatory the parameters that are transferred from the client to the server. It is specified whether the parameters are optional or mandatory. ‘s-mandatory’ means that the relevant parameter must only be specified if a
‘Example’ gives an example of the executed function, using example parameters. Line breaks are included in the examples purely as an aid to legibility. The actual URLs do not contain any line breaks.
‘Server → Client’ defines the structure of the HTML response. HTML responses are generated by the server and are then sent to the client.
The HTTP status codes specific to the content server are also listed in this section. If no security key is entered, this may cause errors, for example, error 401 (‘unauthorized’). A wrongly addressed document can cause error 404 (‘not found’). If an error occurs, the content server must deliver an ASCII string describing the error. The error must be entered in the header field
X-ErrorDescription.Function Overview
|
Command |
Effect |
Access Mode |
|
info |
Retrieve information about the document |
r |
|
get |
Fetch (within a range) a content unit of a component |
r |
|
docGet |
Fetch the entire content of a document |
r |
|
create |
Create a new document |
c |
|
mCreate |
Creates a number of new documents |
c |
|
append |
Append data to a content unit |
u |
|
update |
Modify an existing document |
u |
|
delete |
Delete a document or a component |
d |
|
search |
Search for a text pattern within a content unit |
r |
|
attrSearch |
Search for one or more attributes within a document (search within a print list) |
r |
|
putCert |
Transfer client (for example, the SAP system) certificate |
- |
|
serverInfo |
Retrieve information about the content server and the corresponding content repositories |
- |