Setting API Reference

Setting and Plugins Management Service

Account Settings

Manage account settings for user preferences and configurations,
including retrieval and updating of settings.

get /account_settings/{resource_id} - show

Description

Show a specific setting:account_settings

Parameters

Name	In	Type	Required	Description
resource_id	path	string	Required	-
included	query	array	Optional	-
fields	query	string	Optional	-

Response

200

Successful response


                                                  export interface Response {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      account_id?: number;
      key?: string;
      plugin?: string;
      value?:
        | {
            [k: string]: unknown;
          }
        | unknown[]
        | string
        | number
        | boolean
        | null;
    };
    relationships?: {
      [k: string]: unknown;
    };
  };
  included?: {
    [k: string]: unknown;
  }[];
}

patch /account_settings/{resource_id} - update

Description

Update a setting:account_settings

Parameters

Name	In	Type	Required	Description
resource_id	path	string	Required	-

Request Body


                                            export interface RequestBody {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      account_id?: number;
      value?:
        | {
            [k: string]: unknown;
          }
        | unknown[]
        | string
        | number
        | boolean
        | null;
    };
  };
}

Response

200

Successful response


                                                  export interface Response {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      account_id?: number;
      key?: string;
      plugin?: string;
      value?:
        | {
            [k: string]: unknown;
          }
        | unknown[]
        | string
        | number
        | boolean
        | null;
    };
    relationships?: {
      [k: string]: unknown;
    };
  };
  included?: {
    [k: string]: unknown;
  }[];
}

get /account_settings - index

Description

Return a paginated list of setting:account_settings

Parameters

Name	In	Type	Required	Description
page[number]	query	integer	Optional	The page number, default to 1
page[size]	query	integer	Optional	The number of items per page, default to 1000
sort	query	string	Optional	The sort order, comma separated list of fields. See sorting section for more details
count	query	boolean	Optional	Set to true to return the total number of items in the collection
filter[id]	query	any	Optional	-
filter[account_id]	query	any	Optional	-
filter[key]	query	any	Optional	-
filter[plugin]	query	any	Optional	-
filter[value]	query	any	Optional	-
filter[account_id]	query	any	Optional	-
filter[key]	query	any	Optional	-
fields	query	string	Optional	The fields to include in the response. The key is the resource type and the value is an array of fields.

Response

200

Successful response


                                                  export interface Response {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      account_id?: number;
      key?: string;
      plugin?: string;
      value?:
        | {
            [k: string]: unknown;
          }
        | unknown[]
        | string
        | number
        | boolean
        | null;
    };
    relationships?: {
      [k: string]: unknown;
    };
  }[];
  included?: {
    [k: string]: unknown;
  }[];
}

Plugins

Manage and serve plugins within the system, including
listing available modalities, retrieving modality details,
and serving plugin assets and files.

get /plugins/modalities - modalities

Response

200

Successful response


                                                  export interface Response {
  data: {
    /**
     * Mapping of modality IDs to their details
     */
    modalities: {
      [k: string]: unknown;
    };
    /**
     * Mapping of modality IDs to plugin names
     */
    plugins: {
      [k: string]: unknown;
    };
  };
}

get /plugins/modalities/{modality_name} - show_modality

Parameters

Name	In	Type	Required	Description
modality_name	path	string	Required	-

Response

200

Successful response


                                                  export interface Response {
  data: {
    /**
     * Mapping of shape names to their details
     */
    shapes: {
      [k: string]: unknown;
    };
  };
}

get /plugins/{plugin}/assets/* - serve_asset

Parameters

Name	In	Type	Required	Description
plugin	path	string	Required	-
splat	query	array	Required	-

Response

204

No content

get /plugins/{plugin}/files/{filename} - serve

Parameters

Name	In	Type	Required	Description
plugin	path	string	Required	-
filename	path	string	Required	-

Response

204

No content