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
"use strict";
export class EngineExpirySweepResponse {
    /** @param {{Swept?:boolean,Why?:string,LocalDate?:string,CertMilestones?:number[],DocMilestones?:number[],ListeningWorkflowIds?:number[],Steps?:number,Claimed?:number,Written?:number,Released?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Swept;
    /** @type {string} */
    Why;
    /** @type {string} */
    LocalDate;
    /** @type {number[]} */
    CertMilestones = [];
    /** @type {number[]} */
    DocMilestones = [];
    /** @type {number[]} */
    ListeningWorkflowIds = [];
    /** @type {number} */
    Steps;
    /** @type {number} */
    Claimed;
    /** @type {number} */
    Written;
    /** @type {number} */
    Released;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineExpirySweepRequest {
    /** @param {{WorkflowId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    WorkflowId;
}

JavaScript EngineExpirySweepRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	WorkflowId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}