Get Work Items

Properties

• Input
  • Project Id
    • Type:int?
    • Description: Filter by a project's unique identifier. This is an optional argument.
  • Work Item Type
    • Type:WorkItemType?
    • Description: Filter by work item type (e.g.,WorkItemType.Document). This is an optional argument.
  • Work Item Action
    • Type:WorkItemAction?
    • Description: Filter by work item action that the user should perform (e.g.,WorkItemAction.Verify). This is an optional argument.
  • Work Item Status
    • Type:WorkItemStatus?
    • Description: Filter by work item status (e.g.,WorkItemStatus.Created). This is an optional argument.
  • Document Id
    • Type:int?
    • Description: Filter by a document's unique identifier. This is an optional argument.
  • Shred Id
    • Type:int?
    • Description: Filter by a shred's unique identifier. This is an optional argument.
  • Start Date
    • Type:DateTime?
    • Description: Filter from starting date. This is an optional argument.
  • End Date
    • Type:DateTime?
    • Description: Filter up to end date. This is an optional argument.
  • Comment
    • Type:string
    • Description: Filter by comment. This is an optional argument.
  • Page No
    • Type:int?
    • Description: Filter by page number (only applicable when Page Size is set). This is an optional argument.
  • Page Size
    • Type:int?
    • Description: The maximum number of results to return per page (use Page No to select which page to return results for). This is an optional argument.
  • Sort Field
    • Type:SortField?
    • Description: Sort results by a specific field. This is an optional argument.
  • Sort Direction
    • Type:SortDirection?
    • Description: Sort results in a specific direction. This is an optional argument.

Usage

1. Setup Activity:
   • Add the "Get Work Items" activity to your UiPath workflow.
   • Configure the optional input arguments to specify the criteria for filtering work items. This can include project or document-related filters, date/time ranges, and other attributes of the work items such as type, action, and status.
2. Execution:
   • The activity executes asynchronously, retrieving the work items that match the specified filter criteria for the currently authenticated user.
   • It uses the configured API context to access the work item data via the work item client.
3. Output:
   • The activity returns anObservableCollection<WorkItemViewModel>, representing the work items that match the specified filters.

Considerations

• Filter Criteria: Use the available filters to narrow down the work items to those relevant to your analysis or management needs.
• Date and Time Filters: Utilize the date filters to focus on work items within a specific timeframe, improving performance and relevance of the results.
• Pagination and Sorting: Use pagination and sorting options to manage large sets of work items efficiently.
• Permissions: Verify that the necessary permissions are in place for the user or application retrieving the work items to prevent unauthorized actions.
• Error Handling: Implement error handling to manage potential issues such as network connectivity problems or unexpected API responses.