Parameters and Keywords

Use

A parameter appears no more than once in a URL. 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 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:

• accessMode [string]

  Access Mode

• authId [string]

  ID of Client

• caseSensitive [y|n]

  Determines whether the search is case-sensitive. The default value is n.

  • caseSensitive=n

    Search is not case-sensitive

  • caseSensitive=y

    Search is case-sensitive.

• charset [string]

  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.

• compDateC [string]

  Creation date of a component in UTC format, that is, YYYY-MM-DD

• compDateM [string]

  Date component was last changed, in UTC format: YYYY-MM-DD.

• compId [string]

  Identifies a component within a document.

• compTimeC [string]

  Time the component was created, in UTC format: HH:MM:SS

• compTimeM [string]

  Time the component was last changed, in UTC format: HH:MM:SS

• compStatus [online|offline]

  Status of component in the content repository. Meaning:

  • online:

    Component known and accessible

  • offline:

    Component known and currently inaccessible

• Content-Disposition

  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.

• Content-Length [integerstring]

  Size of body or component in bytes. The parameter Content-Length can occur both in the response header and in part headers.

• Content-Type [string]

  Content-Type [string] Identifies the Content-Type of a component or a transferred document. The parameter Content-Type can occur both 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.

• contRep [string]

  Specifies the content repository.

• contRepDate [string]

  Content repository date in UTC format: YYYY-MM-DD

• contRepDescription [string]

  Text describing content of the content repository.

• contRepErrorDescription [string]

  Text describing content of the repository content.

• contRepStatus [running|stopped|error]

  Text describing the status of a content repository. Meaning:

  • running

    Content Repository is running

  • stopped

    Content Repository was stopped

  • error

    Error in the Content Repository

• contRepTime [string]

  Content repository time in UTC format: HH:MM:SS.

• contRepVendorId [string]

  Vendor and version of content repository software

• dateC [string]

  Creation date of a document in UTC format, that is, YYYY-MM-DD

• dateM [string]

  Date document was last changed, in UTC format: YYYY-MM-DD.

• docID [string]

  Unique identifier of a document header.

• docProt [string]

  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, or d. The parameter can overwrite the default set on the content server.

  For example, the combination docProt=rcud fully protects a document.

• docStatus [online|offline]

  Status of document in the content repository. Meaning:

  • Online

    Document known and accessible

  • offline

    Document known and inaccessible

• expiration [string]

  Expiry time of a signed URL, in UTC format: YYYYMMDDHHMMSS.

• fromOffset [integerstring]

  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.

• numComps [integerstring]

  Number of components in a document.

• numResults [integerstring]

  Determines the maximum number of results (hits) a search can return.

• pattern [string]

  Character pattern used for an unrestricted search. See the function search.

  The counterpart of pattern [string] in the attribute search is pattern pattern [integerstring+integerstring+string].

• pattern [integerstring+integerstring+string]

  Attribute pattern searched for in the attribute search. See the function attrSearch.

  The counterpart of pattern pattern [integerstring+integerstring+string] in the unrestricted search is pattern [string].

• pVersion [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.

• resultAs [string]

  Chooses the presentation form for the result of the info function. The default is ASCII.

  • resultAs=ascii

    The results are returned in ASCII format.

  • resultAs=html

    The results are returned in HTML format.

• retCode [integerstring]

  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.

• secKey [string]

  Specifies an access key that can be used to check access authorization. The SAP system generates the access key.

• serverDate [string]

  Content server date in UTC format: YYYY-MM-DD

• serverErrorDescription [string]

  Text describing content of the repository server.

• serverStatus [running|stopped|error]

  Text describing the status of a content server. Meaning:

  • running

    Content Server is running

  • stopped

    Content server was stopped

  • error

    Error in the Content Server

• serverTime [string]

  Content server time in UTC format: HH:MM:SS.

• serverVendorId [string]

  Vendor and version of content server software.

• timeC [string]

  Creation date of a document in UTC format, that is, HH:MM:SS.

• timeM [string]

  Time a document was last changed, in UTC format: HH:MM:SS

• toOffset [integerstring]

  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.

• version [string]

  Describes the application version used to create a document or component. The version is transferred as a 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.

• serverStatusDescription [string]

  Header field in which the content server enters an explanatory text if an error occurs.