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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type EngineExpirySweepResponse() = 
        member val Swept:Boolean = new Boolean() with get,set
        member val Why:String = null with get,set
        member val LocalDate:String = null with get,set
        member val CertMilestones:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val DocMilestones:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val ListeningWorkflowIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val Steps:Int32 = new Int32() with get,set
        member val Claimed:Int32 = new Int32() with get,set
        member val Written:Int32 = new Int32() with get,set
        member val Released:Int32 = new Int32() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type EngineExpirySweepRequest() = 
        member val WorkflowId:Nullable<Int32> = new Nullable<Int32>() with get,set

F# 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
		}
	}
}