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

export class EngineExpirySweepResponse
{
    public Swept: boolean;
    public Why: string;
    public LocalDate: string;
    public CertMilestones: number[] = [];
    public DocMilestones: number[] = [];
    public ListeningWorkflowIds: number[] = [];
    public Steps: number;
    public Claimed: number;
    public Written: number;
    public Released: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<EngineExpirySweepResponse>) { (Object as any).assign(this, init); }
}

export class EngineExpirySweepRequest
{
    public WorkflowId?: number;

    public constructor(init?: Partial<EngineExpirySweepRequest>) { (Object as any).assign(this, init); }
}

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