POST /api-web/api/dms/objects/search

Owned by Technische Redaktion
Dec 01, 2022
2 min read
As of Version

product version 2020 Autumn | component version 

Request MethodPOST
Response FormatJSON
Description

Retrieves a list of DMS objects matching the search query passed in the request body in JSON format.

Response HTTP status codes:

HTTP Status CodeMeaning
200 OK
401 Unauthorized
Request Example

https://<host>/api-web/api/dms/objects/search

{
  "aggs": [
    "string"
  ],
  "dmsApiStatement": "string",
  "fields": [
    "string"
  ],
  "filters": [
    {
      "f": "string",
      "filters": [
        null
      ],
      "lo": "string",
      "o": "string",
      "v1": {},
      "v2": {}
    }
  ],
  "from": 0,
  "lots": [
    "string"
  ],
  "size": 0,
  "sort": [
    {
      "order": "string"
    }
  ],
  "term": "string",
  "types": [
    "string"
  ]
}
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
}