Trendsic Platform Service

<back to all web services

EngineWorkflowArchivePreviewRequest

Requires Authentication
The following routes are available for this service:
GET/v1/engine/workflows/{WorkflowId}/archive
import 'package:servicestack/servicestack.dart';

class WorkflowArchivePreview implements IConvertible
{
    int? WorkflowId;
    String? Name;
    String? Status;
    String? Trigger;
    int? Queued;
    int? Waiting;
    int? Running;
    String? Refusal;
    bool? HasPendingRequest;

    WorkflowArchivePreview({this.WorkflowId,this.Name,this.Status,this.Trigger,this.Queued,this.Waiting,this.Running,this.Refusal,this.HasPendingRequest});
    WorkflowArchivePreview.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        WorkflowId = json['WorkflowId'];
        Name = json['Name'];
        Status = json['Status'];
        Trigger = json['Trigger'];
        Queued = json['Queued'];
        Waiting = json['Waiting'];
        Running = json['Running'];
        Refusal = json['Refusal'];
        HasPendingRequest = json['HasPendingRequest'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'WorkflowId': WorkflowId,
        'Name': Name,
        'Status': Status,
        'Trigger': Trigger,
        'Queued': Queued,
        'Waiting': Waiting,
        'Running': Running,
        'Refusal': Refusal,
        'HasPendingRequest': HasPendingRequest
    };

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

class EngineWorkflowArchivePreviewResponse implements IConvertible
{
    WorkflowArchivePreview? Preview;
    ResponseStatus? ResponseStatus;

    EngineWorkflowArchivePreviewResponse({this.Preview,this.ResponseStatus});
    EngineWorkflowArchivePreviewResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Preview = JsonConverters.fromJson(json['Preview'],'WorkflowArchivePreview',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Preview': JsonConverters.toJson(Preview,'WorkflowArchivePreview',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class EngineWorkflowArchivePreviewRequest implements IConvertible
{
    int? WorkflowId;

    EngineWorkflowArchivePreviewRequest({this.WorkflowId});
    EngineWorkflowArchivePreviewRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'WorkflowArchivePreview': TypeInfo(TypeOf.Class, create:() => WorkflowArchivePreview()),
    'EngineWorkflowArchivePreviewResponse': TypeInfo(TypeOf.Class, create:() => EngineWorkflowArchivePreviewResponse()),
    'EngineWorkflowArchivePreviewRequest': TypeInfo(TypeOf.Class, create:() => EngineWorkflowArchivePreviewRequest()),
});

Dart EngineWorkflowArchivePreviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/engine/workflows/{WorkflowId}/archive HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Preview: 
	{
		WorkflowId: 0,
		Name: String,
		Status: String,
		Trigger: String,
		Queued: 0,
		Waiting: 0,
		Running: 0,
		Refusal: String,
		HasPendingRequest: False
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}