Parameters and Keywords
Parameters and Keywords
A parameter appears no more than once in a URL. The parameters and key words defined are listed below in alphabetical order. The data type is given in square brackets (a "string" consists of characters from the ASCII character set and an "integerstring" consists of characters from the set {0,1,2,3,4,5,6,7,8,9}): The following parameters and key words are defined:
Access Mode
Client ID
Determines whether the search is case-sensitive. The default value is
n.Search is not case-sensitive
Search is case-sensitive
Describes the character set used to encode the component content (for example, ISO-8859-1; see also RFC 2046). Other values can be defined, but must have an
X- placed before them. The character set is transferred as a Content-Type parameter.Creation date of a component in UTC format, that is, YYYY-MM-DD
Date component was last changed, in UTC format.
Identifies a component within a document.
Additional information for partners who already support the ArchiveLink interface:
Data files for stored print lists and outgoing documents are interpreted as
Predefined values for components:
- "
- "
descr" attribute file- "
note" noteTime the component was created, in UTC format: HH:MM:SS
Time the component was last changed, in UTC format
Status of component in the content repository. Meaning:
Component known and accessible
Component known and currently inaccessible
Content-Disposition
can be transferred with compId as an additional parameter if documents are being transferred as multipart/form-data (see also HTTP-POST multipart/form-data). If Content-Disposition is used in this way, it must be consistent with X-compId.
This parameter can be ignored.
Size of body or component in bytes. The parameter
Content-Length can occur both in the response header and in part headers.Identifies the
Content-Type of a component or a transferred document. Can occur in the response header and in part headers. With charset, the character set used to write the component content can be specified as the Content-Type parameter.Specifies the content repository
Content repository date in UTC format: YYYY-MM-DD
Text describing content of the repository content
Text describing a content repository error
Content repository status. Meaning:
Content repository is running
Content repository has been stopped
Error in content repository
Content repository time in UTC format: HH:MM:SS
Manufacturer and version of content repository software
Creation date of a document, in UTC format: YYYY-MM-DD
Date the document was last changed, in UTC format:YYYY-MM-DD
Unique identifier for document header
Security level of a document
docProt controls the security level of a document and its information. docProt is a combination of the access rights r,c,u,and d. The parameter can overwrite the default set on the content server.For example, the combination
docProt=rcud fully protects a document.Status of document in the content repository. Meaning:
Document known and accessible
Document known and inaccessible
Expiry time of a signed URL, in UTC format: YYYYMMDDHHMMSS
Specifies the starting point for a search or the beginning of a byte range within the component. The default is 0. This parameter is needed so that parts of the component (with print lists, for example) can be read.
Number of components in a document
Determines the maximum number of results (hits) a search can return
Character pattern used for an unrestricted search. See the function
search.The counterpart of
pattern [string] in the attribute search isAttribute pattern searched for in the attribute search. See function
attrSearch.The counterpart of
pattern [integerstring+integerstring+string] in the unrestricted search is pattern [string].Specifies the interface version. Versions 0021, 0030 and 0031 were defined for the ArchiveLink interface. The HTTP Content Server interface begins with version 0045.
Chooses the presentation form for the result of the
info function. The default is ASCII.Results given in ASCII format
Results given in HTML format
Part of the ASCII string sent by the content server to the client after an
mCreate call. Contains the HTTP status code for the corresponding document.Specifies an access key that can be used to check access authorization. The SAP system generates the access key.
Content server date in UTC format: YYYY-MM-DD
Text describing confirmed content server error
Content server status. Meaning:
Content server is running
Content server has been stopped
Content server error
Content server time in UTC format: HH:MM:SS
Manufacturer and version of content server software
Creation date of a document, in UTC format: HH:MM:SS
Time the document was last changed, in UTC format: HH:MM:SS
Specifies the end of a byte range within the component. The default -1 means that the search should continue to the end of the component.
toOffset has priority over any content range that may be set.Describes the application version used to create a document or component. The version is transferred as the
Content-Type parameter. For some MIME types, version numbers are registered at IANA, so that they are always used consistently. For example, versions 2w, 4, 5 and 6 are used for application/msword.Header field in which the content server enters an explanatory text if an error occurs.