Framework API

<back to all web services

GetWorkflowData

Retrieves Updated workflow data to be saved to Framework

Requires Authentication 

// @ApiResponse(Description="Eros workflow data for synching to Framework")
export class GetWorkflowDataResponse
{
    /** @description Bin Row Version of the last update */
    // @ApiMember(Description="Bin Row Version of the last update")
    public BinRowVersion: string;

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

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetWorkflowDataResponse>) { (Object as any).assign(this, init); }
}

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

    /** @description 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 SuiteDataSourceInstanceId: string;

    public IgnoreValidation: boolean;

    public constructor(init?: Partial<GetWorkflowData>) { (Object as any).assign(this, init); }
}

TypeScript GetWorkflowData 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 /jsv/reply/GetWorkflowData HTTP/1.1 
Host: gatewayframeworkapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BinRowVersion: AA==,
	IgnoreValidation: True
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}