Trendsic Platform Service

<back to all web services

EngineWorkflowsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/workflows
import 'package:servicestack/servicestack.dart';

class WorkflowVersionInfo implements IConvertible
{
    int? VersionNum;
    String? Status;
    String? CreatedBy;
    DateTime? CreatedAt;
    DateTime? PublishedAt;

    WorkflowVersionInfo({this.VersionNum,this.Status,this.CreatedBy,this.CreatedAt,this.PublishedAt});
    WorkflowVersionInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        VersionNum = json['VersionNum'];
        Status = json['Status'];
        CreatedBy = json['CreatedBy'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        PublishedAt = JsonConverters.fromJson(json['PublishedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'VersionNum': VersionNum,
        'Status': Status,
        'CreatedBy': CreatedBy,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'PublishedAt': JsonConverters.toJson(PublishedAt,'DateTime',context!)
    };

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

class WorkflowView implements IConvertible
{
    int? WorkflowId;
    String? SourceKey;
    String? Name;
    String? Vertical;
    String? Pack;
    String? Status;
    int? VersionNum;
    String? Description;
    String? OwnerRole;
    String? GraphJson;
    int? Ok30;
    int? Fail30;
    int? Waiting;
    String? UpdatedBy;
    DateTime? UpdatedAt;
    List<WorkflowVersionInfo>? Versions = [];

    WorkflowView({this.WorkflowId,this.SourceKey,this.Name,this.Vertical,this.Pack,this.Status,this.VersionNum,this.Description,this.OwnerRole,this.GraphJson,this.Ok30,this.Fail30,this.Waiting,this.UpdatedBy,this.UpdatedAt,this.Versions});
    WorkflowView.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        WorkflowId = json['WorkflowId'];
        SourceKey = json['SourceKey'];
        Name = json['Name'];
        Vertical = json['Vertical'];
        Pack = json['Pack'];
        Status = json['Status'];
        VersionNum = json['VersionNum'];
        Description = json['Description'];
        OwnerRole = json['OwnerRole'];
        GraphJson = json['GraphJson'];
        Ok30 = json['Ok30'];
        Fail30 = json['Fail30'];
        Waiting = json['Waiting'];
        UpdatedBy = json['UpdatedBy'];
        UpdatedAt = JsonConverters.fromJson(json['UpdatedAt'],'DateTime',context!);
        Versions = JsonConverters.fromJson(json['Versions'],'List<WorkflowVersionInfo>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'WorkflowId': WorkflowId,
        'SourceKey': SourceKey,
        'Name': Name,
        'Vertical': Vertical,
        'Pack': Pack,
        'Status': Status,
        'VersionNum': VersionNum,
        'Description': Description,
        'OwnerRole': OwnerRole,
        'GraphJson': GraphJson,
        'Ok30': Ok30,
        'Fail30': Fail30,
        'Waiting': Waiting,
        'UpdatedBy': UpdatedBy,
        'UpdatedAt': JsonConverters.toJson(UpdatedAt,'DateTime',context!),
        'Versions': JsonConverters.toJson(Versions,'List<WorkflowVersionInfo>',context!)
    };

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

class EngineWorkflowsResponse implements IConvertible
{
    List<WorkflowView>? Workflows = [];
    ResponseStatus? ResponseStatus;

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

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

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

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

class EngineWorkflowsRequest implements IConvertible
{
    EngineWorkflowsRequest();
    EngineWorkflowsRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "EngineWorkflowsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'WorkflowVersionInfo': TypeInfo(TypeOf.Class, create:() => WorkflowVersionInfo()),
    'WorkflowView': TypeInfo(TypeOf.Class, create:() => WorkflowView()),
    'List<WorkflowVersionInfo>': TypeInfo(TypeOf.Class, create:() => <WorkflowVersionInfo>[]),
    'EngineWorkflowsResponse': TypeInfo(TypeOf.Class, create:() => EngineWorkflowsResponse()),
    'List<WorkflowView>': TypeInfo(TypeOf.Class, create:() => <WorkflowView>[]),
    'EngineWorkflowsRequest': TypeInfo(TypeOf.Class, create:() => EngineWorkflowsRequest()),
});

Dart EngineWorkflowsRequest 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 HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineWorkflowsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Workflows>
    <WorkflowView>
      <Description>String</Description>
      <Fail30>0</Fail30>
      <GraphJson>String</GraphJson>
      <Name>String</Name>
      <Ok30>0</Ok30>
      <OwnerRole>String</OwnerRole>
      <Pack>String</Pack>
      <SourceKey>String</SourceKey>
      <Status>String</Status>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UpdatedBy>String</UpdatedBy>
      <VersionNum>0</VersionNum>
      <Versions>
        <WorkflowVersionInfo>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <PublishedAt>0001-01-01T00:00:00</PublishedAt>
          <Status>String</Status>
          <VersionNum>0</VersionNum>
        </WorkflowVersionInfo>
      </Versions>
      <Vertical>String</Vertical>
      <Waiting>0</Waiting>
      <WorkflowId>0</WorkflowId>
    </WorkflowView>
  </Workflows>
</EngineWorkflowsResponse>