Framework API

GetWorkflowData

Retrieves Updated workflow data to be saved to Framework

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Retrieves Updated workflow data to be saved to Framework
    */
    @Api(Description="Retrieves Updated workflow data to be saved to Framework")
    public static class GetWorkflowData implements ISubscription
    {
        /**
        * Bin Row Version of the last update
        */
        @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
        public byte[] BinRowVersion = null;

        /**
        * Suite Data Source Instance Id to determine which licensees data to retrieve.
        */
        @ApiMember(DataType="Guid", Description="Suite Data Source Instance Id to determine which licensees data to retrieve.", Name="SuiteDataSourceInstanceId")
        public UUID SuiteDataSourceInstanceId = null;

        public Boolean IgnoreValidation = null;
        
        public byte[] getBinRowVersion() { return BinRowVersion; }
        public GetWorkflowData setBinRowVersion(byte[] value) { this.BinRowVersion = value; return this; }
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public GetWorkflowData setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public Boolean isIgnoreValidation() { return IgnoreValidation; }
        public GetWorkflowData setIgnoreValidation(Boolean value) { this.IgnoreValidation = value; return this; }
    }

    @ApiResponse(Description="Eros workflow data for synching to Framework")
    public static class GetWorkflowDataResponse
    {
        /**
        * Bin Row Version of the last update
        */
        @ApiMember(Description="Bin Row Version of the last update")
        public byte[] BinRowVersion = null;

        /**
        * XML string containing the workflow Data
        */
        @ApiMember(Description="XML string containing the workflow Data")
        public String WorkflowData = null;

        public ResponseStatus ResponseStatus = null;
        
        public byte[] getBinRowVersion() { return BinRowVersion; }
        public GetWorkflowDataResponse setBinRowVersion(byte[] value) { this.BinRowVersion = value; return this; }
        public String getWorkflowData() { return WorkflowData; }
        public GetWorkflowDataResponse setWorkflowData(String value) { this.WorkflowData = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetWorkflowDataResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java GetWorkflowData DTOs

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.

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

{"BinRowVersion":"AA==","IgnoreValidation":true}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}