Difference between revisions of "Web service API"
Jump to navigation
Jump to search
(Created page with "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 = == Lo...") |
|||
| Line 22: | Line 22: | ||
== Get Objects == | == Get Objects == | ||
'''GET''' /objects | '''GET''' /objects | ||
'''GET''' /objects?''filter'' | '''GET''' /objects?''filter'' | ||
Get all objects visible to logged in user. Optional filter can define additional criteria for object selection: | 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'' | name=''pattern'' | ||
== Get Specific Object == | |||
'''GET''' /objects/''id'' | |||
Revision as of 12:02, 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
Get Specific Object
GET /objects/id