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
namespace CoreService.ServiceModel.Dtos.Audit.Crud

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type ObjectTypes =
        | None = 0
        | ConfigItem = 1
        | Tenant = 2
        | Collection = 3
        | Resource = 4
        | ComputeNode = 5
        | VirtualMachine = 6
        | PhysicalMachine = 7
        | Disk = 8
        | Subnet = 9
        | IPAddress = 10
        | Job = 11
        | JobEvent = 12
        | FreezePeriod = 13
        | ResourceGroup = 14
        | Deployment = 15
        | ResourceGroupTemplate = 16
        | DeploymentTemplate = 17
        | ResourceProvider = 18
        | GenericResource = 19
        | Role = 20
        | Permission = 21
        | User = 22
        | PatchingWindow = 23
        | Update = 24
        | ReportDefinition = 25
        | TimeSeries = 26
        | DataPoint = 27
        | Action = 28
        | ActionAssignment = 29
        | UserNote = 30

    type ChangeTypes =
        | Create = 0
        | Update = 1
        | Delete = 2

    [<AllowNullLiteral>]
    type ValueChangeDto() = 
        member val OldValue:String = null with get,set
        member val NewValue:String = null with get,set

    [<AllowNullLiteral>]
    type ChangeLogDto() = 
        member val Id:Guid = new Guid() with get,set
        member val TenantId:Guid = new Guid() with get,set
        member val TimeStamp:DateTime = new DateTime() with get,set
        member val ObjectId:String = null with get,set
        member val ObjectName:String = null with get,set
        member val ObjectType:ObjectTypes = new ObjectTypes() with get,set
        member val ChangeType:ChangeTypes = new ChangeTypes() with get,set
        member val Description:String = null with get,set
        member val Changes:Dictionary<String, ValueChangeDto> = null with get,set
        member val ModifyUserId:String = null with get,set
        member val ModifyUserEmail:String = null with get,set

    ///<summary>
    ///Returns a single changelog by its id
    ///</summary>
    [<Api(Description="Returns a single changelog by its id")>]
    [<ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof<ChangeLogDto>, StatusCode=200)>]
    [<AllowNullLiteral>]
    type GetChangeLog() = 
        interface 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")>]
        member val Id:Guid = new Guid() with get,set

        [<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
        [<Validate(Validator="NotEmpty")>]
        member val TenantName:String = null with get,set

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