Click or drag to resize

RuntimeServiceGetCommentList Method

Gets a list of comments.

Namespace:  Advantys.Workflow.Web.Services.Processes.Runtime
Assembly:  Advantys.Workflow.Web.Services.Processes.Runtime (in Advantys.Workflow.Web.Services.Processes.Runtime.dll) Version: (
public XmlNode GetCommentList()

Return Value

Type: XmlNode
List of comments.

Format: By default returns RSS 2.0

Sorted: The list is sorted by posted date in descending order.


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

delegateUsername (string)Specifies the delegator username for delegation mode.
template (string)Name of the response template.
postedSince (DateTime)Comments posted since the specified local date time.
sortBy (string)Specifies the sort field (Date or Author).
sortOrder (string)Specifies the sort order (Asc or Desc).
size (int)Number of items per page.
page (int)Specifies the page number. The first page is returned if there is no page number specified.
utc (bool)Displays dateTime values in UTC format.

Common Macros

<WF_LIST_TITLE>Replaced with the title.
<WF_LIST_DESC>Replaced with the description.
<WF_SYSTEM_DATE>,<WF_SYSTEM_TIME>,<WF_SYSTEM_DATETIME>Replaced with the date, time and datetime.
<WF_USER_ID>Replaced with the user's ID.
<WF_USER_NAME>Replaced with the user's username.
<WF_USER_FIRSTNAME>Replaced with the user's first name.
<WF_USER_LASTNAME>Replaced with the user's last name.
<WF_USER_EMAIL>Replaced with the user's email address.
<WF_USER_COMPANY>Replaced with the user's company name.
<WF_USER_DEPARTMENT>Replaced with the user's department name.
<WF_USER_LANGUAGE>Replaced with the user's language.
<WF_USER_TIME_ZONE_ID>Replaced with the user's time zone ID.
<WF_USER_TIME_ZONE_NAME>Replaced with the user's time zone name.
<WF_COMMENT_LIST_LINK>Link to the comments list of the WorkflowGen portal home page.
<WF_DELEGATOR_USER_ID>Replaced with the delegator's user ID.
<WF_COMMENT_ITEM>Replaced with the specific sub-macros listed below.

Specific Sub-Macros in <WF_COMMENT_ITEM></WF_COMMENT_ITEM>

<WF_PROCESS_INST_ID>Replaced with the request ID.
<WF_PROCESS_INST_NAME>Replaced with the request name.
<WF_PROCESS_INST_DESC>Replaced with the request description.
<WF_COMMENT_NUMBER>Replaced with the comment number.
<WF_COMMENT_DATE_POST>Replaced with the posted date.
<WF_COMMENT_TITLE>Replaced with the comment title.
<WF_COMMENT_TEXT>Replaced with the message.
<WF_COMMENT_LINK>Link to the comments list in the request follow-up form.
<WF_AUTHOR_ID>Replaced with the author's user ID.
<WF_AUTHOR_USERNAME>Replaced with the author's username.
<WF_AUTHOR_FIRSTNAME>Replaced with the author's first name.
<WF_AUTHOR_LASTNAME>Replaced with the author's last name.
<WF_AUTHOR_EMAIL>Replaced with the author's email address.
<WF_AUTHOR_COMPANY>Replaced with the author's company name.
<WF_AUTHOR_DEPARTMENT>Replaced with the author's department name.

Try out these URLs directly in your browser or RSS Reader.
- Return the list of comments with RSS 2.0 format (default format when no template is specified):
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetCommentList<br />or
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetCommentList?template=ProcessesRuntime.CommentListRss.txt<br />
- Return the list of comments with ATOM format:
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetCommentList?template=ProcessesRuntime.CommentListAtom.txt<br />
- Return the list of comments with a customized XML format:
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetCommentList?template=ProcessesRuntime.CommentListXml.txt<br />
- Return the list of comments sorted by author in descending order:
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetCommentList?sortBy=Author&sortOrder=Desc<br />
- Return the list of comments posted since 08 June 2010:
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetCommentList?postedSince=06/08/2010<br />
- Return the list of the last 25 comments:
http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetCommentList?page=1&size=25<br />
- Return the list of comments with delegation security access from wfgen_admin:

This HTTP GET sample returns the list of comments.
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 yourserver and port with your hostname)
        url = "http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx/GetCommentList";

        // 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();

        // Display the XML in the console

This SOAP example returns with XML template, the number of comments in the request #1.
A web reference at 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)
        XmlNode resultNode = null;
        CommentListHeader myCommentListHeader = null;
<br />
        // Settings and parameters
        myCommentListHeader = new CommentListHeader();
        myCommentListHeader.Template = "ProcessesRuntime.CommentListRss.txt";

        // Set NetworkCredentials with the credentials of the current connected user
        myRuntimeService = new RuntimeService();
        myRuntimeService.CommentListHeaderValue = myCommentListHeader;
        myRuntimeService.Credentials = CredentialCache.DefaultCredentials;
<br />
        // Call the Web Service API method
        resultNode = myRuntimeService.GetCommentList();
        TextBox1.Text = resultNode.SelectNodes("channel/item").Count.ToString();
<br />
See Also