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

Describes the client ID of the tenant

resourceId
string

noteId
string

createdBy
object

createdBy.changePassword
createdBy.email
createdBy.firstName
createdBy.id
createdBy.lastName
createdBy.loginName
createdBy.phoneNumber
createdTime
string

description
string

Description of the resource note.

expiryDateType
integer

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.

expiryTime
string

Expiry time of resource note.

id
integer

startTime
string

Start time of resource note.

subject
string

Subject of the resource note.

updatedTime
string

{
  "description": "The Device is for auditing purpose only-updated",
  "expiryDateType": 1,
  "subject": "Device created for maintain logs-updated"
}
{
  "description": "The Device is for auditing purpose only-updated",
  "expiryDateType": 2,
  "expiryTime": "2016-04-26T10:10:10+0000",
  "startTime": "2016-03-26T10:10:10+0000",
  "subject": "Device created for maintain logs-updated"
}
{
  "description": "The Device is for auditing purpose only-updated",
  "expiryDateType": 3,
  "subject": "Device created for maintain logs-updated"
}

Responses

OK

createdBy
object

createdBy.changePassword
createdBy.email
createdBy.firstName
createdBy.id
createdBy.lastName
createdBy.loginName
createdBy.phoneNumber
createdTime
string

description
string

Description of the resource note.

expiryDateType
integer

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.

expiryTime
string

Expiry time of resource note.

id
integer

startTime
string

Start time of resource note.

subject
string

Subject of the resource note.

updatedTime
string

{
  "createdBy": {
    "changePassword": false,
    "email": "john.smith@opsramp.com",
    "firstName": "John",
    "id": "USR0000002095",
    "lastName": "Smith",
    "loginName": "John.Smith"
  },
  "createdTime": "2016-03-21T12:02:11+0000",
  "description": "The Device is for auditing purpose only-updated",
  "expiryTime": "2016-04-26T15:40:10+0000",
  "id": 50,
  "startTime": "2016-03-26T15:40:10+0000",
  "subject": "Device created for maintain logs-updated",
  "updatedTime": "2016-03-21T12:06:26+0000"
}