PUT Screen

TABLE OF CONTENTS

Parameters
Example

The PUT Screen Form API allows you to update an existing form screen.

Enables scenarios where 3rd party systems can make edits/changes to forms for whatever reason. Everything from form name, description, fields, etc...can be edited and updated using this API.

The API has many properties that can be updated, proportional to the number of fields used in each screen. The more fields the form has, the more properties to be updated through the API.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/screen/form?format=xml/json

You may use either JSON or XML formats in your PUT request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".

If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the XML body root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters

The required parameters for a PUT request to the Screen API are outlined below.

Name	Type	Description	Required
Id	String	The unique identifier of the Form to update (GUID).	✓
CompanyId	Integer	Your unique Company Id found on the Company Setup page of the secure website.	✓
IntegrationKey	String	Your unique Integration Key found on the Company Setup page of the secure website.	✓
Name	String	The Form's title used for all default display to app users.
Description	String	The Form's description.
ExternalId	String	The External identifier of the form to update.
Icon	String	The Form's icon to display.
Version	Integer	The version of the screen to update when using ExternalId.
Status	String	The status of the screen to update when using ExternalId.
ChangeStatusTo	String	The desired status after updating the Form.
Design	Array[FormScreenControl]	The full design for this Form.
Settings	Array[FormScreenSettings]	The settings for this Form.
Connectors	Array[FormScreenConnector]	The connectors for this Form.
DesignFormat	String	['OnlyFields', 'FullDesign']

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.

Request URL

PUT 443/api/v2/screen/form

Request Body

{
  "Id": "ef5XXXXXXXXXXXXXXXXXXXXXXX",
  "Name": "App - Updated through API - TEST",
  "Description": "This app can be deleted.",
  "ExternalId": "",
  "Icon": "",
  "Version": 1,
  "Status": "",
  "ChangeStatusTo": "",
  "DesignFormat": "",
  "CompanyId": 6XXXX,
  "IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Response Body

{
  "FormScreen": {
    "Id": "ef5XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "Name": "App - Updated through API - TEST",
    "Description": "This app can be deleted.",
    "ExternalId": "",
    "Icon": "",
    "Version": 1,
    "Status": "Published",
    "Fields": [
      {
        "Name": "page1",
        "Type": "Group"
      },
      {
        "Name": "selectitem",
        "Title": "Select Item to delete",
        "Type": "SelectMulti",
        "Parent": "page1"
      },
      {
        "Name": "table",
        "Type": "RepeatGroup",
        "Parent": "page1"
      },
      {
        "Name": "tablezz1",
        "Title": "tablezz1",
        "Type": "SelectOne",
        "Parent": "table"
      },
      {
        "Name": "ds_testing",
        "Type": "SelectOne",
        "Parent": "table"
      },
      {
        "Name": "ID",
        "Title": "ID",
        "Type": "Text",
        "Parent": "table"
      },
      {
        "Name": "Item",
        "Title": "Item",
        "Type": "Text",
        "Parent": "table"
      },
      {
        "Name": "ds_testing_id",
        "Title": "ds_testing_id",
        "Type": "Hidden",
        "Parent": "table"
      }
    ],
    "Settings": {
      "PageNamesTab": {
        "BackgroundColor": "#BBBBBB",
        "SelectedBackgroundColor": "#0072C6",
        "Style": {
          "Color": "#FFFFFF",
          "Decor": "normal",
          "Size": "Medium"
        }
      },
      "ImageResizeTo": "800",
      "LogUserLocation": true,
      "HistoryDays": 14,
      "HideSplash": true,
      "DisplayOrder": 1,
      "HtmlTemplateText": "",
      "OutputTemplate": "ClassicGray"
    },
    "Connectors": [],
    "DesignFormat": "OnlyFields",
    "CompanyId": 6XXXX
  }
}

English

Parameters

Example