activities
latest
false
UiPath logo, featuring letters U and I in white

UI Automation activities

Last updated Feb 19, 2026

ExtractData

Extracts data as a data table.

This API must be added after Open or Attach.

Definition​

Namespace: UiPath.UIAutomationNext.API.Models

Assembly: UiPath.UIAutomationNext.API.Models (in UiPath.UIAutomationNext.API.Models dll)

Overloads​

OverloadDescription
ExtractData(ExtractDataOptionsModel)Extracts data as a data table, identified by the ExtractDataOptionsModel object.
ExtractData(TargetAnchorableModel, ExtractDataOptions)Extracts data as a data table, identified by the TargetAnchorableModel object, along with other configurations.
ExtractData(String, ExtractDataOptions)Extracts data as a data table, identified by a string from Object Repository, along with other configurations.
ExtractData(IElementDescriptor, ExtractDataOptions)Extracts data as a data table, identified by a descriptor of an element from Object Repository, along with other configurations.
ExtractData(TargetAnchorableModel, String, String, NchildInteractionMode, LimitType, Int32)Extracts data as a data table, identified by the TargetAnchorableModel object, while specifying the XML string defining what data to extract, the table settings, the type of the interaction, the type of limit, and the maximum number of results to be extracted.
ExtractData(IElementDescriptor, String, String, NchildInteractionMode, LimitType, Int32)Extracts data as a data table, identified by a descriptor of an element from Object Repository, while specifying the XML string defining what data to extract, the table settings, the type of the interaction, the type of limit, and the maximum number of results to be extracted.
ExtractData(String, String, String, NchildInteractionMode, LimitType, Int32)Extracts data as a data table, identified by a string from Object Repository, while specifying the XML string defining what data to extract, the table settings, the type of the interaction, the type of limit, and the maximum number of results to be extracted.
ExtractData(TargetAnchorableModel, TargetAnchorableModel, String, String, Double, NchildInteractionMode, LimitType, Int32)Extracts data as a data table, identified by the TargetAnchorableModel object, while specifying the target on the next page, the XML string defining what data to extract, the table settings, the time to wait until the next page is loaded, the type of the interaction, the type of limit, and the maximum number of results to be extracted.
ExtractData(IElementDescriptor, String, String, String, Double, NchildInteractionMode, LimitType, Int32)Extracts data as a data table, identified by a descriptor of an element from Object Repository, while specifying the target on the next page, the XML string defining what data to extract, the table settings, the time to wait until the next page is loaded, the type of the interaction, the type of limit, and the maximum number of results to be extracted.
ExtractData(String, String, String, String, Double, NchildInteractionMode, LimitType, Int32)Extracts data as a data table, identified by a string from Object Repository, while specifying the target on the next page, the XML string defining what data to extract, the table settings, the time to wait until the next page is loaded, the type of the interaction, the type of limit, and the maximum number of results to be extracted.

ExtractData(ExtractDataOptionsModel)​

Extracts data as a data table, identified by the ExtractDataOptionsModel object.

ExtractData(
    ExtractDataOptionsModel options)
ExtractData(
    ExtractDataOptionsModel options)

options ExtractDataOptionsModel : The target to get data from, identified by the ExtractDataOptionsModel object.

ExtractData(TargetAnchorableModel, ExtractDataOptions)​

Extracts data as a data table, identified by the TargetAnchorableModel object, along with other configurations.

ExtractData(
    TargetAnchorableModel target,
    ExtractDataOptions extractDataOptions)
ExtractData(
    TargetAnchorableModel target,
    ExtractDataOptions extractDataOptions)

target TargetAnchorableModel : The target to get data from, identified by the TargetAnchorableModel object.

extractDataOptions ExtractDataOptions : Additional options to customize the data extraction. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `ExtractMetadata` - An XML string that enables you to
  define what data to extract from the target.
* `TableSettings` - The table settings used when
  extracting data.
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `LimitType` - Specifies the type of limit that
  you want to use when extracting data.
* `NumberOfItems` - The maximum number of results to be
  extracted. If the value is 0, all the identified elements are added
  to the output.
* `NextPageOptions` - The target on the next page
  to get data from and the delay between pages.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `ExtractMetadata` - An XML string that enables you to
  define what data to extract from the target.
* `TableSettings` - The table settings used when
  extracting data.
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `LimitType` - Specifies the type of limit that
  you want to use when extracting data.
* `NumberOfItems` - The maximum number of results to be
  extracted. If the value is 0, all the identified elements are added
  to the output.
* `NextPageOptions` - The target on the next page
  to get data from and the delay between pages.

ExtractData(String, ExtractDataOptions)​

Extracts data as a data table, identified by a string from Object Repository, along with other configurations.

ExtractData(
    string target,
    ExtractDataOptions extractDataOptions)
ExtractData(
    string target,
    ExtractDataOptions extractDataOptions)

target String : The target to get data from, identified by a string from Object Repository.

extractDataOptions ExtractDataOptions : Additional options to customize the data extraction. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `ExtractMetadata` - An XML string that enables you to
  define what data to extract from the target.
* `TableSettings` - The table settings used when
  extracting data.
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `LimitType` - Specifies the type of limit that
  you want to use when extracting data.
* `NumberOfItems` - The maximum number of results to be
  extracted. If the value is 0, all the identified elements are added
  to the output.
* `NextPageOptions` - The target on the next page to get
  data from and the delay between pages.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `ExtractMetadata` - An XML string that enables you to
  define what data to extract from the target.
* `TableSettings` - The table settings used when
  extracting data.
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `LimitType` - Specifies the type of limit that
  you want to use when extracting data.
* `NumberOfItems` - The maximum number of results to be
  extracted. If the value is 0, all the identified elements are added
  to the output.
* `NextPageOptions` - The target on the next page to get
  data from and the delay between pages.

ExtractData(IElementDescriptor, ExtractDataOptions)​

Extracts data as a data table, identified by a descriptor of an element from Object Repository, along with other configurations.

ExtractData(
    IElementDescriptor elementDescriptor,
    ExtractDataOptions extractDataOptions)
ExtractData(
    IElementDescriptor elementDescriptor,
    ExtractDataOptions extractDataOptions)

elementDescriptor IElementDescriptor : The target to get data from, identified by a descriptor of an element from Object Repository.

extractDataOptions ExtractDataOptions : Additional options to customize the data extraction. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `ExtractMetadata` - An XML string that enables you to
  define what data to extract from the target.
* `TableSettings` - The table settings used when
  extracting data.
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `LimitType` - Specifies the type of limit that
  you want to use when extracting data.
* `NumberOfItems` - The maximum number of results to be
  extracted. If the value is 0, all the identified elements are added
  to the output.
* `NextPageOptions` - The target on the next page to get
  data from and the delay between pages.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `ExtractMetadata` - An XML string that enables you to
  define what data to extract from the target.
* `TableSettings` - The table settings used when
  extracting data.
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `LimitType` - Specifies the type of limit that
  you want to use when extracting data.
* `NumberOfItems` - The maximum number of results to be
  extracted. If the value is 0, all the identified elements are added
  to the output.
* `NextPageOptions` - The target on the next page to get
  data from and the delay between pages.

ExtractData(TargetAnchorableModel, String, String, NchildInteractionMode, LimitType, Int32)​

Extracts data as a data table, identified by the TargetAnchorableModel object, while specifying the XML string defining what data to extract, the table settings, the type of the interaction, the type of limit, and the maximum number of results to be extracted.

ExtractData(
    TargetAnchorableModel target,
    string extractMetadata,
    [string tableSettings],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])
ExtractData(
    TargetAnchorableModel target,
    string extractMetadata,
    [string tableSettings],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])

target TargetAnchorableModel : The target to get data from, identified by the TargetAnchorableModel object.

extractMetadata String : An XML string that enables you to define what data to extract from the target.

tableSettings String : The table settings used when extracting data.

interactionMode NChildInteractionMode : The type of the interaction to use performing the actions.

limitExtractionTo LimitType : Specifies the type of limit that you want to use when extracting data.

numberOfItems Int32 : The maximum number of results to be extracted. If the value is 0, all the identified elements are added to the output.

ExtractData(String, String, String, NchildInteractionMode, LimitType, Int32)​

Extracts data as a data table, identified by a descriptor of an element from Object Repository, while specifying the XML string defining what data to extract, the table settings, the type of the interaction, the type of limit, and the maximum number of results to be extracted.

ExtractData(
    IElementDescriptor elementDescriptor,
    string extractMetadata,
    [string tableSettings],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])
ExtractData(
    IElementDescriptor elementDescriptor,
    string extractMetadata,
    [string tableSettings],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])

elementDescriptor IElementDescriptor : The target to get data from, identified by a descriptor of an element from Object Repository.

extractMetadata String : An XML string that enables you to define what data to extract from the target.

tableSettings String : The table settings used when extracting data.

interactionMode NChildInteractionMode : The type of the interaction to use performing the actions.

limitExtractionTo LimitType : Specifies the type of limit that you want to use when extracting data.

numberOfItems Int32 : The maximum number of results to be extracted. If the value is 0, all the identified elements are added to the output.

ExtractData(String, String, String, NchildInteractionMode, LimitType, Int32)​

Extracts data as a data table, identified by a string from Object Repository, while specifying the XML string defining what data to extract, the table settings, the type of the interaction, the type of limit, and the maximum number of results to be extracted.

ExtractData(
    string target,
    string extractMetadata,
    [string tableSettings],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])
ExtractData(
    string target,
    string extractMetadata,
    [string tableSettings],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])

target String : The target to get data from, identified by a string from Object Repository.

extractMetadata String : An XML string that enables you to define what data to extract from the target.

tableSettings String : The table settings used when extracting data.

interactionMode NChildInteractionMode : The type of the interaction to use performing the actions.

limitExtractionTo LimitType : Specifies the type of limit that you want to use when extracting data.

numberOfItems Int32 : The maximum number of results to be extracted. If the value is 0, all the identified elements are added to the output.

ExtractData(TargetAnchorableModel, TargetAnchorableModel, String, String, Double, NchildInteractionMode, LimitType, Int32)​

Extracts data as a data table, identified by the TargetAnchorableModel object, while specifying the target on the next page, the XML string defining what data to extract, the table settings, the time to wait until the next page is loaded, the type of the interaction, the type of limit, and the maximum number of results to be extracted.

ExtractData(
    TargetAnchorableModel target,
    TargetAnchorableModel nextPageTarget,
    string extractMetadata,
    [string tableSettings],
    [double delayBetweenPages],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])
ExtractData(
    TargetAnchorableModel target,
    TargetAnchorableModel nextPageTarget,
    string extractMetadata,
    [string tableSettings],
    [double delayBetweenPages],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])

target TargetAnchorableModel : The target to get data from, identified by the TargetAnchorableModel object.

nextPageTarget TargetAnchorableModel : The target on the next page to get data from, identified by the TargetAnchorableModel object.

extractMetadata String : An XML string that enables you to define what data to extract from the target.

tableSettings String : The table settings used when extracting data.

delayBetweenPages Double : The amount of time (in seconds) to wait until the next page is loaded.

interactionMode NChildInteractionMode : The type of the interaction to use performing the actions.

limitExtractionTo LimitType : Specifies the type of limit that you want to use when extracting data.

numberOfItems Int32 : The maximum number of results to be extracted. If the value is 0, all the identified elements are added to the output.

ExtractData(IElementDescriptor, String, String, String, Double, NchildInteractionMode, LimitType, Int32)​

Extracts data as a data table, identified by a descriptor of an element from Object Repository, while specifying the target on the next page, the XML string defining what data to extract, the table settings, the time to wait until the next page is loaded, the type of the interaction, the type of limit, and the maximum number of results to be extracted.

ExtractData(
    IElementDescriptor elementDescriptor,
    string nextPageTarget,
    string extractMetadata,
    [string tableSettings],
    [double delayBetweenPages],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])
ExtractData(
    IElementDescriptor elementDescriptor,
    string nextPageTarget,
    string extractMetadata,
    [string tableSettings],
    [double delayBetweenPages],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])

elementDescriptor IElementDescriptor : The target to get data from, identified by a descriptor of an element from Object Repository.

nextPageTarget String : The target on the next page to get data from, identified by a string from Object Repository.

extractMetadata String : An XML string that enables you to define what data to extract from the target.

tableSettings String : The table settings used when extracting data.

delayBetweenPages Double : The amount of time (in seconds) to wait until the next page is loaded.

interactionMode NChildInteractionMode : The type of the interaction to use performing the actions.

limitExtractionTo LimitType : Specifies the type of limit that you want to use when extracting data.

numberOfItems Int32 : The maximum number of results to be extracted. If the value is 0, all the identified elements are added to the output.

ExtractData(String, String, String, String, Double, NchildInteractionMode, LimitType, Int32)​

Extracts data as a data table, identified by a string from Object Repository, while specifying the target on the next page, the XML string defining what data to extract, the table settings, the time to wait until the next page is loaded, the type of the interaction, the type of limit, and the maximum number of results to be extracted.

ExtractData(
    string target,
    string nextPageTarget,
    string extractMetadata,
    [string tableSettings],
    [double delayBetweenPages],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])
ExtractData(
    string target,
    string nextPageTarget,
    string extractMetadata,
    [string tableSettings],
    [double delayBetweenPages],
    [NChildInteractionMode interactionMode],
    [LimitType limitExtractionTo],
    [int? numberOfItems])

target String : The target to get data from, identified by a string from Object Repository.

nextPageTarget String : The target on the next page to get data from, identified by a string from Object Repository.

extractMetadata String : An XML string that enables you to define what data to extract from the target.

tableSettings String : The table settings used when extracting data.

delayBetweenPages Double : The amount of time (in seconds) to wait until the next page is loaded.

interactionMode NChildInteractionMode : The type of the interaction to use performing the actions.

limitExtractionTo LimitType : Specifies the type of limit that you want to use when extracting data.

numberOfItems Int32 : The maximum number of results to be extracted. If the value is 0, all the identified elements are added to the output.

Return value​

The extracted data in a table format.

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2026 UiPath. All rights reserved.