Unify and manage your data

Configure Data Sharing with MS Fabric using APIs

Learn how to create and configure a Data Share adapter for Microsoft Fabric with REST APIs.

Prerequisites:

  • A valid tenant ID and environment
  • An authentication token with the required role, ROLE_DATA_PIPELINE_ADMIN
  • Details of your Microsoft Fabric environment, including region, receiver email, and whether to share only OV data
  • An active subscription for Data Sharing with MS Fabric
  1. Create a new data share adapter

    Send a request to the Data Pipeline Hub (DPH) service with the configuration details:

    POST {env}-data-pipeline-hub.reltio.com/api/tenants/{tenantId}/adapters
    Where:
    • {env} represents your environment identifier (e.g. dev, prod, test, etc.)
    • {tenantId} is your tenant ID

    This request defines the adapter configuration, including region, whether to share only OV data, and the recipient email addresses via these body parameters:

    ParameterTypeDescription
    typeStringType of adapter. Use datashare-fabric
    nameStringName of the adapter. The name must be alphanumeric, can be 3 to 20 characters in length, and cannot contain any spaces.
    enabledBooleanEnable or disable the adapter
    fabricConfig.regionStringRegion and availability zone of the Fabric instance
    fabricConfig.receiverEmailsArrayEmail address of the recipient of the data share
    fabricConfig.ovOnlyBooleanSet to true to share only OV data. This will also share the data in a simplified schema format, see Schema simplification for Data Share.

    Default is false, to send all data.

    
    POST test-data-pipeline-hub.reltio.com/api/tenants/f4K3XQ7EecQZGBE/adapters
    {
      "type": "datashare-fabric",
      "name": "datashare",
      "enabled": true,
      "fabricConfig": {
        "region": "eastus2",
        "ovOnly": false,
        "receiverEmails": [
          "user1@company.com"
        ]
      }
    }
    
  2. Set up the data share
    Send a request to provision the required MS Fabric resources:
    
    POST {env}-data-pipeline-hub.reltio.com/api/tenants/{tenantId}/adapters/{adapterName}/actions/setup
            
    Where:
    • {env} represents your environment identifier (e.g. dev, prod, test, etc)
    • {tenantId} is your tenant ID
    • {adapterName} is the name you gave your adapter when you created it
  3. Create a data share link
    Send a request to generate a share link that MS Fabric users can use to log in and accept the data share:
    POST {env}-data-pipeline-hub.reltio.com/api/tenants/{tenantId}/adapters/{adapterName}/shareLink
    Where:
    • {env} represents your environment identifier (e.g., dev, , prod, test, etc)
    • {tenantId} is your tenant ID
    • {adapterName} is the name you gave your adapter when you created it
  4. Get the data share link
    Retrieve a previously generated link so the recipients can log in to MS Fabric and accept the data share:
    
    GET {env}-data-pipeline-hub.reltio.com/api/tenants/{tenantId}/adapters/{adapterName}/shareLink
            
    Where:
    • {env} represents your environment identifier (e.g. dev, prod, test, etc)
    • {tenantId} is your tenant ID
    • {adapterName} is the name you gave your adapter when you created it

Your data share adapter is created, set up, and ready to use. Microsoft Fabric recipient can now accept the shared data through the generated link.