OSDU® Data Platform Services
Your Express for Energy Data Insights instance includes all of the Core Services provided by the OSDU® Forum.
For more information, see the OSDU® Forum release notes for each platform version:
Release M23- R3 M23
Release M22- R3 M22
OSDU Forum Community References: OSDU® Core Services and APIs
Energy Data Insights URLs
Each instance of the OSDU® Data Platform can be accessed using the
API of each of its services, as outlined below. All Data Platform
services and other interactive components are available beneath a
consistent ENERGY_DATA_INSIGHTS_URL that is unique to your instance.
You can also login to your EDI Data Platform Portal at this URL.
Your ENERGY_DATA_INSIGHTS_URL is:
<your-chosen-subdomain> is the subdomain that you or your
administrator chose while completing the subscription process for
Express for Energy Data Insights. You can also obtain your EDI Data
Platform Portal URL from the notification email that you received when
fulfillment of your subscription completed.
OSDU® Data Platform services reside at
ENERGY_DATA_INSIGHTS_URL/api. You can find the full URL for each
Service by navigating to "Explore Current Implementation" in your EDI
Data Platform Portal, then choosing the card named "Your OSDU®
Service Endpoints".
Authentication
Authentication protects both Data Platform services and underlying AWS cloud provider services. Express for Energy Data Insights uses Amazon Cognito for authentication. To authenticate, you provide your user credentials, resulting in generation of OpenID Connect (OIDC) tokens. Applications included in your EDI Data Platform Portal can then use your OIDC tokens in requests that they issue on your behalf to Data Platform services. You can also copy your OIDC tokens to the clipboard from the EDI Data Platform Portal, so that you can easily use common web service development tools to initiate authenticated requests to the Data Platform.
You can review an example how to authenticate using Amazon Cognito
Legal
Data compliance is largely governed through the Records in the storage service. Though there is an independent legal service and LegalTags entity, these offer no compliance by themselves. Records have a Legal section in their schema and this is where compliance is enforced. However, clients must still make sure they are using the Record service correctly to remain compliant.
You can access the Legal service at:
ENERGY_DATA_INSIGHTS_URL/api/legal/v1
The Legal API supports legaltags and other endpoints defined in the documentation.
OSDU Forum Community References: Legal API, Legal Documentation and additional Legal Documentation
Entitlements
The Entitlements service is used to enable authorization in the OSDU® Data Platform.
The Entitlements service allows groups to be created and users placed in the groups for purposes of data authorization. Those groups can be placed on the manifests of data loaded to control which groups are viewers and owners of the data respectively.
You can access the Entitlements service at:
ENERGY_DATA_INSIGHTS_URL/api/entitlements/v2
The Entitlements API supports groups and other endpoints defined in the documentation.
OSDU Forum Community References: Entitlements API, Entitlements Documentation and additional Entitlements Documentation
Schema
Schema Service enables a centralized governance and management of schema in the Data Ecosystem. It offers an implementation of the schema standard. Schema Service provides all necessary APIs to Fetch, create, update and mark a schema obsolete.
You can access the Entitlements service at:
ENERGY_DATA_INSIGHTS_URL/api/schema-service/v1
The Schema API supports groups and other endpoints defined in the documentation.
OSDU Forum Community References: Schema API and Schema Documentation
Storage
The Storage Service provides a set of APIs to manage the entire metadata life-cycle of ingesting metadata into the Data Platform: (persistence), modification, deletion, versioning and data schema.
You can access the Storage service at:
ENERGY_DATA_INSIGHTS_URL/api/storage/v2
The Storage API supports records and other endpoints as defined in the documentation.
OSDU Forum Community References: Storage API and Storage Documentation
You can review an example created by 47Lining of how to interact with the records endpoint. The process also demonstrates linkage to the Legal and Entitlements services.
Search
The Search API provides a mechanism for indexing documents that contain structured data. Users can search an index, and organize and present search results. Documents and indexes are saved in a separate persistent store optimized for search operations. The Search API can index any number of documents.
The API supports full text search on string fields, range queries on date, numeric or string fields etc. along with geo-spatial search.
You can access the Search service at:
ENERGY_DATA_INSIGHTS_URL/api/search/v2
The Search API supports query and other endpoints defined in the documentation.
OSDU Forum Community References: Search API and Search Documentation
You can review an example created by 47Lining of
how to interact with the search endpoint
using its query method.
Indexer
The Indexer service, indexes the metadata store to support search. The indexer service will automatically take items that are newly added to storage and index the attributes from the schema associated with the kind attribute.
You can access the Indexer service at:
ENERGY_DATA_INSIGHTS_URL/api/indexer/v2/
The Indexer API supports reindex and other endpoints defined in the documentation.
OSDU Forum Community References: Indexer Documentation
Dataset
The Dataset service allows users to register and retrieve datasets in the Data Platform.
You can access the Dataset service at:
ENERGY_DATA_INSIGHTS_URL/api/dataset/v2/
The Dataset API supports getStorageInstructions and other endpoints defined in the documentation.
OSDU Forum Community References: Dataset API and Dataset Documentation
File
The File Service allows users to manage files on the data platform. File Management includes uploads, downloads, creation and retrieval of metadata record for files.
You can access the File service at:
ENERGY_DATA_INSIGHTS_URL/api/file/v2/
The File service API endpoints are defined in the documentation.
OSDU Forum Community References: File API and File Documentation
Partition
The Partition service is responsible for creating and retrieving partition specific properties on behalf of other services whether they are secret values or not. As Partition service APIs are mostly consumed by other services, API access is limited to admins/service accounts only.
You can access the Partition service at:
ENERGY_DATA_INSIGHTS_URL/api/partition/v2/
The Partition API supports partitions and other endpoints defined in the documentation.
OSDU Forum Community References: Partition API and Partition Documentation
Policy
Policy service is an OSDU® service used to manage (view, create, update, delete) and evaluate dynamic policies.
You can access the Policy service at:
ENERGY_DATA_INSIGHTS_URL/api/policy/v1/
The Policy service API endpoints are defined in the documentation.
OSDU Forum Community References: Policy API and Policy Documentation
Register
The high level design of the Register service can conceptually be thought of similar to the 'command' design pattern. Essentially this pattern decouples a trigger from an action. There is often an optional context which can provide the action with data to use in the function, as well as to enable / disable the action for the user (perhaps if the data is not relevant to the action in question).
This service will allow an application to register an action (the function to be triggered). It will expect data (context) to come from the OSDU Data Platform to enable the action, and the application can register a filter (enable/disable) to say what data can be used with this action.
You can access the Register service at:
ENERGY_DATA_INSIGHTS_URL/api/register/v1/
The Register API supports subscription and other endpoints defined in the documentation.
OSDU Forum Community References: Register API, Register Documentation and additional Register Documentation
Secret
The service service in OSDU® is used to facilitate the storage and retrieval of various types of secrets in a specified repository(ies) so that secrets can be secure, separated from the secrets in the infrastructure repository, and be managed easily be interfacing applications.
You can access the Policy service at:
ENERGY_DATA_INSIGHTS_URL/api/secret/v1/
The Secret service API endpoints are defined in the documentation.
OSDU Forum Community References: Secret API and Secret Documentation
Notification
The Notification service, with Register service, allows interested consumers to subscribe to data and metadata changes using a publisher/subscriber pattern.
You can access the Notification service at:
ENERGY_DATA_INSIGHTS_URL/api/notification/v1/
The notification API supports subscription and other endpoints defined in the documentation.
OSDU Forum Community References: Notification API and Notification Documentation