Subscribe

The UiPath Marketplace Guide

Get Report

The Get Report activity uses the SOAP based Reports as a Service (RaaS) to retrieve a specified report (Report URL).

After retrieving the report, the activity outputs the report in a DataTable (Results) and/or in its native String format (Results Native). Additionally, the activity outputs the status of the web service request (success/failure information) in a ResponseStatus object (ResponseStatus) that you can use in subsequent activities (e.g., conditional logic).

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Workday Scope activity to your project.
  3. Add the Get Report activity inside the Workday Scope activity.
  4. Click the Configure button inside the Get Report activity (this opens the Object Wizard).
  5. Enter the Report URL that you want to retrieve.
    • To validate your report URL during design time, click the Get Report button to view the results that will be returned at run time.
  6. Create and enter DataTable, String, and ResponseStatus variables for the Output properties.
    • The request is sent to Reports as a Service (RaaS).
    • The operation returns the DataTable, String, and ResponseStatus values to your output property variables.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes

Details

Type

String

Required

Yes

Default value

Get Report

Allowed values

Enter a String or String variable.

Notes

N/A


Input

ReportURL

The URL of the report that you want to retrieve.

Attributes

Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

To validate your URL during design time, click the Configure button, enter your Report URL, and click Get Report to view the results that will be returned at run time.
For more information, see Accessing RaaS Output in the Workday documentation.


Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes

Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

ResponseStatus

The status of the request (success/failure information).

Attributes

Details

Type

ResponseStatus

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ResponseStatus variable.

UiPath.BAF.Models.ResponseStatus

Notes

The ResponseStatus object includes three properties that you can use in other activities.
Success - Boolean - Specifies whether the API request was successful.
ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
Message - String - The error message.
The example image below shows some of the properties that you can return.


Results

The retrieved report returned in a DataTable object.

Attributes

Details

Type

DataTable

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a DataTable variable.

Notes

This property is not applicable if the ReportURL value specifies one of the following report formats (e.g., .../service/systemreport2/uipath_dpt1/Worker_Details?format=gdata):

  • csv
  • gdata
  • json
  • rss
  • simpelxml
    If the ReportURL includes one of the formats above, use the ResultsNative property.
    During design time, the Object Wizard will always display the report in a table format, regardless of the specified format type.

ResultsNative

The native format of the report returned in a String object.

Attributes

Details

Type

String

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a String variable.

Notes

If the ReportURL value specifies one of the following report formats, the results are returned as a String according to the list below (e.g., .../service/systemreport2/uipath_dpt1/Worker_Details?format=gdata):

  • csv, the results are returned as a String accordingly:
  • csv - comma separated string
  • gdata - json string in gdata format
  • json - json string
  • rss - normal xml string
  • simplexml - simplified xml string
    During design time, the Object Wizard will always display the report in a table format, regardless of the specified format type.

Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guide.

Updated 5 months ago


Get Report


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.