Gets context field

GET /api/admin/context/:contextField

Returns specific context field identified by the name in the path

Request

Path Parameters

• contextField string required

Responses

• 200

---

contextFieldSchema

application/json

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 required

  The valid value

  description string

  Describes this specific legal value

  ]

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...