Trendsic Platform Service

<back to all web services

EngineWorkflowArchiveRequest

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

class EngineWorkflowArchiveResponse implements IConvertible
{
    int? WorkflowId;
    String? Status;
    int? Cancelled;
    bool? Withdrew;
    String? Note;
    ResponseStatus? ResponseStatus;

    EngineWorkflowArchiveResponse({this.WorkflowId,this.Status,this.Cancelled,this.Withdrew,this.Note,this.ResponseStatus});
    EngineWorkflowArchiveResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        WorkflowId = json['WorkflowId'];
        Status = json['Status'];
        Cancelled = json['Cancelled'];
        Withdrew = json['Withdrew'];
        Note = json['Note'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'WorkflowId': WorkflowId,
        'Status': Status,
        'Cancelled': Cancelled,
        'Withdrew': Withdrew,
        'Note': Note,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class EngineWorkflowArchiveRequest implements IConvertible
{
    int? WorkflowId;

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

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

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

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

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

Dart EngineWorkflowArchiveRequest 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.

POST /v1/engine/workflows/{WorkflowId}/archive HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EngineWorkflowArchiveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <WorkflowId>0</WorkflowId>
</EngineWorkflowArchiveRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineWorkflowArchiveResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Cancelled>0</Cancelled>
  <Note>String</Note>
  <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>
  <Status>String</Status>
  <Withdrew>false</Withdrew>
  <WorkflowId>0</WorkflowId>
</EngineWorkflowArchiveResponse>