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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CoreService.ServiceModel.Dtos.Audit.Crud
Imports CoreService.ServiceModel.Dtos.Audit.Responses
Imports YCO.Dune.Models.Enums

Namespace Global

    Namespace CoreService.ServiceModel.Dtos.Audit.Crud

        '''<Summary>
        '''Returns a single changelog by its id
        '''</Summary>
        <Api(Description:="Returns a single changelog by its id")>
        <ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(ChangeLogDto), StatusCode:=200)>
        Public Partial Class GetChangeLog
            Implements IBaseRequest
            Implements IHasId
            Implements IHasTenantName
            Implements IGet
            '''<Summary>
            '''The unique id of the object
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The unique id of the object", Format:="guid", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Id As Guid Implements IHasId.Id

            <ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property TenantName As String Implements IHasTenantName.TenantName
        End Class
    End Namespace

    Namespace CoreService.ServiceModel.Dtos.Audit.Responses

        Public Partial Class ChangeLogDto
            Implements IHasTenantId
            Public Overridable Property Id As Guid
            Public Overridable Property TenantId As Guid Implements IHasTenantId.TenantId
            Public Overridable Property TimeStamp As Date
            Public Overridable Property ObjectId As String
            Public Overridable Property ObjectName As String
            Public Overridable Property ObjectType As ObjectTypes
            Public Overridable Property ChangeType As ChangeTypes
            Public Overridable Property Description As String
            Public Overridable Property Changes As Dictionary(Of String, ValueChangeDto) = New Dictionary(Of String, ValueChangeDto)
            Public Overridable Property ModifyUserId As String
            Public Overridable Property ModifyUserEmail As String
        End Class

        Public Partial Class ValueChangeDto
            Public Overridable Property OldValue As String
            Public Overridable Property NewValue As String
        End Class
    End Namespace

    Namespace YCO.Dune.Models.Enums

        Public Enum ChangeTypes
            Create
            Update
            Delete
        End Enum

        Public Enum ObjectTypes
            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
        End Enum
    End Namespace
End Namespace

VB.NET GetChangeLog DTOs

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