Get Fields for Form¶

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

Permissions Read-Only AssetsRead-Write Assets

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

Retrieves the list of fields in the target form. Required Permissions: Read-Only Assets, 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

Query parameters¶

Name	Type	Required	Description	Constraints
`status`	string	No	Status filter for draft or approved versions	enum: approved, draft

Example request¶

GET {{base_url}}/rest/asset/v1/form/{{id}}/fields.json?status=approved
Accept: application/json

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.