Features
- Last UpdatedOct 05, 2022
- 2 minute read
APIs for managing the feature states of a Tenant.
List All
Returns all FeatureStates for the specified Tenant.
Request
GET /api/v1/Tenants/{tenantId}/Features
Parameters
string tenantId
The identifier of the Tenant.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | FeatureState[] | An array of all Features for the tenant with identifier tenantId. |
| 403 | None | Forbidden. |
| 404 | None | Could not retrieve the specified FeatureStates due to missing or invalid data. |
Example response body
200 Response
[
{
"Feature": {
"Id": "95c2b5fe-355d-4b33-a748-b738707e0648",
"Name": "Feature1",
"Description": "Feature Description"
},
"CurrentState": 1
},
{
"Feature": {
"Id": "95c2b5fe-355d-4b33-a748-b738707e0648",
"Name": "Feature2",
"Description": "Feature Description"
},
"CurrentState": 0
}
]
Authorization
Allowed for these roles:
- Tenant Member
Get
Returns a FeatureState with the specified identifier from a Tenant.
Request
GET /api/v1/Tenants/{tenantId}/Features/{id}
Parameters
string tenantId
The identifier of the Tenant.string id
The identifier of the FeatureState.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | FeatureState | The state of the Feature for the tenant with identifier tenantId. |
| 404 | None | Could not retrieve the specified FeatureState due to missing or invalid input. |
Example response body
200 Response
{
"Feature": {
"Id": "95c2b5fe-355d-4b33-a748-b738707e0648",
"Name": "Feature1",
"Description": "Feature Description"
},
"CurrentState": 1
}
Authorization
Allowed for these roles:
- Tenant Member
Definitions
FeatureState
Representation of a server-side database interpretation of a feature state.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Feature | Feature | false | true | Gets or sets the feature. |
| CurrentState | int32 | false | false | Gets or sets the current state of the feature. |
{
"Feature": {
"Id": "string",
"Name": "string",
"Description": "string",
"DefaultState": 0
},
"CurrentState": 0
}
Feature
Representation of a server-side database interpretation of a feature.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | string | false | true | Gets or sets the identifier. |
| Name | string | false | true | Gets or sets the name. |
| Description | string | false | true | Gets or sets the description. |
| DefaultState | int32 | false | false | Gets or sets the default state. |
{
"Id": "string",
"Name": "string",
"Description": "string",
"DefaultState": 0
}