/webconsole - ui-theme

Rest API Documentation

REST API Documentation for Group ui-theme, application /webconsole Version: 4.2.1.3

Endpoints (DRAFT)

POST /rest/api/uiTheme/delete

UI Theme management API Doc, Delete UI Theme

Query Params:

  • id [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/BasicAjaxResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/uiTheme/get/(themeId)

UI Theme management API Doc, Get UI Theme by Id

Path Params:

  • themeId [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/UITheme

  • Status Code: 500 Failure.

    Content-type: application/json

POST /rest/api/uiTheme/save

UI Theme management API Doc, Save UI Theme

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/BasicAjaxResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/uiTheme/(uiThemeId)/client-resource/(clientResourceType)

UI Theme management API Doc, Delete client resource to given UI theme

Path Params:

  • clientResourceType [{'type': 'string', 'enum': ['BIG_LOGO', 'SMALL_LOGO', 'FAVICO_16X16', 'FAVICO_32X32', 'FAVICO_57X57', 'FAVICO_60X60', 'FAVICO_72X72', 'FAVICO_76X76', 'FAVICO_96X96', 'FAVICO_114X114', 'FAVICO_120X120', 'FAVICO_144X144', 'FAVICO_152X152', 'FAVICO_180X180', 'FAVICO_192X192']}]:
  • uiThemeId [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/BasicAjaxResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/uiTheme/(uiThemeId)/client-resource/(clientResourceType)/upload

UI Theme management API Doc, Upload client resource to given UI theme

Query Params:

  • replicate [{'type': 'boolean'}]:

Path Params:

  • uiThemeId [{'type': 'string'}]:

  • clientResourceType [{'type': 'string', 'enum': ['BIG_LOGO', 'SMALL_LOGO', 'FAVICO_16X16', 'FAVICO_32X32', 'FAVICO_57X57', 'FAVICO_60X60', 'FAVICO_72X72', 'FAVICO_76X76', 'FAVICO_96X96', 'FAVICO_114X114', 'FAVICO_120X120', 'FAVICO_144X144', 'FAVICO_152X152', 'FAVICO_180X180', 'FAVICO_192X192']}]: Body Params:

  • {'content': {'application/json': {'schema': {'type': 'object', 'properties': {'pic': {'type': 'string', 'format': 'binary'}}}}}} Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/BasicAjaxResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/BasicAjaxResponse## Definitions