Documentation is now available for the Fall 2020 Update release!

Create resource notes

This endpoint is used to create a resource note.

Leave Feedback

URL

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

Sample URLs

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

Parameters

All fields are mandatory:

FieldData TypeDescription
subjectStringSubject of the resource note.
descriptionStringDescription of the resource note.
expiryDateTypeStringType 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.
startTimeStringStart time of resource note.
expiryTimeStringExpiry 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"
}

Sample response

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