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
User-Agent: Java/1.8.0_60
Connection: keep-alive
Content-Length: 83258
Host: 127.0.0.1:7400

--Jn3QCX9rHAFQaofW6vsdoz5CsD5_P0PZhH
Content-Disposition: form-data; name="data"
Content-Type: application/json;charset=UTF-8

{
"system:objectTypeId": "appEmail:email",
"from": "Garco Meissler <garco@example.de>",
"to": "Dudreas Annkel <dudreas@example.de>",
"cc": "Kruedeas Anger <kruedeas@example.de>",
"subject": "Bewerbungsunterlagen" }

--Jn3QCX9rHAFQaofW6vsdoz5CsD5_P0PZhH
Content-Disposition: form-data; name="cid_63apple"; filename="upload.eml"
Content-ID: cid_63apple
Content-Type: message/rfc822

From: Garco Meissler <garco@example.de>
To: Dudreas Annkel <dudreas@example.de>
Cc: Kruedeas Anger <kruedeas@example.de>
Message-ID: <12716821.1.1500391295036.JavaMail.meissler@APGMEISSLER>
Subject: =?UTF-8?Q?Bewerbungsunterlagen?=
MIME-Version: 1.0
Content-Type: multipart/mixed;
boundary="----=_Part_0_16468615.1500391295024"

------=_Part_0_16468615.1500391295024
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: quoted-printable

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy ei=
rmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu=
ptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita k=
asd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lore=
...
en, no sea takimata sanctus est Lore
------=_Part_0_16468615.1500391295024--

--Jn3QCX9rHAFQaofW6vsdoz5CsD5_P0PZhH

Response Example

200 OK

{
  "objects": [
    {
      "properties": {
        "system:objectId": {
          "value": "4711-44321-666777888"
        },
        "subject": {
          "value": "Sie sind der Doc, Doc."
        }
      }
    }
  ],
  "numItems": 0,
  "hasMoreItems": true,
  "totalNumItems": 0
}