REST Custom Variables

Custom variables in this section of the documentation can be used to customize a variety of settings associated with using a Business Value to return data from a REST data source.

Link

A string variable that determines the default format for results from a REST web service call by a Business Value. The default value is "XML".

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Set default REST returns as XML
    bp.Vars.DefaultBVRestAccept = "XML";
}

Link

A string variable that determines the default method for returning results from a REST web service call by a Business Value. The default value is "POST".

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Set default REST return method
    bp.Vars.DefaultBVRestMethod = "POST";
}

Link

A string variable that determines the default REST Content Type for a web service call by a Business Value. The default value is "application/XML".

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Set default REST content type
    bp.Vars.DefaultBVRestContentType = "application/XML";
}

Link

This Custom Variable implements an Add method that enables you to specify custom REST HTTP headers for a web service call by a Business Value.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Add REST header
    bp.Vars.DefaultBVRestHeaders.Add(new NameValue("Name", "Value"));
}

Link

This Custom Variable enables you to specify the default network credentials to supply to a REST web service call by a Business Value.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Default REST credentials
    bp.Vars.DefaultBVRestCredentials =
     new System.Net.NetworkCredential("UserID","password");
}