Endpoint
/api/v2/tenants/{tenantId}/resources/{resourceId}/notes/search
Path Parameters
tenantId
string

Describes the client ID of the tenant

resourceId
string

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.createdBy
results.createdTime
results.description
Description of the resource note.
results.expiryDateType
Type of expiry. Supported Values: Never Expire, Validity Period: - expiryDateType=1 to create resource note that would never expire. - expiryDateType=2 to create resource note with a validity period. Both startTime and endTime are mandatory to create a note with a validity period.
results.expiryTime
Expiry time of resource note.
results.id
results.startTime
Start time of resource note.
results.subject
Subject of the resource note.
results.updatedTime
totalPages
integer

totalResults
integer

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