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 Foundation
import ServiceStack

public class EngineExpirySweepRequest : Codable
{
    public var workflowId:Int?

    required public init(){}
}

public class EngineExpirySweepResponse : Codable
{
    public var swept:Bool
    public var why:String
    public var localDate:String
    public var certMilestones:[Int] = []
    public var docMilestones:[Int] = []
    public var listeningWorkflowIds:[Int] = []
    public var steps:Int
    public var claimed:Int
    public var written:Int
    public var released:Int
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift 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
		}
	}
}