Skip to main content

List discovery fields

List discovery fields

Responses
200

Return the discovery fields a create can write, with the options of the select ones. This is where the fieldId and optionIds of a discovery create come from. Computed and aggregate fields are not listed: their value is owned by the pipeline.

Schema — OPTIONAL
fields object[]

The discovery fields a create can write. Computed and aggregate fields are not listed: their value is owned by the pipeline.

id string

Field ID

clientId string

Field client ID

name string

Field name

fieldType string

Possible values: [NUMERICAL, RATING, BOOLEAN, STRING, URL, SELECT_SINGLE, SELECT_MULTI]

Field type. It dictates what a create accepts for this field: a number for NUMERICAL, an integer for RATING, a boolean for BOOLEAN, a string for STRING and URL, and optionIds for SELECT_SINGLE and SELECT_MULTI.

min number

Lowest accepted value, when the field defines one

max number

Highest accepted value, when the field defines one

options object[]

Available options, for a SELECT_SINGLE or SELECT_MULTI field

id string

Option ID

clientId string

Option client ID

name string

Option name