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 Foundation
import ServiceStack

public class EngineWorkflowArchivePreviewRequest : Codable
{
    public var workflowId:Int

    required public init(){}
}

public class EngineWorkflowArchivePreviewResponse : Codable
{
    public var preview:WorkflowArchivePreview
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class WorkflowArchivePreview : Codable
{
    public var workflowId:Int
    public var name:String
    public var status:String
    public var trigger:String
    public var queued:Int
    public var waiting:Int
    public var running:Int
    public var refusal:String
    public var hasPendingRequest:Bool

    required public init(){}
}


Swift EngineWorkflowArchivePreviewRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}