Provides an overview of the Data Sharing module
What is Data Sharing Datahub API
Use the Data Sharing API from Scalar to share asset data of one SCALAR organization with other SCALAR organizations. You can create new framework agreements for both existing and non-existing SCALAR organizations.
Framework Agreement includes basic details, such as the identity of the data provider and data consumer, data sharing preferences, the entity (asset/unit), and payer details. Consumer details will be fetched using the consumer shared OTP (One Time Password/Passcode).
The users can onboard their partners to SCALAR while creating the framework agreement when the user is going to own his partner organizations in SCALAR. In this case, the framework Agreement includes basic details such as the identity of the data provider and data sharing preferences, the entity (asset/unit), and payer details (Provider himself) along with that consumer details, using which we need to onboard the consumer/partner to SCALAR. You can use provider organization profile details to clone the provider organization settings to consumer organization.
Base URL | https://data-sharing/api.eu1.dev.scalar.zf.com |
Audience | DASAPI, API |
Supported Versions | V1 |
Why use Data Sharing?
Purpose I: Manage Framework Agreements
SCALAR allows you view and manage Framework Agreements. You can fetch list Framework Agreements or a specific Framework Agreement by providing a specific ID and create new Framework Agreements.
Purpose II: Manage Contracts
SCALAR allows you manage contracts. You can create contracts and retrieve list of contracts or a specific contract by providing specific ID and create contracts.
Purpose III: Manage Sessions
SCALAR allows you manage sessions. You can retrieve list of sessions or a specific session by providing specific ID, create contracts, and update details of sessions.
Purpose IV: Manage Actions
SCALAR allows you manage actions. You can stop framework agreements, stop contracts, start and stop sessions, extend contracts, approve or reject framework agreements.
Purpose V: Retrieve profile details of an organization
SCALAR allows you retrieve profile ID and name of an organization.
Use Cases
Use case I: Creating framework agreements
- New framework agreements are created for the specific organization. The framework Agreement includes basic details such as the identity of the data provider and data consumer, data sharing preferences, the entity (asset/unit), and payer details.
- For inviting consumers, users can choose a preconfigured profile to onboard consumers. If a user wants to onboard their partners to SCALAR, they can use DATA SHARING framework agreement.
Use case II: Creating contracts
Create new contracts for data sharing.