Trendsic Platform Service

<back to all web services

PlanSetStatusRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/plansets/{PlanSetUID}/status
PlanSetStatusRequest Parameters:
NameParameterData TypeRequiredDescription
PlanSetUIDpathGuidNo
PlanSetStatusResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PlanSetUIDformGuidNo
StatusformstringNo
ProgressformintNo
PageCountformintNo
SheetCountformintNo
ErrorTextformstringNo
StageLabelformstringNo

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.

GET /v1/plansets/{PlanSetUID}/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"PlanSetUID":"00000000000000000000000000000000","Status":"String","Progress":0,"PageCount":0,"SheetCount":0,"ErrorText":"String","StageLabel":"String"}