Module schemes_api

Enums

CreateSchemeError

struct for typed errors of method create_scheme

DeleteSchemeError

struct for typed errors of method delete_scheme

GetChannelsForSchemeError

struct for typed errors of method get_channels_for_scheme

GetSchemeError

struct for typed errors of method get_scheme

GetSchemesError

struct for typed errors of method get_schemes

GetTeamsForSchemeError

struct for typed errors of method get_teams_for_scheme

PatchSchemeError

struct for typed errors of method patch_scheme

Functions

create_scheme

Create a new scheme. ##### Permissions Must have manage_system permission. Minimum server version: 5.0

delete_scheme

Soft deletes a scheme, by marking the scheme as deleted in the database. ##### Permissions Must have manage_system permission. Minimum server version: 5.0

get_channels_for_scheme

Get a page of channels which use this scheme. The provided Scheme ID should be for a Channel-scoped Scheme. Use the query parameters to modify the behaviour of this endpoint. ##### Permissions manage_system permission is required. Minimum server version: 5.0

get_scheme

Get a scheme from the provided scheme id. ##### Permissions Must have manage_system permission. Minimum server version: 5.0

get_schemes

Get a page of schemes. Use the query parameters to modify the behaviour of this endpoint. ##### Permissions Must have manage_system permission. Minimum server version: 5.0

get_teams_for_scheme

Get a page of teams which use this scheme. The provided Scheme ID should be for a Team-scoped Scheme. Use the query parameters to modify the behaviour of this endpoint. ##### Permissions manage_system permission is required. Minimum server version: 5.0

patch_scheme

Partially update a scheme by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions manage_system permission is required. Minimum server version: 5.0