Create a context field
POST /api/admin/context
Endpoint that allows creation of custom context fields
Request
- application/json
Body
required
createContextFieldSchema
- description string
A description of the context field
- stickiness boolean
trueif this field should be available for use with custom stickiness, otherwisefalse - sortOrder integer
How this context field should be sorted if no other sort order is selected
legalValues object[]
A list of allowed values for this context field
Array [value string requiredThe valid value
description stringDescribes this specific legal value
]- name string required
The name of the context field.
- 201
The resource was successfully created.
Response Headers
location string
The location of the newly created resource.
- application/json
- Schema
- Example (from schema)
Schema
- name string required
The name of the context field
- description string nullable
The description of the context field.
- stickiness boolean
Does this context field support being used for stickiness calculations
- sortOrder integer
Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.
- createdAt date-time nullable
When this context field was created
- usedInFeatures integer nullable
Number of projects where this context field is used in
- usedInProjects integer nullable
Number of projects where this context field is used in
legalValues object[]
Allowed values for this context field schema. Can be used to narrow down accepted input
Array [value string requiredThe valid value
description stringDescribes this specific legal value
]
{
"name": "userId",
"description": "Used to uniquely identify users",
"stickiness": true,
"sortOrder": 900,
"createdAt": "2023-06-29T10:19:00.000Z",
"usedInFeatures": 3,
"usedInProjects": 2,
"legalValues": [
{
"value": "#c154c1",
"description": "Deep fuchsia"
}
]
}