Trendsic Platform Service

<back to all web services

EngineExpirySweepRequest

Requires Authentication
The following routes are available for this service:
GET,POST,OPTIONS/v1/engine/sweeps/before-a-date
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

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

    public static class EngineExpirySweepResponse
    {
        public Boolean Swept = null;
        public String Why = null;
        public String LocalDate = null;
        public ArrayList<Integer> CertMilestones = new ArrayList<Integer>();
        public ArrayList<Integer> DocMilestones = new ArrayList<Integer>();
        public ArrayList<Integer> ListeningWorkflowIds = new ArrayList<Integer>();
        public Integer Steps = null;
        public Integer Claimed = null;
        public Integer Written = null;
        public Integer Released = null;
        public ResponseStatus ResponseStatus = null;
        
        public Boolean isSwept() { return Swept; }
        public EngineExpirySweepResponse setSwept(Boolean value) { this.Swept = value; return this; }
        public String getWhy() { return Why; }
        public EngineExpirySweepResponse setWhy(String value) { this.Why = value; return this; }
        public String getLocalDate() { return LocalDate; }
        public EngineExpirySweepResponse setLocalDate(String value) { this.LocalDate = value; return this; }
        public ArrayList<Integer> getCertMilestones() { return CertMilestones; }
        public EngineExpirySweepResponse setCertMilestones(ArrayList<Integer> value) { this.CertMilestones = value; return this; }
        public ArrayList<Integer> getDocMilestones() { return DocMilestones; }
        public EngineExpirySweepResponse setDocMilestones(ArrayList<Integer> value) { this.DocMilestones = value; return this; }
        public ArrayList<Integer> getListeningWorkflowIds() { return ListeningWorkflowIds; }
        public EngineExpirySweepResponse setListeningWorkflowIds(ArrayList<Integer> value) { this.ListeningWorkflowIds = value; return this; }
        public Integer getSteps() { return Steps; }
        public EngineExpirySweepResponse setSteps(Integer value) { this.Steps = value; return this; }
        public Integer getClaimed() { return Claimed; }
        public EngineExpirySweepResponse setClaimed(Integer value) { this.Claimed = value; return this; }
        public Integer getWritten() { return Written; }
        public EngineExpirySweepResponse setWritten(Integer value) { this.Written = value; return this; }
        public Integer getReleased() { return Released; }
        public EngineExpirySweepResponse setReleased(Integer value) { this.Released = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public EngineExpirySweepResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java EngineExpirySweepRequest 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/sweeps/before-a-date HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<EngineExpirySweepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CertMilestones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CertMilestones>
  <Claimed>0</Claimed>
  <DocMilestones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DocMilestones>
  <ListeningWorkflowIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ListeningWorkflowIds>
  <LocalDate>String</LocalDate>
  <Released>0</Released>
  <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>
  <Steps>0</Steps>
  <Swept>false</Swept>
  <Why>String</Why>
  <Written>0</Written>
</EngineExpirySweepResponse>