Get Available Form Fields

GET /rest/asset/v1/form/fields.json

Retrieves a list of all valid fields for use in forms.

Operation ID: getAllFieldsUsingGET
Permissions: Read-Only Assets, Read-Write Assets
Request format: application/x-www-form-urlencoded
Returns: ResponseOfFieldsMetaDataResponse

Parameters

Query 2

maxReturn integer (int32)

Maximum number of fields to return. Max 200, default 20

offset integer (int32)

Integer offset for paging

Responses

200 OK ResponseOfFieldsMetaDataResponse

errors array of Error

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

requestId string

result array of FieldsMetaDataResponse

Model FieldsMetaDataResponse

dataType string

Type of field

defaultValue string

Optional default value for the field

description string

Description of the field

fieldMaskValues string

Optional input mask for the field

fieldWidth integer (int32)

Width of the input or select element

id string required

Id of the field

initiallyChecked boolean

Whether the field should be checked upon loading. Default false

isLabelToRight boolean

Whether the field label should be displayed to the right of the input/select element. Default false

isMultiselect boolean

Whether the field should allow multiple selections. Default false

isRequired boolean

Whether the field is required to submit the form. Default false

isSensitive boolean

Whether the field is marked as sensitive. Default false

labelWidth integer (int32)

Width of the field label element

maxLength integer (int32)

Maximum length for text type fields

maximumNumber number (float)

Maximum value accepted by the field

minimumNumber number (float)

Minimum value accepted by the field

picklistValues string

Comma-separated list of available picklist values for the field

placeholderText string

Placeholder text for the field

validationMessage string

Validation message to display on failed validation

visibleRows integer (int32)

Number of rows visible for progressive profiling

success boolean

warnings array of string

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "dataType": "string",
      "defaultValue": "string",
      "description": "string",
      "fieldMaskValues": "string",
      "fieldWidth": 123,
      "id": "123",
      "initiallyChecked": true,
      "isLabelToRight": true,
      "isMultiselect": true,
      "isRequired": true,
      "isSensitive": true,
      "labelWidth": 123,
      "maxLength": 123,
      "maximumNumber": 123,
      "minimumNumber": 123,
      "picklistValues": "string",
      "placeholderText": "string",
      "validationMessage": "string",
      "visibleRows": 123
    }
  ],
  "success": true,
  "warnings": [
    "string"
  ]
}

Referenced models

Generated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.