POST /api-web/api/dms/objects

As of Version

product version 2020 Autumn | component version

Request Method POST

Response Format JSON

Description

Creates a DMS object with the data passed in the multipart request body including the metadata in JSON structure and optionally a binary content file.

The metadata of the created object are returned in the response body.

Response HTTP status codes:

HTTP Status Code	Meaning
200	OK
401	Unauthorized

Request Example

POST /api-web/dms/objects HTTP/1.1
Accept: application/json, application/*+json
Content-Type: multipart/form-data;boundary=Jn3QCX9rHAFQaofW6vsdoz5CsD5_P0PZhH
Content-Length: 83258
Host: 127.0.0.1:7400

--Jn3QCX9rHAFQaofW6vsdoz5CsD5_P0PZhH
Content-Disposition: form-data; name="data"; filename="blob"
Content-Type: application/json;charset=UTF-8
{
"system:objectTypeId": "appPersonalfile:pfdocumentdlm",
"system:tags": [["appclient:dlm:prepare",0]]}

--Jn3QCX9rHAFQaofW6vsdoz5CsD5_P0PZhH
Content-Disposition: form-data; name="files"; filename="JPG_Test-min.jpg"
Content-Type: image/jpeg

--Jn3QCX9rHAFQaofW6vsdoz5CsD5_P0PZhH

Response Example

200 OK

{
   "objects":[
      {
         "properties":{
            "system:objectId":{
               "value":"4ce10337-5875-4a83-8762-4cdc5fa069ra"
            },
            "system:baseTypeId":{
               "value":"system:document"
            },
            "system:objectTypeId":{
               "value":"appPersonalfile:pfdocumentdlm"
            },
            "system:secondaryObjectTypeIds":{
               "value":[
                  "appClientsystem:leadingType",
                  "appClient:clientdefaults"
               ]
            },
            "system:createdBy":{
               "title":"Musterperson, Maria (musterperson)",
               "value":"7d331831-190e-4251-9070-27d36baca9de"
            },
            "system:creationDate":{
               "value":"2021-12-07T11:56:11.160Z"
            },
            "system:lastModifiedBy":{
               "title":"Musterperson, Maria (musterperson)",
               "value":"7d331831-190e-4251-9070-27d36baca9de"
            },
            "system:lastModificationDate":{
               "value":"2021-12-07T11:56:11.160Z"
            },
            "system:versionNumber":{
               "value":1
            },
            "system:tenant":{
               "value":"atenant"
            },
            "system:traceId":{
               "value":"376553d4ebad587a"
            },
            "system:tags":{
               "value":[
                  [
                     "appclient:dlm:prepare",
                     0,
                     "2021-12-07T11:56:11.160Z",
                     "376553d4ebad587a"
                  ],
                  [
                     "litedms:ocr",
                     0,
                     "2021-12-07T11:56:11.160Z",
                     "376553d4ebad587a"
                  ]
               ]
            },
            "appClientsystem:leadingTypeId":{
               "value":"appPersonalfile:pfdocumentdlm"
            }
         },
         "contentStreams":[
            {
               "contentStreamId":"74C9A216-51C9-11EC-B87A-315108D8F4B4",
               "archivePath":"atenant/2021/12/07/",
               "length":198833,
               "mimeType":"image/jpeg",
               "fileName":"JPG_Test-min.jpg",
               "digest":"EFE27946FC2ABB81AC37BCA1F400F99C7FA3DD6F6EA72E3F47437EED842DD123",
               "repositoryId":"s3miniowithpath"
            }
         ]
      }
   ]
}