Add a Check Note: add_check_note
|
Service name: add_check_note |
|
|
URL |
https://SERVER/api/?apikey=yourAPItoken&service=add_check_note &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
|
Description |
Add a public/private note to a check based on the provided public_note and/or private_note value. |
|
Parameters |
|||||
|
Post Variable |
Description |
Type |
Required |
Options |
Default |
|
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
|
checkid |
The ID of the Check you want to clear. |
number |
yes |
0 |
0 |
|
private_note |
Technical (private) note |
string |
no |
0 |
0 |
|
public_note |
Client facing note |
string |
no |
0 |
0 |
|
Example Service Call =add_check_note |
|
https://SERVER/api/?apikey=yourAPItoken&service=add_check_note&checkid=CHECKID&private_note=PRIVATEMESSAGE&public_note=PUBLICMESSAGE |
|
Example Response |
|
<?xml version="1.0" ?> <result created="2009-10-01T15:29:38+01:00" host="server" status="OK"> <message><![CDATA[Note Added]]></message> </result> |
|
Fields Description |
|||
|
Field |
Type |
Can Be Empty |
Description |
|
checkid |
integer |
no |
The unique ID of the Check the note is added to |
| Example Associated Service Calls | ||
| Parameter | Call | URL Format |
| CheckID | list_checks |
https://SERVER/api/?apikey=yourAPItoken&service=list_checks&deviceid=DEVICEID |
| DeviceID | list_devices_at_client |
https://SERVER/api/?apikey=yourAPItoken&service=list_devices_at_client&clientid=CLIENTID&devicetype=server |
| list_servers |
https://SERVER/api/?apikey=yourAPItoken&service=list_servers&siteid=SITEID |
|
| list_workstations |
https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID |
|
| SiteID | list_sites | https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID |
| ClientID | list_clients | https://SERVER/api/?apikey=yourAPItoken&service=list_clients |