Click or drag to resize

RuntimeServiceGetPortlet Method

Gets the Portlet RSS.

Namespace:  Advantys.Workflow.Web.Services.Processes.Runtime
Assembly:  Advantys.Workflow.Web.Services.Processes.Runtime (in Advantys.Workflow.Web.Services.Processes.Runtime.dll) Version: 8.0.5.0 (8.0.5.20210818)
Syntax
public XmlNode GetPortlet()

Return Value

Type: XmlNode
Portlet RSS.

Format: XmlNode

Remarks

Optional Parameters.
These parameters can be used in the query string or as parameters of the SOAP headers (see examples for more information).

category (string)Specifies the list of category of the Portlet items to be returned (separated by semi-colon).

Possible values: NEW_REQUEST, REQUEST_RUNNING_NB, REQUEST_RUNNING_OVERDUE_NB, ACTION_TODO_NB, ACTION_TODO_OVERDUE_NB, ACTION_TEAM_NB, ACTION_TEAM_OVERDUE_NB, ACTION_TOASSIGN_NB, ACTION_TOASSIGN_OVERDUE_NB, REQUEST_CLOSED_NB, REQUEST_CLOSED_OVERDUE_NB, REQUEST_TOFOLLOW_NB, REQUEST_TOFOLLOW_OVERDUE_NB, ACTION_TOFOLLOW_NB and ACTION_TOFOLLOW_OVERDUE_NB
language (string)Specifies the display language of the Portlet.
process (string)Specifies the list of processes on which the Portlet is filtered on (separated by semi-colon).
processCategory (string)Specifies the list of process categories on which the Portlet is filtered on (separated by semi-colon).

Note: For HTTP GET and POST, use the parameter name PROCESS_CATEGORY instead.
impersonateUsername (string)Username to use for impersonation. Operation is available for allowed users only.
showNewRequest (string)Indicates to include the new request list in the Portlet (possible values: Y and N).

Note: For HTTP GET and POST, use the parameter name SHOW_NEW_REQUEST instead.
xsl (string) - Deprecated.Indicates the path of the XSL sheet used to transform the RSS content (Deprecated).


Examples
Try out these URLs directly in your browser or RSS Reader.
- Return the Portlet of the user John:
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetPortlet?username=John<br />
- Return the Portlet of the connected user with the new request list:
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetPortlet?SHOW_NEW_REQUEST=Y<br />
- Return the Portlet of the connected user by filtering on the process categories (HR and IT):
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetPortlet?PROCESS_CATEGORY=HR;IT

This HTTP GET sample returns the Portlet of the connected user.
using System;
using System.Collections.Generic;
using System.Text;

namespace ConsoleApplication1
{
  class Program
  {
    static void Main(string[] args)
    {
        // Variables
        System.Net.HttpWebRequest httpWebReq = null;    // Http web request object
        System.Net.HttpWebResponse httpWebResp = null;  // Http web response object
        System.IO.StreamReader myReader = null;         // To read response stream
        string url = string.Empty;                      // URL of the web method of the API
        string response = null;                         // string used to display response

        // Call the Web Service API method (replace your server and port with your hostname)
        url = "http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetPortlet";

        // Prepare the request
        httpWebReq = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(url);
        httpWebReq.Method = "GET";
        httpWebReq.Credentials = System.Net.CredentialCache.DefaultCredentials;
        httpWebReq.ContentType = "text/xml; charset=utf-8";

        // Gets the stream associated with the response
        httpWebResp = (System.Net.HttpWebResponse)httpWebReq.GetResponse();
        myReader = new System.IO.StreamReader(httpWebResp.GetResponseStream());
        response = myReader.ReadToEnd();
        httpWebResp.Close();

        // Display the XML in the console
        Console.Write(response);
    }
  }
}

This SOAP example returns the Portlet of the connected user.
A web reference at www.mycompany.com has been added in the project.
using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;
using System.Net;
using System.Xml;
using System.Xml.Xsl;
using com.mycompany.www;
<br />
public partial class _Default : System.Web.UI.Page
{
  protected RuntimeService myRuntimeService = null;
<br />
    protected void Page_Load(object sender, EventArgs e)
    {
<br />
        // Set NetworkCredentials with the credentials of the current connected user
        myRuntimeService = new RuntimeService();
        myRuntimeService.Credentials = CredentialCache.DefaultCredentials;
<br />
        // Call the Web Service API method
        XmlNode portletRss = myRuntimeService.GetPortlet();
    }
}
<br />
See Also