CoreService

<back to all web services

GetDeploymentOperationalState

Deployment - CRUD

Get deployment operational state

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/deployments/{Id}/operationalstateGets a deployments operational state
GET/deployments/{Id}/operationalstateGets a deployments operational state
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.Deployments.Crud
Imports CoreService.ServiceModel.Enums

Namespace Global

    Namespace CoreService.ServiceModel.Dtos.Deployments.Crud

        '''<Summary>
        '''Get deployment operational state
        '''</Summary>
        <Api(Description:="Get deployment operational state")>
        <ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(OperationalStates), StatusCode:=200)>
        Public Partial Class GetDeploymentOperationalState
            Implements IBaseRequest
            Implements IHasId
            Implements IHasTenantName
            Implements IGet
            <ApiMember(DataType:="string", 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.Enums

        Public Enum OperationalStates
            None
            Starting
            Running
            Stopping
            Stopped
            Restarting
            Deleting
            Unknown
        End Enum
    End Namespace
End Namespace

VB.NET GetDeploymentOperationalState 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/deployments/{Id}/operationalstate HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

"None"