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
EngineExpirySweepRequest Parameters:
NameParameterData TypeRequiredDescription
WorkflowIdbodyint?No
EngineExpirySweepResponse Parameters:
NameParameterData TypeRequiredDescription
SweptformboolNo
WhyformstringNo
LocalDateformstringNo
CertMilestonesformList<int>No
DocMilestonesformList<int>No
ListeningWorkflowIdsformList<int>No
StepsformintNo
ClaimedformintNo
WrittenformintNo
ReleasedformintNo
ResponseStatusformResponseStatusNo

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

HTTP + OTHER

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

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