Documentation is now available for the Fall 2020 Update release!

Update resource notes

This endpoint is used to update a resource note.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/resources/{resourceId}/notes/{noteId}

Sample URLs

https://{api-url}/api/v2/tenants/client_7/resources/1a08b17a-85e4-4615-8b49-061f5ad1a1b9/notes/50

Parameters

FieldData TypeDescription
subjectString(Optional) Subject of the resource note.
descriptionString(Optional) Description of the resource note.
expiryDateTypeString(Optional) Type of expiry. Supported Values: Never Expire, Validity Period
  • expiryDateType=1 denotes never expire.
  • expiryDateType=2 to create resource note with a validity period.
  • expiryDateType=3 denotes expire now
Both startTime and endTime are necessary to define a note validity period.
startTimeString(Optional) Start time of resource note.
expiryTimeString(Optional) Expiry time of resource note.

Sample requests

A sample request with expiryDateType = 1:

{
	"subject": "Device created for maintain logs-updated",
	"description": "The Device is for auditing purpose only-updated",
	"expiryDateType": "1"
}

A sample request with expiryDateType = 2:

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

A sample request with expiryDateType = 3:

{
	"subject": "Device created for maintain logs-updated",
	"description": "The Device is for auditing purpose only-updated",
	"expiryDateType": "3"
}

Sample response

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