Difference between revisions of "Web service API"
Jump to navigation
Jump to search
| Line 32: | Line 32: | ||
name=''pattern'' | name=''pattern'' | ||
'''Examples:''' | |||
Get all objects with name starting with "T": | |||
GET /objects?name=T* | |||
Get all nodes around Riga: | |||
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025 | |||
Get all nodes and containers: | |||
GET /objects?class=container,node | |||
== Get Specific Object == | == Get Specific Object == | ||
'''GET''' /objects/''id'' | '''GET''' /objects/''id'' | ||
Revision as of 12:04, 21 February 2017
Web service API provides access to NetXMS via HTTP/HTTPS. API calls are REST-like (although not purely RESTful) and uses JSON for data exchange.
Session Management
Login
POST /sessions
Create new session. Input object fields:
login password
On success server will set cookie session_handle which should be passed on each subsequent request.
Logout
DELETE /session/sid
Logout (delete session) with given session ID.
Object Management
Get Objects
GET /objects GET /objects?filter
Get all objects visible to logged in user. Optional filter can define additional criteria for object selection:
area=geographical_area
class=class_list
name=pattern
Examples:
Get all objects with name starting with "T":
GET /objects?name=T*
Get all nodes around Riga:
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025
Get all nodes and containers:
GET /objects?class=container,node
Get Specific Object
GET /objects/id