UiPath Documentation
data-service
2023.4
false
Data Service User Guide
  • Getting started
    • Introduction
    • The User Interface
    • Data Service Configuration Checklist
    • Installing Automation Suite
  • Setup and configuration
  • Using Data Service
  • Reference
    • Data Service Studio Activities
    • API access
  • Examples & Tutorials

Creating relationships

Follow these steps to create a relationship between your entities.

  1. In the Entities list, select the entity for which you want to add a relationship.
  2. In the Fields tab, click Create New Field.


  3. In the Create Field panel enter a Display Name in the corresponding field.
  4. Select Relationship from the Type drop-down list.


  5. Select the entity to which you want to create a relationship from the Related Entity drop-down list.


  6. Select the display field to be shown in the user interface from the Related Entity Display Field drop-down list.
  7. Click Save.




The relationship is added as a new field in the Fields tab.

When adding data you can select values from the related entity.



Note: Click View Entry Data to display the Data tab of the related entity in a new browser tab.

Scope restrictions

Relationship scoping rules apply as follows:

  • Tenant-level entities can only be related to other tenant-level entities.
  • Folder-level entities can only be related to entities in folders where the user has access.
  • Cross-scope relationships (Tenant to Folder or Folder to Tenant) are not supported.
Choice sets support the same tenant/folder scoping as entities:
  • Tenant-level choice sets are visible to all users within the tenant.
  • Folder-level choice sets are accessible only within the selected folder.
  • Visibility and usage rules mirror entity scoping for consistent data isolation.
Entity AEntity BSupported
TenantTenantYes
Folder AFolder AYes
Folder AFolder B (accessible)Yes
TenantFolderNo
The following table describes how folder-level scoping affects each role when working with related entities or choice sets.
RoleImpact
Schema DesignerYou must have access to the related entity's or choice set's folder to include it in a schema.
Data ReaderYou must have access to both the parent and related entity folders to query complete data. Without access to both, the related field is omitted from results.
Data WriterYou must have access to both the parent and related entity folders to write to related fields. If access to the related folder is missing, the data write is partial. If a related field is marked Required, the data write fails entirely for users without full access.
Automation DeveloperYou must have access to both the parent and related entity to use that entity in a workflow. Partial access prevents the entity from being used.
Automation UserPermissions are evaluated at execution time. The operation completes fully or partially depending on which folders you have access to at the time of execution.
  • Scope restrictions

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated