Gets context field
GET <your-unleash-url>/api/admin/context/:contextField
Authorization
name: Authorizationtype: apiKeyin: header
Returns specific context field identified by the name in the path
Request
Path Parameters
- contextField string required
Responses
- 200
contextFieldSchema
- 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[]
{
"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"
}
]
}
Authorization
name: Authorizationtype: apiKeyin: header
Request
Request
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
python / requests
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
go / native
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
nodejs / axios
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ruby / Net::HTTP
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
csharp / RestSharp
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
php / cURL
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
java / OkHttp
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
powershell / RestMethod
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'