Traffic Lights Configuration
Check out chapters Get Field Id, Get field configuration context Id, and Create/Update field configuration (options) in order to find out how to use endpoint properly. All endpoints used in the article Singe/Multiple select pickers with create are also used for this custom field, only provided data in the body of Create/Update API is different.
In order to make this request successful, body should follow this scheme and it’s property names:
`{
configurations: [
{
configuration: {
traffic: [
{
id: "red",
description: "...",
},
{
id: "yellow",
description: "...",
},
{
id: "green",
description: "...",
},
]
},
contextId: "<Unique Id>"
}
]
}`
The property description
is used to display tooltip description on field hover and id
must hold values red
, yellow,
and green
, otherwise, it can lead to unexpected behavior of the custom field.
To make this request properly 3 objects must be passed in traffic
array.