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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineWorkflowArchivePreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Preview>
    <HasPendingRequest>false</HasPendingRequest>
    <Name>String</Name>
    <Queued>0</Queued>
    <Refusal>String</Refusal>
    <Running>0</Running>
    <Status>String</Status>
    <Trigger>String</Trigger>
    <Waiting>0</Waiting>
    <WorkflowId>0</WorkflowId>
  </Preview>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</EngineWorkflowArchivePreviewResponse>