Description
The following REST API requests can be used to debug, get more information from, or send a custom value to a G-MapServer (also referred to as G-Map Server). All requests in this article use the POST method type.
In This Article
getFromGroup
Use this request to get a value for the key from a G-MapServer group.
REST Request
REST API URL:
http://<gmapIP>:<gmapPort>/rest/getFromGroup
Use this API JSON request payload when making an API call to the GenRocket G-Map Server.
{
"groupName": "",
"key": ""
}
REST Example
{
"groupName": "user.ssn", // namespace.attributeName
"key": "350"
}
getManyFromGroup
REST Request
REST API URL:
http://<gmapIP>:<gmapPort>/rest/getManyFromGroup
Use this API JSON request payload when making an API call to the GenRocket G-Map Server.
{
"groupName": "",
"data": ""
}
{
"groupName": "user.ssn",
"data": ["350", "351", "352"]
}
getNamespaces
Use this request to get namespaces from G-MapServer.
REST Request
REST API URL:
http://<gmapIP>:<gmapPort>/rest/getNamespaces
No request payload is required for this REST API request.
resetCache
REST Request
REST API URL:
http://<gmapIP>:<gmapPort>/rest/resetCache
No request payload is required for this REST API request.
putInGroup
Use this request to send a custom value to the G-Map Server via a REST API call.
REST Request
REST API URL:
http://<gmapIP>:<gmapPort>/rest/putInGroup
Use this API JSON request payload when making an API call to the GenRocket G-Map Server.
{
"data": [{
"groupName": " ",
"key": " ",
"value": " "
}]
}
{
"data": [{
"groupName": "myNamespace.myGroup",
"key": "1",
"value": "test"
}]
}