Config

Retrieve a Module

Work with Modules.Retrieves the Module with the given name.

get/admin/config/modules/{name}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/config/modules/{name}
  • Auth: HTTP basic

Path parameters

namestring required

The name of the desired Module.

Response

namestring required

Name

titlestring required

Title

rootstring required

Root. Values: 'controllers\admin\CustomersController', 'controllers\admin\FinanceController' and 'controllers\admin\NetworkingController'

typestring required

Type. Values: 'simple' or 'extended'

modulestring required

Module name

iconstring

Icon

title_attribute_prefixstring

Title attribute prefix

title_attribute_suffixstring

Title attribute suffix

statusnumber

Status. Values: 0 or 1

Example response

{
  "name": "access_points",
  "title": "AP",
  "root": "controllers\\admin\\NetworkingController",
  "type": "simple",
  "module": "splynx_access_points",
  "icon": "icon-wifi",
  "title_attribute_prefix": "splynx_access_points_",
  "title_attribute_suffix": "_title",
  "status": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.