Function:
mCreateOne or more documents, each with one or more components, are stored in the content repository. This function has a similar effect to that of several sequential
create functions, but is significantly more efficient at storing many new documents at once in the case of signed URLs.Within an
mCreate call, objects can only be stored in one and the same content repository. The content repository is described by the URL parameter contRep.The individual components of the documents are transferred in a
multipart/form-data entity body. Components of the same document must be transferred one after the other so that transfer of a document can be assumed to be complete as soon as a component from a different document begins.The parameter
docId is mandatory for all components (each multipart-part) and is entered as the header field "X-docId".A document is stored by means of a single transaction, but this is not the case for all documents transferred in one
mCreate call.create (c)
The client sends an
HTTP-POST-Request. The following parameters are possible:
Parameter |
Header Field in Body |
Optional/Mandatory |
Default |
Position |
Sign |
contRep |
mandatory |
URL |
X |
||
compId |
"X-compId" |
mandatory |
body |
||
docId |
"X-docId" |
mandatory |
body (1. docId also in URL) |
X (1. docId) |
|
pVersion |
mandatory |
URL |
|||
Content-Type |
optional |
body |
|||
charset |
optional |
body |
|||
version |
optional |
body |
|||
Content-Length |
mandatory |
body |
|||
docProt |
optional |
server setting |
URL |
X |
|
accessMode |
s-mandatory |
URL |
X |
||
authId |
s-mandatory |
URL |
X |
||
expiration |
s-mandatory |
URL |
X |
||
secKey |
optional |
URL |
s-mandatory means that this parameter need only be specified if the URL is signed.
The parameters for which the request body is specified as position are transferred into the header field of the multipart part of the corresponding components. For special parameters in this interface, the name of the header field is in column 2 of the table.
The server answers the request with a response. The response status code indicates the outcome of the call. A distinction is made between general status codes, which describe the success of the call as a whole, and special status codes, which confirm the creation of individual documents:
General HTTP Status Codes |
Meaning |
201(created) |
OK, all documents were created |
250 (missing documents created) |
OK, all missing documents were created This status can occur only in the case of repeated mcreate calls. |
400 (bad request) |
Unknown function or unknown parameter |
401 (unauthorized) |
Security breach |
500 (Internal Server Error) |
Internal error on Content Server |
Specific HTTP Status Codes |
Meaning |
201(created) |
OK, document created |
403 (forbidden) |
Document already exists |
500 (Internal Server Error) |
Internal error on Content Server |
An ASCII text must be returned whether the function is executed successfully or not. The documents stored (HTTP status code 201) and/or not stored (HTTP status code 403) are specified in this text. The following format is used:
docId="string";retCode="integerstring";errorDescription="string";CRLF
The value of the parameter
retCode is the corresponding specific HTTP status code.As a summary, the response body contains the following standard information about each document:
Keyword |
Format |
Meaning |
docId |
string |
Document ID |
retCode |
Integer string |
HTTP status code |
errorDescription |
string |
Text explaining the error (optional) |