Seitenvergleich

...

Universal Messenger Forms REST interface

See also REST API doc

Request

• URL: <um-rest-url>/de.pinuts.cmsbs.restapi.Forms/index

• Parameters:

  • umopen: API key (prior to UM 7.56)

  • locale: language code (de, en…)

  • search: filter results by substring match to name, title or description

• Headers (UM 7.56 or newer):

  • Authorization: Basic Auth credentials of API key with permission de.pinuts.cmsbs.restapi:ListForms
    See also https://pinutswiki.atlassian.net/wiki/spaces/UMDOC/pages/4541349948/Universal+Messenger+7.56.0+EN#Securing-REST-endpoints-with-API-keys

Response

• Format: JSON

• Array of form (app instance) objects with the following attributes

  • name: internal id (usually a GUID)

  • title: Label, can be displayed to editors

  • locale: Language code

  • description

  • type: App type (de.pinuts.cmsbs.newsletter, de.pinuts.cmsbs.contactform…)

  • icon: PNG icon base64 encoded

  • htmlSnippet: HTML snippet which must be used to insert into the web page HTML code to display the form.
    If the CMS can only store flat strings, this is the string to be stored.

...