Operation

Returns a paged array of CustomField elements that contain the configuration of every field.

GET

https://{environment}.ulysescloud.com/api/{version}/chain/{chainId}/customField

Request

Property	Type	Required	Type parameter	Default value
chainId	String	true	path parameter
offset	Integer	false	request parameter	0
limit	Integer	false	request parameter	10
sort	String	false	request parameter	"id"
sortMode	String	false	request parameter	"Asc"
search	String	false	request parameter

Example request

GET https://prod.ulysescloud.com/api/v1/chain/1/customField

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Field	Type	Required	Description
id	Integer	true	Unique identifier for the CustomField.
code	String	true
name	String	true
booleanDefaultValue	Boolean	false
booleanAllowUndefined	Boolean	false
numberDefaultValue	BigDecimal	false
numberMinValue	BigDecimal	false
numberMaxValue	BigDecimal	false
stringDefaultValue	String	false
stringMinLength	String	false
stringMaxLength	String	false
stringRegExp	String	false
dateMinValue	LocalDate	false
dateMaxValue	LocalDate	false
dateDefaultValue	LocalDate	false
dateSystemLimit	Boolean	false
selectDefaultValue	Integer	false
selectEntityName	String	false
selectParams	String	false
selectSetId	Boolean	false
selectName	String	false
multiSelectDefaultValue	Integer	false
multiSelectEntityName	String	false
multiSelectParams	String	false
multiSelectSetId	Boolean	false
multiSelectName	Integer	false

Example response

{
	"count": 5,
	"offset": 0,
	"limit": 10,
	"list": [{
			"id": 1,
			"code": "SMOKER",
			"name": "Smoker",
			"label": "Smoker",
			"required": true,
			"booleanDefaultValue": null,
			"booleanAllowUndefined": false,
			"numberDefaultValue": null,
			"numberMinValue": null,
			"numberMaxValue": null,
			"stringDefaultValue": null,
			"stringMinLength": null,
			"stringMaxLength": null,
			"stringRegExp": null,
			"dateDefaultValue": null,
			"dateSystemLimit": null,
			"dateMinValue": null,
			"dateMaxValue": null,
			"selectDefaultValue": null,
			"selectEntityName": null,
			"selectParams": null,
			"selectSetId": null,
			"selectName": null,
			"multiSelectDefaultValue": null,
			"multiSelectEntityName": null,
			"multiSelectParams": null,
			"multiSelectSetId": null,
			"multiSelectName": null
		},
		{
			"id": 2,
			"code": "PET",
			"name": "Pet",
			"label": "Pet",
			"required": false,
			"booleanDefaultValue": null,
			"booleanAllowUndefined": true,
			"numberDefaultValue": null,
			"numberMinValue": null,
			"numberMaxValue": null,
			"stringDefaultValue": null,
			"stringMinLength": null,
			"stringMaxLength": null,
			"stringRegExp": null,
			"dateDefaultValue": null,
			"dateSystemLimit": null,
			"dateMinValue": null,
			"dateMaxValue": null,
			"selectDefaultValue": null,
			"selectEntityName": null,
			"selectParams": null,
			"selectSetId": null,
			"selectName": null,
			"multiSelectDefaultValue": null,
			"multiSelectEntityName": null,
			"multiSelectParams": null,
			"multiSelectSetId": null,
			"multiSelectName": null
		},
		{
			"id": 3,
			"code": "DISABILITYPERCENTAGE",
			"name": "DisabilityPercentage",
			"label": "Disability Percentage",
			"required": false,
			"booleanDefaultValue": null,
			"booleanAllowUndefined": null,
			"numberDefaultValue": 0.000000,
			"numberMinValue": 0.000000,
			"numberMaxValue": 100.000000,
			"stringDefaultValue": null,
			"stringMinLength": null,
			"stringMaxLength": null,
			"stringRegExp": null,
			"dateDefaultValue": null,
			"dateSystemLimit": null,
			"dateMinValue": null,
			"dateMaxValue": null,
			"selectDefaultValue": null,
			"selectEntityName": null,
			"selectParams": null,
			"selectSetId": null,
			"selectName": null,
			"multiSelectDefaultValue": null,
			"multiSelectEntityName": null,
			"multiSelectParams": null,
			"multiSelectSetId": null,
			"multiSelectName": null
		},
		{
			"id": 4,
			"code": "HOBBIES",
			"name": "Hobbies",
			"label": "Hobbies",
			"required": false,
			"booleanDefaultValue": null,
			"booleanAllowUndefined": null,
			"numberDefaultValue": null,
			"numberMinValue": null,
			"numberMaxValue": null,
			"stringDefaultValue": null,
			"stringMinLength": null,
			"stringMaxLength": null,
			"stringRegExp": null,
			"dateDefaultValue": null,
			"dateSystemLimit": null,
			"dateMinValue": null,
			"dateMaxValue": null,
			"selectDefaultValue": null,
			"selectEntityName": null,
			"selectParams": null,
			"selectSetId": null,
			"selectName": null,
			"multiSelectDefaultValue": null,
			"multiSelectEntityName": null,
			"multiSelectParams": null,
			"multiSelectSetId": null,
			"multiSelectName": null
		},
		{
			"id": 5,
			"code": "NATIONAL",
			"name": "National",
			"label": "National",
			"required": false,
			"booleanDefaultValue": null,
			"booleanAllowUndefined": false,
			"numberDefaultValue": null,
			"numberMinValue": null,
			"numberMaxValue": null,
			"stringDefaultValue": null,
			"stringMinLength": null,
			"stringMaxLength": null,
			"stringRegExp": null,
			"dateDefaultValue": null,
			"dateSystemLimit": null,
			"dateMinValue": null,
			"dateMaxValue": null,
			"selectDefaultValue": null,
			"selectEntityName": null,
			"selectParams": null,
			"selectSetId": null,
			"selectName": null,
			"multiSelectDefaultValue": null,
			"multiSelectEntityName": null,
			"multiSelectParams": null,
			"multiSelectSetId": null,
			"multiSelectName": null
		}
	]
}

Browser not supported