| Required role: | TenantReader |
| GET | /api/deployments/{Id}/operationalstate | Gets a deployments operational state | |
|---|---|---|---|
| GET | /deployments/{Id}/operationalstate | Gets a deployments operational state |
namespace CoreService.ServiceModel.Dtos.Deployments.Crud
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type OperationalStates =
| None = 0
| Starting = 1
| Running = 2
| Stopping = 3
| Stopped = 4
| Restarting = 5
| Deleting = 6
| Unknown = 7
///<summary>
///Get deployment operational state
///</summary>
[<Api(Description="Get deployment operational state")>]
[<ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof<OperationalStates>, StatusCode=200)>]
[<AllowNullLiteral>]
type GetDeploymentOperationalState() =
interface IGet
[<ApiMember(DataType="string", 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# 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
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"