ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Workflow.Client.Models Namespace / SearchQuery Class
Members Example

In This Topic
    SearchQuery Class
    In This Topic
    Search criteria for querying job information
    Syntax
    Public Class SearchQuery 
    public class SearchQuery 
    Example
    Search for jobs using a detailed query
    {
      var search = new SearchQuery()
      {
        // Search for all open high priority jobs assigned to users
        Q = "closed=0 AND assignedType='User' AND priority='High'",
        Fields = ["jobId", "jobName", "assignedTo", "dueDate"],
        // Sort by job assignment in ascending order and due date in descending order
        SortFields =
        [
          new SortField() { FieldName = "assignedTo", SortOrder = SortOrder.Asc },
          new SortField() { FieldName = "dueDate", SortOrder = SortOrder.Desc }
        ]
      };
      var jobManager = WorkflowClientModule.JobsManager;
      var searchResults = jobManager.SearchJobs(search);
      var fields = searchResults.Fields;
      var results = searchResults.Results;
    }
    Search for jobs using a detailed query with an arcade expression
    {
      var search = new SearchQuery()
      {
        // Search for jobs assigned to the current user using the arcade expression '$currentUser'
        Q = "\"assignedType='User' AND closed=0 AND assignedTo='\" + $currentUser + \"' \"",
        Fields = ["jobId", "jobName", "assignedTo", "dueDate"],
        // Sort by job name in ascending order
        SortFields = [new SortField() { FieldName = "jobName", SortOrder = SortOrder.Asc }]
      };
      var jobManager = WorkflowClientModule.JobsManager;
      var searchResults = jobManager.SearchJobs(search);
      var fields = searchResults.Fields;
      var results = searchResults.Results;
    }
    Search for jobs using a simple string
    {
      var search = new SearchQuery() { Search = "My Search String" };
      var jobManager = WorkflowClientModule.JobsManager;
      var searchResults = jobManager.SearchJobs(search);
      var fields = searchResults.Fields;
      var results = searchResults.Results;
    
      // Use the fields and results collections
    }
    Inheritance Hierarchy

    System.Object
       ArcGIS.Desktop.Workflow.Client.Models.SearchQuery

    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.2 or higher.
    See Also