CoreService

<back to all web services

CreateUserNote

UserNote - CRUD

Creates a user note on a deployment or resource

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
POST/api/usernotesCreates a user note on a deployment or resource
POST/usernotesCreates a user note on a deployment or resource
CreateUserNote Parameters:
NameParameterData TypeRequiredDescription
TenantNameheaderstringYes
ConfigItemIdbodystringYesThe id of the deployment or resource the note is attached to
ConfigItemTypebodyObjectTypesYesThe type of the config item (Deployment or a Resource type)

Allowable Values

  • 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
MessagebodystringYesThe note text (max 1000 chars)
ObjectTypes Enum:
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
UserNoteDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
MessageformstringYes
ConfigItemIdformGuidNo
ConfigItemTypeformObjectTypesNo
ConfigItemNameformstringYes
TenantIdformGuidNo
CreatedformDateTimeNo
CreateUserformstringYes
CreateUserIdformstringYes
ModifiedformDateTimeNo
ModifyUserformstringYes
ModifyUserIdformstringYes
SelfLinkformstringYes
ObjectTypeformObjectTypesNo

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

HTTP + JSON

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"}