POST /api-web/api/system/dms/forms/{objecttype}

Owned by Technische Redaktion
Last updated: Nov 09, 2022
7 min read
As of Version

product version 2020 Autumn | component version 

Request MethodPOST
Response FormatJSON
Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service
Description

Updates a global or app-specific not enriched form identified by object type ID objecttype and optional query parameters sots (secondary object types) with the data passed in JSON format in the request body.

Behind the object type ID, add the query parameter ?sots=<objectTypeId> in order to specify a secondary object type of which properties should be included in the retrieved form. The sots query parameter can be added multiple times for different secondary object types, separated by & characters.

As of 2022 Autumn, an optional query parameter tenant can be specified in order to update the tenant-specific form instead of the global or app-specific one.

The response body is a JSON structure with the list errors containing possibly occured error messages, and the boolean valid that is true for a successfully validated JSON in the request body.

Response HTTP status codes:

HTTP Status CodeMeaning
200 OK
201 OK
401 Unauthorized
Request Example

https://<host>/api-web/api/system/dms/forms/email

request body
{
  "name": "email",
  "situation": "EDIT",
  "script": "a valid script",
  "elements": [
    {
      "name": "core",
      "type": "o2mGroup",
      "layout": {
        "align": "column"
      },
      "elements": [
        {
          "type": "o2mGroupStack",
          "elements": [
            {
              "name": "emaildatagroup",
              "type": "o2mGroup",
              "layout": {
                "align": "column"
              },
              "elements": [
                {
                  "readonly": true,
                  "name": "subject",
                  "type": "string",
                  "rows": 1
                },
                {
                  "type": "o2mGroup",
                  "layout": {
                    "align": "row"
                  },
                  "elements": [
                    {
                      "type": "o2mGroupStack",
                      "elements": [
                        {
                          "name": "Addresses",
                          "type": "o2mGroup",
                          "layout": {
                            "align": "column"
                          },
                          "elements": [
                            {
                              "readonly": true,
                              "name": "from",
                              "type": "string",
                              "rows": 1
                            },
                            {
                              "readonly": true,
                              "name": "to",
                              "type": "string",
                              "rows": 1
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            },
            {
              "name": "appClient:titledescription",
              "type": "o2mGroup",
              "layout": {
                "align": "column"
              },
              "elements": [
                {
                  "readonly": true,
                  "name": "appClient:clientdescription",
                  "type": "string",
                  "rows": 1
                },
                {
                  "type": "o2mGroup",
                  "layout": {
                    "align": "row"
                  },
                  "elements": []
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "name": "data",
      "type": "o2mGroupStack",
      "elements": []
    }
  ]
}
Response Example

200 OK 

response body
{
  "errors": [],
  "valid": true
}

true }