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