Skip to main content
API docs by Redocly

feature-configuration (0.1)

Download OpenAPI specification:Download

This API provides the ability to manage Features (enabling/disabling functionality) and Settings (configuration of how features work)

See our getting started guide for more detailed information on how to use our APIs

features

Enabling and disabling features

List available features

List all available features and their current status

query Parameters
page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

page_size
integer [ 0 .. 150 ]
Default: 150

The number of results to display per response page. The default is the maximum.

name
string

the name of the resource to filter

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Enable and disable features for your organization

Enable and disable features for your organization. Features which are not included within the request will not be affected. An error will be returned if an organization admin attempts to enable a feature which is not marked as self-service. Features marked as not self-service can always be disabled by an organization admin if they have been enabled.

Request Body schema: application/json
required

The list of features to enable or disable

Array
One of
name
required
string

The unique name for the feature

enable
required
boolean

Whether or not the feature should be enabled.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Get a feature by its id

Get a feature by its id

path Parameters
id
required
string <uuid>

the id of the resource

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "enabled": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "roles": [
    ],
  • "self_service": true
}

settings

Management of settings for features

List your settings

List all settings applicable to your profile. The default behavior will show all settings regardless of whether their value has been overridden or not. User configurations will supersede configurations from both Organization and Model-Prime. Configurations from Organizations supersede the default Model-Prime configurations. Specifying ?user=true will return only settings which have been overridden by you. Specifying ?organization=true will return only settings which have been configured by the organization. Specifying ?organization=true&user=true will return only settings which your organization has configured, and which you have overridden, thus leaving out any settings which are either the default value, or which you have overridden, but which the organization has not configured.

query Parameters
page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

page_size
integer [ 0 .. 150 ]
Default: 150

The number of results to display per response page. The default is the maximum.

organization
boolean

Whether or not to include organization default level settings

user
boolean

Whether or not to include user level settings

feature
string

the name of the feature by which to filter

name
string

the name of the resource to filter

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Update settings for your profile

Update settings for your profile. All affected settings with their new values will be returned. Any specified setting which is set to null will be reset back to the value configured by your organization, or provided by Model-Prime if the setting is either not configured. If organization=true is specified, and you have permission, then the changes will affect the entire organization.

query Parameters
organization
boolean

Whether or not a setting should be handled at the organization level.

Request Body schema: application/json
required

The updated settings data. Any omitted fields are unchanged from their current value.

Array
name
required
string

The unique name for the setting

value
required
any

The value of the setting

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Reset a setting back to the default value

Reset a setting back to the default value as set by the organization, returning the new value. If organization=true, and you have permission to affect organization wide settings, then the value will be reset back to the Model-Prime default.

path Parameters
id
required
string <uuid>

the id of the resource

query Parameters
organization
boolean

Whether or not a setting should be handled at the organization level.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "features": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inherited": true,
  • "name": "string",
  • "value": null
}

Get a setting by its id

Get a setting by its id. If organization=true then the value of the returned setting will be the value configured for your organization, ignoring any override which has been performed on your account.

path Parameters
id
required
string <uuid>

the id of the resource

query Parameters
organization
boolean

Whether or not a setting should be handled at the organization level.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "features": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inherited": true,
  • "name": "string",
  • "value": null
}

Update a setting

Update a setting. If organization=true, and you have permission to affect organization wide settings, then the changes will affect the entire organization.

path Parameters
id
required
string <uuid>

the id of the resource

query Parameters
organization
boolean

Whether or not a setting should be handled at the organization level.

Request Body schema: application/json
required

The updated settings data. Any omitted fields will be left unchanged.

value
required
any

The value of the setting

Responses

Request samples

Content type
application/json
{
  • "value": null
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}