getBespokeFields

Overview

This method returns a list of bespoke (custom) field definitions, optionally filtered by table, field name, input type or column number.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'BespokeFields:Get'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/gb/bespoke-fields https://api.{{environment}}.catch-e.com/gb/bespoke-fields https://api.test.catch-e.com/gb/bespoke-fields

Query Parameters

Key	Format	Notes	Mandatory
table_name	string	Filter by table name. Up to 64 characters. Supports the wildcard `%` operator.	No
field_name	string	Filter by field name. Up to 60 characters. Supports the wildcard `%` operator.	No
input_type	string	Filter by input type. Allowed values: `text`, `date`, `checkbox`, `listbox`, `blank`, `number`, `label`, `textarea`.	No
column_number	integer	Filter by column number.	No
page	integer	Page number. Default `1`.	No
page_size	integer	Number of records per page. Default `25`. Use `-1` to return all records.	No

Response Details

Success

200 - OK

Each record in _embedded.gb_bespoke_fields contains:

Field	Format	Notes
bespoke_field_id	string
table_name	string
field_name	string
label_position	string	Values: `left`, `above`.
input_type	string	Values: `text`, `date`, `checkbox`, `listbox`, `blank`, `number`, `label`, `textarea`.
input_size	integer (int32)
input_maxlength	integer (int32)
input_rows	integer (int32)
field_order	integer (int32)
column_number	integer (int32)
default_value	string
validation_regular_expression	string
validation_error_message	string

{ "_links": { "self": { "href": "https://api.catch-e.loc/gb/bespoke-fields?page=1" } }, "_embedded": { "gb_bespoke_fields": [ { "bespoke_field_id": "1234", "table_name": "[TABLE-NAME]", "field_name": "string", "label_position": "left", "input_type": "text", "input_size": 20, "input_maxlength": 50, "input_rows": 1, "field_order": 1, "column_number": 1, "default_value": "string", "validation_regular_expression": "string", "validation_error_message": "string" } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 }

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
404 - Not Found	No bespoke fields were found.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
409 - Conflict	The request conflicts with the current state of the data.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Conflict", "status": 409, "detail": "Conflict" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }