Virima API Specification - MenuService Services

The requests documented in this section are directed to MenuService resources, which represent .

Contents

1 getMenuItem GET Interface
2 getTemplate POST Interface

getMenuItem GET Interface

Method: GET

Relative URL: menu/get

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
menu	Menu

Example Request:

Example Response:

{
   "id":242830065,
   "isShowQuickScan":?,
   "items":[
      {
         "id":2147483647,
         "module":"?",
         "name":"?",
         "url":"?",
         "implemented":?,
         "subscribed":?,
         "items":[
            {
               "id":2147483647,
               "module":"?",
               "name":"?",
               "url":"?",
               "implemented":?,
               "subscribed":?,
            }         ]
      }   ]
}

getTemplate POST Interface

Method: POST

Relative URL: menu/get-template

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
browserURL	URLString

Response Structure:

Field Name	Type	Description
urlObjs	ListOfURLObject

Example Request:

GETTEMPLATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "url":"?"
}

Example Response:

{
   "id":2147483647,
   "urlObjects":[
      {
         "id":1150503815,
         "menuitem":"?",
         "entity":"?",
         "module":"?",
         "type":"?",
         "serviceType":"?",
         "service":"?",
         "template":"?",
         "defaultFilter":"?",
         "name":"?",
         "className":"?",
         "dbClassName":"?",
         "title":"?",
         "dashBoard":"?",
         "templateMapping":[
            {
               "id":2147483647,
               "key":"?",
               "value":"?",
               "type":"?",
               "possibleValue":"?",
               "url":"?",
               "width":"?",
               "row":?,
               "column":?,
               "label":"?",
               "dbProperty":"?",
               "dbPropertyType":"?",
               "loadType":"?",
               "helpText":"?",
               "toolTip":"?",
               "hide":"?",
               "linkTo":"?",
               "mandatory":"?",
               "dependsOn":"?",
               "dependencies":"?",
               "dependTo":"?",
               "addNewItem":"?",
               "module":"?",
               "mapProperty":?
            }         ],
         "filterList":[
            {
               "id":2147483647,
               "key":"?",
               "value":"?",
               "type":"?",
               "possibleValue":"?",
               "url":"?",
               "width":"?",
               "row":?,
               "column":?,
               "label":"?",
               "dbProperty":"?",
               "dbPropertyType":"?",
               "loadType":"?",
               "helpText":"?",
               "toolTip":"?",
               "hide":"?",
               "linkTo":"?",
               "mandatory":"?",
               "dependsOn":"?",
               "dependencies":"?",
               "dependTo":"?",
               "addNewItem":"?",
               "module":"?",
               "mapProperty":?
            }         ]
      }   ]
}