Home Page > Integration > REST API > Fields > GridColumns

GridColumns

GridColumns - /REST/1/Fields/:id/GridColumns

This endpoint is used for manipulating GridColumns for a Grid Field in the system. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The GridColumn object takes the following JSON object:

[
    {
        "code": "<string>",
        "display_order": "<int>",
        "field_display_type": "<enum>",
        "id": "<int>",
        "name": "<string>",
        "field_id": "<int>"
    }
]

 

Note: field_id will not show up in the standard GET, only if using the optional GET without Fields.

GET

As with other resources, this resource is subject to the global parameters mentioned in the REST Overview.

 

Optional GET only: /REST/1/GridColumns/:id

PUT

The following JSON parameters are available when updating a resource:

 

JSON Parameter Allowed values
code

string

name string
display_order integer

 

POST

The following JSON parameters are required when creating a resource:

 

JSON Parameter Allowed values
name string
field_display_type

enum:

  • ​suggestion
  • fixedSuggestion
  • option
  • singleLine
  • multiLine
  • ​date
  • boolean

 

 

DELETE

The resource can be deleted using this verb and including the id in the endpoint URL.

 

 

 

 

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.