Gets configured context fields

GET 
/api/admin/context

Returns all configured Context fields that have been created.

Responses

200

contextFieldsSchema

application/json

Schema

Schema

• Array [

name stringrequired
The name of the context field
Example: userId
description stringnullable
The description of the context field.
Example: Used to uniquely identify users
stickiness boolean
Does this context field support being used for stickiness calculations
Example: true
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.
Example: 900
createdAt date-timenullable
When this context field was created
Example: 2023-06-29T10:19:00.000Z
usedInFeatures integernullable
Number of projects where this context field is used in
Example: 3
usedInProjects integernullable
Number of projects where this context field is used in
Example: 2

legalValues

object[]

Allowed values for this context field schema. Can be used to narrow down accepted input

Array [

value stringrequired

The valid value

Example: #c154c1

description string

Describes this specific legal value

Example: Deep fuchsia

]

• ]

Example (from schema)

[
  {
    "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"
      }
    ]
  }
]

Loading...