| Required role: | TenantReader |
| GET | /api/deployments/{Id}/operationalstate | Gets a deployments operational state | |
|---|---|---|---|
| GET | /deployments/{Id}/operationalstate | Gets a deployments operational state |
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CoreService.ServiceModel.Dtos.Deployments.Crud;
using CoreService.ServiceModel.Enums;
namespace CoreService.ServiceModel.Dtos.Deployments.Crud
{
///<summary>
///Get deployment operational state
///</summary>
[Api(Description="Get deployment operational state")]
[ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(CoreService.ServiceModel.Enums.OperationalStates), StatusCode=200)]
public partial class GetDeploymentOperationalState
: IBaseRequest, IHasId, IHasTenantName, IGet
{
[ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")]
public virtual Guid Id { get; set; }
[ApiMember(DataType="string", IsRequired=true, ParameterType="header")]
[Validate("NotEmpty")]
public virtual string TenantName { get; set; }
}
}
namespace CoreService.ServiceModel.Enums
{
public enum OperationalStates
{
None,
Starting,
Running,
Stopping,
Stopped,
Restarting,
Deleting,
Unknown,
}
}
C# 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"