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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class EngineWorkflowArchiveRequest
    {
        public Integer WorkflowId = null;
        
        public Integer getWorkflowId() { return WorkflowId; }
        public EngineWorkflowArchiveRequest setWorkflowId(Integer value) { this.WorkflowId = value; return this; }
    }

    public static class EngineWorkflowArchiveResponse
    {
        public Integer WorkflowId = null;
        public String Status = null;
        public Integer Cancelled = null;
        public Boolean Withdrew = null;
        public String Note = null;
        public ResponseStatus ResponseStatus = null;
        
        public Integer getWorkflowId() { return WorkflowId; }
        public EngineWorkflowArchiveResponse setWorkflowId(Integer value) { this.WorkflowId = value; return this; }
        public String getStatus() { return Status; }
        public EngineWorkflowArchiveResponse setStatus(String value) { this.Status = value; return this; }
        public Integer getCancelled() { return Cancelled; }
        public EngineWorkflowArchiveResponse setCancelled(Integer value) { this.Cancelled = value; return this; }
        public Boolean isWithdrew() { return Withdrew; }
        public EngineWorkflowArchiveResponse setWithdrew(Boolean value) { this.Withdrew = value; return this; }
        public String getNote() { return Note; }
        public EngineWorkflowArchiveResponse setNote(String value) { this.Note = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public EngineWorkflowArchiveResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java EngineWorkflowArchiveRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"WorkflowId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"WorkflowId":0,"Status":"String","Cancelled":0,"Withdrew":false,"Note":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}