Documentation is now available for the Fall 2020 Update release!

Search resource notes

This endpoint is used to search for resource notes.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/resources/{resourceId}/notes/search

Sample URLs

https://{api-url}/api/v2/tenants/client_7/resources/DEV0000015401/notes/search?pageNo=2&pageSize=3&queryString=startUpdationDate:2015-11-01T11:49:21 0000+endUpdationDate:2015-11-20T11:49:21 0000

Parameters

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}note.id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariablesDescription
searchWordSearch with a unique word provided in the resource note.
startCreationDateSearch for the resource note created within a duration.startCreationDate indicates the from date.
endCreationDateSearch for the resource note created within a duration.endCreationDate indicates the to date.
startUpdationDateSearch for the resource note created within a duration.startUpdationDate indicates the from date.
endUpdationDateSearch for the resource note created within a duration.endUpdationDate indicates the to date.
idResource ID

Sample response

{
	"results": [{
			"id": 49,
			"subject": "notes testing with resource-1",
			"description": "testing notes",
			"createdTime": "2016-03-21T11:46:03+0000",
			"updatedTime": "2016-03-21T11:46:03+0000",
			"startTime": "2016-03-22T15:40:10+0000",
			"expiryTime": "2016-03-24T15:40:10+0000",
			"createdBy": {
				"id": "USR0000000001",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "Super",
				"email": "sarma519@gmail.com",
				"changePassword": false
			}
		},
		{
			"id": 48,
			"subject": "notes testing with resource",
			"description": "testing notes",
			"createdTime": "2016-03-21T11:45:12+0000",
			"updatedTime": "2016-03-21T11:45:12+0000",
			"startTime": "2016-03-22T15:40:10+0000",
			"expiryTime": "2016-03-24T15:41:10+0000",
			"createdBy": {
				"id": "USR0000000001",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "Super",
				"email": "sarma519@gmail.com",
				"changePassword": false
			}
		},
		{
			"id": 42,
			"subject": "Device Notes Test Case - testing",
			"description": "Testing please ignore 2-testing",
			"createdTime": "2016-03-21T08:06:43+0000",
			"updatedTime": "2016-03-21T08:06:43+0000",
			"startTime": "2016-03-22T15:40:10+0000",
			"expiryTime": "2016-03-24T15:41:10+0000",
			"createdBy": {
				"id": "USR0000002095",
				"loginName": "James.Hudson",
				"lastName": "Hudson",
				"firstName": "James",
				"email": "james.h@opsramp.com",
				"changePassword": false
			}
		}
	],
	"totalResults": 3,
	"orderBy": "note.id",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"nextPageNo": 0,
	"previousPageNo": 0,
	"descendingOrder": true
}