Framework API

<back to all web services

GetWorkflowData

Retrieves Updated workflow data to be saved to Framework

Requires Authentication
GetWorkflowData Parameters:
NameParameterData TypeRequiredDescription
BinRowVersionquerybyte[]NoBin Row Version of the last update
SuiteDataSourceInstanceIdqueryGuidNoSuite Data Source Instance Id to determine which licensees data to retrieve.
IgnoreValidationqueryboolNo
GetWorkflowDataResponse Parameters:
NameParameterData TypeRequiredDescription
BinRowVersionformbyte[]NoBin Row Version of the last update
WorkflowDataformstringNoXML string containing the workflow Data
ResponseStatusformResponseStatusNo

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GetWorkflowData HTTP/1.1 
Host: gatewayframeworkapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"BinRowVersion":"AA==","IgnoreValidation":true}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"BinRowVersion":"AA==","WorkflowData":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}