Reverse API - Detail

SUCCESSFUL

performs ResourceAPI-﹥Get operation to return the newly-created entry, thus will appear similar to a "Get" return:

{"success":1,"message":"Reverse API endpoint added","data":{"id":"1","name":"TestPoint2","type":"local","created_by":"user","last_modified":"2015-04-01 12:24:57","call":"http:\/\/www.test.com?api.php","presentation":null}}

ERROR

{"success":0, "message":"error message"}

name 

STRING

TestPoint2

The name of the rAPI object

type

STRING

local

The type of the rAPI object. Valid settings are 'local' and 'external'.

call

STRING

http://www.test.com?api.php&server={serverId}

The URL or the system path which is first decoded against a resource and then hit when this rAPI endpoint is invoked.

presentation

STRING

endpoint = function(data, outputDiv) {console.log(outputDiv);};

The Javascript code used to display this endpoint on a resource page.

SUCCESSFUL

An array of ReverseAPI objects:

{"id":"535","name":"Observium RAM Graph","type":"external","created_by":"user","last_modified":"2015-03-18 09:16:49","call":"http:\/\/observium.tcp0.com\/graph.php?height=200&width=265&type=device_ucd_memory&legend=no&username=api&password=password&device={observium-id}","presentation":"endpoint = function(data, outputDiv) {\n\n    outputDiv.css('font-family','Helvetica, Arial, sans-serif;');\n\n\toutputDiv.append(\"﹤div style='font-size:18;'﹥RAM Usage﹤\/div﹥\");\n\n\tif (data == \"\") {\n\t\toutputDiv.append(\"﹤div ﹥No data returned﹤\/div﹥\");\n\t\treturn;\n\t}\n\n\toutputDiv.append('﹤div style=\"margin-left:-18px;margin-top:-3px;\"﹥﹤img src=\"data:image\/png;base64,' + btoa(data) + '\" \/﹥﹤\/div﹥');\n};"}

ERROR

{"success":0, "message":"error message"}

id

INTEGER

The id of the rAPI objectSt

name

STRING

The name of the rAPI object

type

STRING

The type of the rAPI object

created_by

STRING

What user created the rAPI object

last_modified

DATETIME

When this rAPI object was last changed

call

STRING

The URL or the system path which is first decoded against a resource and then hit when this rAPI endpoint is invoked.

presentation

STRING

The Javascript code used to display this endpoint on a resource page.

id

INTEGER

535

The id of the rAPI objectSt

name

STRING

TestPoint2

The name of the rAPI object

type

STRING

external

The type of the rAPI object. Valid settings are 'local' and 'external'.

created_by

STRING

user

The user who created the rAPI object

SUCCESSFUL

{"success":1,"message":"Reverse API endpoint deleted"}

ERROR

{"success":0, "message":"error message"}

id

INTEGER

535

The id of the rAPI objectSt

name

STRING

TestPoint2

The name of the rAPI object

SUCCESSFUL

ResourceAPI-﹥Get updated object, thus will appear the same as a "Get" return:

{"id":"535","name":"Observium RAM Graph","type":"external","created_by":"user","last_modified":"2015-03-18 09:16:49","call":"http:\/\/observium.tcp0.com\/graph.php?height=200&width=265&type=device_ucd_memory&legend=no&username=api&password=password&device={observium-id}","presentation":"endpoint = function(data, outputDiv) {\n\n    outputDiv.css('font-family','Helvetica, Arial, sans-serif;');\n\n\toutputDiv.append(\"﹤div style='font-size:18;'﹥RAM Usage﹤\/div﹥\");\n\n\tif (data == \"\") {\n\t\toutputDiv.append(\"﹤div ﹥No data returned﹤\/div﹥\");\n\t\treturn;\n\t}\n\n\toutputDiv.append('﹤div style=\"margin-left:-18px;margin-top:-3px;\"﹥﹤img src=\"data:image\/png;base64,' + btoa(data) + '\" \/﹥﹤\/div﹥');\n};"}

ERROR

{"success":0, "message":"error message"}

id

INTEGER

535

The id of the rAPI objectSt

name

STRING

TestPoint2

The name of the rAPI object

type

STRING

external

The type of the rAPI object. Valid settings are 'local' and 'external'.

call

STRING

http://www.test.com?api.php&server={serverId}&action=12

The URL or the system path which is first decoded against a resource and then hit when this rAPI endpoint is invoked.

presentation

STRING

endpoint = function(data, outputDiv) {console.log(outputDiv);};

The Javascript code used to display this endpoint on a resource page.

SUCCESSFUL

The result of a rAPI call customized for the supplied resource

{“data”:”\u0017\u00fbD","presentation":"endpoint = function(data, outputDiv) {\n\n\toutputDiv.css('font-family','Helvetica, Arial, sans-serif;');\n\n\toutputDiv.append(\"﹤div style='font-size:18;'﹥Port Traffic﹤\/div﹥\");\n\n\tif (data == \"\") {\n\t\toutputDiv.append(\"﹤div﹥No data returned﹤\/div﹥\");\n\t\treturn;\n\t}\n\n\toutputDiv.append('﹤div style=\"margin-left:-15px;margin-top:-3px;\"﹥﹤img src=\"data:image\/png;base64,' + btoa(data) + '\" \/﹥﹤\/div﹥');\n};"}}

ERROR

{"success":0, "message":"error message"}

data

MIXED

The result of the reverse API call.  Could be binary data, could be JSON.

presentation

STRING

The presentation javascript which pairs with this rAPI call

id

INTEGER

537

The id of the rAPI objectSt

resource_id

INTEGER

2245

ID of the resource