| Required role: | TenantReader |
| POST | /api/usernotes | Creates a user note on a deployment or resource | |
|---|---|---|---|
| POST | /usernotes | Creates a user note on a deployment or resource |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantName | header | string | Yes | |
| ConfigItemId | body | string | Yes | The id of the deployment or resource the note is attached to |
| ConfigItemType | body | ObjectTypes | Yes | The type of the config item (Deployment or a Resource type)Allowable Values
|
| Message | body | string | Yes | The note text (max 1000 chars) |
| None | |
| ConfigItem | |
| Tenant | |
| Collection | |
| Resource | |
| ComputeNode | |
| VirtualMachine | |
| PhysicalMachine | |
| Disk | |
| Subnet | |
| IPAddress | |
| Job | |
| JobEvent | |
| FreezePeriod | |
| ResourceGroup | |
| Deployment | |
| ResourceGroupTemplate | |
| DeploymentTemplate | |
| ResourceProvider | |
| GenericResource | |
| Role | |
| Permission | |
| User | |
| PatchingWindow | |
| Update | |
| ReportDefinition | |
| TimeSeries | |
| DataPoint | |
| Action | |
| ActionAssignment | |
| UserNote |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Message | form | string | Yes | |
| ConfigItemId | form | Guid | No | |
| ConfigItemType | form | ObjectTypes | No | |
| ConfigItemName | form | string | Yes | |
| TenantId | form | Guid | No | |
| Created | form | DateTime | No | |
| CreateUser | form | string | Yes | |
| CreateUserId | form | string | Yes | |
| Modified | form | DateTime | No | |
| ModifyUser | form | string | Yes | |
| ModifyUserId | form | string | Yes | |
| SelfLink | form | string | Yes | |
| ObjectType | form | ObjectTypes | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/usernotes HTTP/1.1
Host: core.starburst.svc
Accept: application/json
Content-Type: application/json
Content-Length: length
{"tenantName":"String","configItemId":"00000000-0000-0000-0000-000000000000","configItemType":"None","message":"String","txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"id":"00000000-0000-0000-0000-000000000000","message":"String","configItemId":"00000000-0000-0000-0000-000000000000","configItemType":"None","configItemName":"String","tenantId":"00000000-0000-0000-0000-000000000000","created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","selfLink":"/usernotes/00000000-0000-0000-0000-000000000000","objectType":"UserNote"}