topic To add an annotation on internal volume through REST API in OCI in Active IQ Unified Manager Discussions

To add an annotation on internal volume through REST API in OCI

ManasShukla — Wed, 04 Jun 2025 13:12:34 GMT

I am looking to add the annotation on internal volumes in OCI through REST API.

I was looking the documentation and saw that POST method of API "rest/v1/assets/internalVolumes/22008/annotations" is missing, even giving me 404 error.

Need help to add the annotations on Volumes through REST API. please let me know, if any good documentation available on it.

Re: To add an annotation on internal volume through REST API in OCI

Lei — Thu, 18 Oct 2018 05:06:33 GMT

PUT

PUT /rest/v1/assets/internalVolumes/{id}/annotations

Implementation Notes

Request body should be like JSON below:

[
  {
    "rawValue": "Bronze",
    "definition": {
      "id": "4992",
    }
  }
]

Response Class

Model properties: 
{
 rawValue: string 
 displayValue: string 
 label: string 
 annotationAssignment: 'MANUAL' or 'RULE' or 'SYSTEM_ASSIGNED' or 'INHERITED' 
}

Expand properties: 
{
 _expands: Map[string, ModelExpand]
 definition: AnnotationDefinition 
}

Parameters

Parameter	Value	Description	Data Type
id	(empty)	Id of object to update	Long

Error Status Codes

HTTP Status Code	Reason
200	Success
500	Unexpected error
400	On bad request (e.g. validation, missing parameters, invalid operation)
401	User not authenticated
403	User not authorized for operation
404	Resource not found

Since

REST API 1.1

Allowed roles

User

Re: To add an annotation on internal volume through REST API in OCI

ManasShukla — Fri, 19 Oct 2018 09:36:05 GMT

Many Thanks Lie,

We applied the PUT method and it works.