Bespoke Fields

Get a list of bespoke fields

This method requires the BespokeFields:Get permission to be associated with your role.

GET

/gb/bespoke-fields

curl --request GET \
  --url 'https://api.catch-e.com/gb/bespoke-fields?table_name=%3Cstring%3E&field_name=%3Cstring%3E&input_type=text&column_number=123&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "gb_bespoke_fields": [
      {
        "bespoke_field_id": "123456",
        "column_number": 1,
        "default_value": "<string>",
        "field_name": "field_name_1",
        "field_order": 1,
        "input_maxlength": 123,
        "input_rows": 123,
        "input_size": 123,
        "input_type": "label",
        "label_position": "left",
        "table_name": "fm_contracts",
        "validation_error_message": "<string>",
        "validation_regular_expression": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/gb/bespoke-fields"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

table_namestringquery

Optional Table Name

This field supports the wildcard % operator.

Maximum string length: 64

field_namestringquery

Optional Field Name

This field supports the wildcard % operator.

Maximum string length: 60

input_typeenum<string>query

Optional Input Type

Available options: text, date, checkbox, listbox, blank, number, label, textarea

Maximum string length: 60

column_numberintegerquery

Optional Column Number

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team