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
import 'package:servicestack/servicestack.dart';

enum OperationalStates
{
    None,
    Starting,
    Running,
    Stopping,
    Stopped,
    Restarting,
    Deleting,
    Unknown,
}

/**
* Get deployment operational state
*/
// @Api(Description="Get deployment operational state")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(OperationalStates), StatusCode=200)
class GetDeploymentOperationalState implements IBaseRequest, IHasId, IHasTenantName, IGet, IConvertible
{
    // @ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
    String id = "";

    // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    // @Validate(Validator="NotEmpty")
    String tenantName = "";

    GetDeploymentOperationalState({this.id,this.tenantName});
    GetDeploymentOperationalState.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        tenantName = json['tenantName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'tenantName': tenantName
    };

    getTypeName() => "GetDeploymentOperationalState";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duneframework.com', types: <String, TypeInfo> {
    'OperationalStates': TypeInfo(TypeOf.Enum, enumValues:OperationalStates.values),
    'GetDeploymentOperationalState': TypeInfo(TypeOf.Class, create:() => GetDeploymentOperationalState()),
});

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