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 .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/sweeps/before-a-date 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

{"Swept":false,"Why":"String","LocalDate":"String","CertMilestones":[0],"DocMilestones":[0],"ListeningWorkflowIds":[0],"Steps":0,"Claimed":0,"Written":0,"Released":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}