Endpoint
/api/v2/tenants/{tenantId}/resources/{resourceId}/notes
Path Parameters
tenantIdstring
resourceIdstring
createdByobject
Child Parameters
- createdBy.changePassword
- createdBy.email
- createdBy.firstName
- createdBy.id
- createdBy.lastName
- createdBy.loginName
- createdBy.phoneNumber
createdTimestring
descriptionstring
Description of the resource note.
expiryDateTypeinteger
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.
expiryTimestring
Expiry time of resource note.
idinteger
startTimestring
Start time of resource note.
subjectstring
Subject of the resource note.
updatedTimestring
{
"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": 1,
"subject": "Device created for maintain logs-updated"
}
Responses
OK
createdByobject
Child Parameters
- createdBy.changePassword
- createdBy.email
- createdBy.firstName
- createdBy.id
- createdBy.lastName
- createdBy.loginName
- createdBy.phoneNumber
createdTimestring
descriptionstring
Description of the resource note.
expiryDateTypeinteger
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.
expiryTimestring
Expiry time of resource note.
idinteger
startTimestring
Start time of resource note.
subjectstring
Subject of the resource note.
updatedTimestring
{
"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",
"expiryTime": "2016-04-25T15:40:10+0000",
"id": 50,
"startTime": "2016-03-25T15:40:10+0000",
"subject": "Device created for maintain logs",
"updatedTime": "2016-03-21T12:02:11+0000"
}