Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje19 MAY 20212021 SummerPage created.


...

As of Version

product version 2020 Autumn | component version 

Request MethodPOST
Response FormatJSON
Description


Excerpt

requests objects

The role YUUVIS_TENANT_ADMIN is required

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 200 OK
Successful.401 401 UnauthorizedNot successful.


Request Example

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

Code Block
{
  "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

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


...