/api/notes
The following resources are applicable:
/note
POST
This method is used to add notes on any network object such as Interfaces, LSPs, Nodes,
Demands, Interface Queues, Custom tables. Notes are associated by a user and creation time.
JSON Example
{
"objectType": "Interfaces",
"keyAttributes" : [
{
"name" : "name",
"value" : "TenGigE0/0/1"
},
{
"name" : "node",
"value" : "AM_ATL_ER2"
}
],
"note": "notes-1"
}
Request Body
| element: | json |
| media types: | text/plain application/json |
(no documentation provided)
Response Body
| element: | noteDefinition |
| media types: | */* application/xml |
id of the newly created note
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the requested operation was successful |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
/note/{noteId}
DELETE
This method is used to remove notes on a given network object.
Only note owner or user with 'administrator' role has access to this method.
URL Example:
/matelive/api/note/{noteId}
Parameters
| name | description | type | default |
|---|---|---|---|
| noteId | id of the note, dataType=long | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
output result of the operation
Status Codes
| HTTP Status Code | Description |
|---|---|
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
/note/{objectInfo}
GET
This method is used to fetch notes history for a given network object.
Each network object is identified by keys, which has a name and corresponding value associated with it.
For Example, Interface has "node" and "name" attribute defined as keys.
URL Example:
/matelive/api/note/Interfaces?node=ACSS-BA-MAN-SWTL3-01&name=GigabitEthernet3/1
Sample JSON output
{
"id":101,
"note":"notes",
"user":"admin",
"createTimestamp":"2014-09-26 23:42:13"
}
Parameters
| name | description | type | default |
|---|---|---|---|
| objectInfo | object name and its key attributes | path |
Response Body
| element: | notesHistory |
| media types: | text/plain application/json |
output is a string representation of notes history information
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the requested operation was successful |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
/note/inactivate/{noteId}
PUT
This method is used to inactivate notes on a given network object.
URL Example:
/matelive/api/note/inactivate/{noteId}/false
Parameters
| name | description | type | default |
|---|---|---|---|
| noteId | id of the note, dataType=long | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
result of the operation
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the requested operation was successful |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
/note/latest/{objectInfo}
GET
This method is used to retrieve the latest note details on a given network object.
Each network object is identified by its keys which have a name and corresponding value associated with it.
For Example, Interface has "node" and "name" attribute defined as keys.
URL Example:
/matelive/api/note/latest/Interfaces?node=ACSS-BA-MAN-SWTL3-01&name=GigabitEthernet3/1
Sample JSON output
{
"notesInfos":[
{
"id":101,
"note":"notes-1",
"user":"admin",
"createTimestamp":"2014-09-26 23:38:21"
}
,
{
"id":102,
"note":"notes-2",
"user":"admin",
"createTimestamp":"2014-09-26 23:42:08"
}
,
{
"id":103,
"note":"notes-3",
"user":"admin",
"createTimestamp":"2014-09-26 23:42:13"
}]
}
Parameters
| name | description | type | default |
|---|---|---|---|
| objectInfo | object name and its key attributes | path |
Response Body
| element: | notesInfo |
| media types: | text/plain application/json |
output is a string representation of recent note details
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the requested operation was successful |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |