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

As of Version

product version 2020 Autumn

Request Method GET

Response Format JSON

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

Retrieves a global or app-specific not enriched form by object type ID objecttype and optional query parameters situation and sots (secondary object types).

Retrieves not enriched form by object type ID objecttype and optional query parameters situation and sots (secondary object types) for the active tenant.

Behind the object type ID, add the query parameter ?situation=CREATE (?situation=EDIT) to retrieve the CREATE (EDIT) form. Default is EDIT. Furthermore, add &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.

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

Returns null if there is no designed form model for the given object type.

Response HTTP status codes:

HTTP Status Code	Meaning
200	OK
401	Unauthorized
404	Not found

Request Example

https://<host>/api-web/api/system/dms/forms/email?situation=EDIT

Response Example

200 OK

response 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": []
    }
  ]
}

 true
}