Add Field to Form

POST /rest/asset/v1/form/{id}/fields.json

Permissions Read-Write Assets

Build a request and mock the response

Method: POST
Path: /rest/asset/v1/form/{id}/fields.json
Tag: Form Fields
Operation ID: addFieldToAFormUsingPOST

Adds a field to a form. Required Permissions: Read-Write Assets

Formats

• Request: application/x-www-form-urlencoded
• Response: application/json

Request

Path parameters

Name	Type	Required	Description	Constraints
id	integer (int32)	Yes	id

Request body

Name: addFormFieldSetRequest
Required: Yes
Schema: model: AddFormFieldRequest

addFormFieldSetRequest

Generated example

{
  "blankFields": 123,
  "defaultValue": "string",
  "fieldId": "123",
  "fieldType": "string",
  "fieldWidth": 123,
  "formPrefill": true,
  "isSensitive": true,
  "hintText": "string",
  "initiallyChecked": true,
  "instructions": "string",
  "label": "string",
  "labelToRight": true,
  "labelWidth": 123,
  "maskInput": "string",
  "maxLength": 123,
  "maxValue": 123,
  "minValue": 123,
  "multiSelect": true,
  "required": true,
  "validationMessage": "string",
  "values": "string",
  "visibleLines": 123
}

Referenced models

• AddFormFieldRequest

Example request

POST {{base_url}}/rest/asset/v1/form/{{id}}/fields.json
Content-Type: application/x-www-form-urlencoded
Accept: application/json

{
  "blankFields": 123,
  "defaultValue": "string",
  "fieldId": "123",
  "fieldType": "string",
  "fieldWidth": 123,
  "formPrefill": true,
  "isSensitive": true,
  "hintText": "string",
  "initiallyChecked": true,
  "instructions": "string",
  "label": "string",
  "labelToRight": true,
  "labelWidth": 123,
  "maskInput": "string",
  "maxLength": 123,
  "maxValue": 123,
  "minValue": 123,
  "multiSelect": true,
  "required": true,
  "validationMessage": "string",
  "values": "string",
  "visibleLines": 123
}

Responses

200 — OK

Schema: model: ResponseOfLpFormFieldResponse

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "blankFields": 123,
      "columnNumber": 123,
      "dataType": "string",
      "defaultValue": "string",
      "fieldMetaData": {},
      "fieldWidth": 123,
      "fields": [
        "string"
      ],
      "formPrefill": true,
      "isSensitive": true,
      "hintText": "string",
      "id": "123",
      "instructions": "string",
      "label": "string",
      "labelWidth": 123,
      "maxLength": 123,
      "required": true,
      "rowNumber": 123,
      "text": "string",
      "validationMessage": {},
      "visibilityRules": {
        "ruleType": "string",
        "rules": [
          {
            "altLabel": "string",
            "operator": "string",
            "picklistFilterValues": [
              null
            ],
            "subjectField": "string",
            "values": [
              null
            ]
          }
        ]
      }
    }
  ],
  "success": true,
  "warnings": [
    "string"
  ]
}

Referenced models

• ResponseOfLpFormFieldResponse

Source

Generated from swagger-asset.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.