Query Activity Instances in XML Format

API Type

REST

HTTP Method

POST

Description

Retrieves activity instances that match a query expression in XML format.

URL Format (OnPremises, Private Cloud)

https://[domain]:[port]/AgilePointServer/Workflow/QueryActivityInsts/[expr]

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Workflow/QueryActivityInsts/[expr]

Request Parameters

JavaScript Code Example

$("#btnQueryActivityInstsXml").click(function () {
  var JSONObject = "<
     WFQueryExprHelper xmlns=\"https:\/\/schemas.datacontract.org\/2004\/07\/Ascentn.AgilePoint.WCFService\">
     <ColumnName>ID<\/ColumnName><IsValue>true<\/IsValue>
     <Operator>EQ<\/Operator><WhereClause>00005B6533CB4362A55A624C54293CD3
     <\/WhereClause><\/WFQueryExprHelper>";

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/QueryActivityInsts",
    data: JSONObject, contentType: "application/xml", dataType: "xml"                     
  });
  
});

Java Code Example

public String QueryActivityInstsXML() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/QueryActivityInsts";
  String xmlRequestData = "
    <WFQueryExprHelper xmlns=\"https://schemas.datacontract.org/2004/07/Ascentn.AgilePoint.WCFService\">
    <ColumnName>ID<\\ColumnName> 
    <IsValue>true<\\IsValue>
    <Operator>EQ<\\Operator> 
    <WhereClause>00005B6533CB4362A55A624C54293CD3<\\WhereClause> 
    <\\WFQueryExprHelper>";
  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);
  return ops.POSTMethodXML(URI, xmlRequestData);
}

C# Code Example

public string QueryActivityInstsXML()
  {
    string xmlRequestData = "
      <WFQueryExprHelper xmlns=\"https:\\/\\/schemas.datacontract.org\\/2004\\/07\\/Ascentn.AgilePoint.WCFService\">
      <ColumnName>ID<\\/ColumnName>
      <IsValue>true<\\/IsValue>
      <Operator>EQ<\\/Operator>
      <WhereClause>00005B6533CB4362A55A624C54293CD3<\\/WhereClause>
      <\\/WFQueryExprHelper>";

    string URI="https://mydomain:9011/AgilePointServer/Workflow/QueryActivityInsts";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.PostXml(URI, xmlRequestData);
  }

Output

An array of WFBaseActivityInstance objects.

JSON Response Body Example

  On hold due to didn't get JSON response code.

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

• AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
• Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
• Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.