CoreService

<back to all web services

GetChangeLog

ChangeLog - CRUD

Returns a single changelog by its id

Requires Authentication
Required role:TenantAdmin
The following routes are available for this service:
GET/api/changelogs/{Id}Returns a changelog
GET/changelogs/{Id}Returns a changelog
GetChangeLog Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYesThe unique id of the object
TenantNameheaderstringYes
ChangeLogDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TenantIdformGuidNo
TimeStampformDateTimeNo
ObjectIdformstringYes
ObjectNameformstringYes
ObjectTypeformObjectTypesNo
ChangeTypeformChangeTypesNo
DescriptionformstringYes
ChangesformDictionary<string, ValueChangeDto>Yes
ModifyUserIdformstringYes
ModifyUserEmailformstringYes
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
ChangeTypes Enum:
Create
Update
Delete
ValueChangeDto Parameters:
NameParameterData TypeRequiredDescription
OldValueformstringNo
NewValueformstringNo

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.

GET /api/changelogs/{Id} HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"00000000-0000-0000-0000-000000000000","tenantId":"00000000-0000-0000-0000-000000000000","timeStamp":"0001-01-01T00:00:00.0000000Z","objectId":"String","objectName":"String","objectType":"None","changeType":"Create","description":"String","changes":{"String":{"oldValue":"String","newValue":"String"}},"modifyUserId":"String","modifyUserEmail":"String"}