GET api/TopTasks?field={field}&search={search}&exact={exact}
This returns tasks where the specified field contains the specified search text or equals the search text if exact = true.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
field | The Name of the field to search against |
Define this parameter in the request URI. |
search | The text to search for |
Define this parameter in the request URI. |
exact | Set to true if match must be exact |
Define this parameter in the request URI. |
Response Information
filtered list of top tasks
Response body formats
text/html
Sample:
<div class="input-group"> <label class="sr-only">Filter</label> <span class="input-group-addon">Filter</span> <input id="filter" type="text" class="form-control" placeholder="Filter..." /> </div> <table class="hdc-table table default" data-filter="#filter"> <thead> <tr> <th data-toggle="true" class="footable-first-column"> Title </th> <th data-hide="phone,tablet"> Link </th> <th> Top Task Sort </th> <th data-hide="phone,tablet"> Content Area </th> <th data-hide="phone,tablet"> Link Category </th> <th data-hide="phone"> User Category </th> </tr> </thead> <tbody> <tr> <td> sample string 2 </td> <td> <a href="sample string 3">sample string 3</a> </td> <td> 1.1 </td> <td> sample string 4 </td> <td> sample string 5 </td> <td> sample string 6 </td> </tr> <tr> <td> sample string 2 </td> <td> <a href="sample string 3">sample string 3</a> </td> <td> 1.1 </td> <td> sample string 4 </td> <td> sample string 5 </td> <td> sample string 6 </td> </tr> <tr> <td> sample string 2 </td> <td> <a href="sample string 3">sample string 3</a> </td> <td> 1.1 </td> <td> sample string 4 </td> <td> sample string 5 </td> <td> sample string 6 </td> </tr> </tbody> <tfoot class="hide-if-no-paging"> <tr> <td colspan="6"> <ul class="pagination pagination-centered hide-if-no-paging"></ul> </td> </tr> </tfoot> </table>
application/json, text/json
Sample:
[ { "id": 1, "title": "sample string 2", "link": "sample string 3", "topTaskSort": 1.1, "content_Area": "sample string 4", "link_Category": "sample string 5", "user_Category": "sample string 6" }, { "id": 1, "title": "sample string 2", "link": "sample string 3", "topTaskSort": 1.1, "content_Area": "sample string 4", "link_Category": "sample string 5", "user_Category": "sample string 6" }, { "id": 1, "title": "sample string 2", "link": "sample string 3", "topTaskSort": 1.1, "content_Area": "sample string 4", "link_Category": "sample string 5", "user_Category": "sample string 6" } ]
application/xml, text/xml
Sample:
<ArrayOfTop_Task xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HDCAPIModel.Models"> <Top_Task> <Content_Area>sample string 4</Content_Area> <ID>1</ID> <Link>sample string 3</Link> <Link_Category>sample string 5</Link_Category> <Title>sample string 2</Title> <TopTaskSort>1.1</TopTaskSort> <User_Category>sample string 6</User_Category> </Top_Task> <Top_Task> <Content_Area>sample string 4</Content_Area> <ID>1</ID> <Link>sample string 3</Link> <Link_Category>sample string 5</Link_Category> <Title>sample string 2</Title> <TopTaskSort>1.1</TopTaskSort> <User_Category>sample string 6</User_Category> </Top_Task> <Top_Task> <Content_Area>sample string 4</Content_Area> <ID>1</ID> <Link>sample string 3</Link> <Link_Category>sample string 5</Link_Category> <Title>sample string 2</Title> <TopTaskSort>1.1</TopTaskSort> <User_Category>sample string 6</User_Category> </Top_Task> </ArrayOfTop_Task>
text/javascript
Sample:
([{"id":1,"title":"sample string 2","link":"sample string 3","topTaskSort":1.1,"content_Area":"sample string 4","link_Category":"sample string 5","user_Category":"sample string 6"},{"id":1,"title":"sample string 2","link":"sample string 3","topTaskSort":1.1,"content_Area":"sample string 4","link_Category":"sample string 5","user_Category":"sample string 6"},{"id":1,"title":"sample string 2","link":"sample string 3","topTaskSort":1.1,"content_Area":"sample string 4","link_Category":"sample string 5","user_Category":"sample string 6"}]);