Skip to content

OSDU™ Services

Your 47Lining Enterprise PaaS - Preview Deployment includes all of the services provided by the OSDU Forum in the R3 M10 - Milestone Release 10 of the OSDU Data Platform. We also include prerequisite AWS resources that allow each of the OSDU Data Platform services to be deployed.

OSDU Forum Community References: OSDU Core Services and APIs

Preview Deployment URL

You can access each of the services noted below in the context of an instance of a development release of the OSDU Data Platform that is included in your Preview Deployment. Each instance of the OSDU Data Platform can be accessed using the API of each of its services. All OSDU Data Platform services and other interactive components of your Preview Deployment are available beneath a consistent PREVIEW_DEPLOYMENT_URL that is unique to your Preview Deployment. You can also login to your Preview Deployment Portal at your Preview Deployment URL.

Your PREVIEW_DEPLOYMENT_URL is: 

https://<your-chosen-subdomain>.preview.paas.47lining.com

where <your-chosen-subdomain> is the subdomain that you or your administrator chose while completing the subscription process for your Preview Deployment. You can determine your Preview Deployment's subdomain from the 47Lining Subscription Portal. You can also obtain your Preview Deployment URL from the notification email that you received when fulfillment of your subscription completed, prior to initial login to your Preview Deployment Portal.

OSDU Data Platform services within your Preview Deployment reside at PREVIEW_DEPLOYMENT_URL/api. You can find the full URL for each Service by navigating to "Explore Current Implementation" in your Preview Deployment Portal, then choosing the card named "Your OSDU Service Endpoints".

Authentication

Authentication protects both OSDU Data Platform services and underlying AWS cloud provider services. Your preview deployment uses AWS Cognito for Authentication. To authenticate, you provide your user credentials, resulting in generation of OpenID Connect (OIDC) tokens. Applications included in your Preview Deployment Portal can then use your OIDC tokens in requests that they issue on your behalf to OSDU Data Platform services. You can also copy your OIDC tokens to the clipboard from the Preview Deployment Portal, so that you can easily use common web service development tools to initiate authenticated requests to the OSDU Data Platform.

You can review an example created by 47Lining of how to authenticate using Cognito

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 in your Preview Deployment at: PREVIEW_DEPLOYMENT_URL/api/legal/v1

The Legal API supports legaltags and other endpoints defined in the documentation.

OSDU Forum Community References: Legal API and 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 in your Preview Deployment at: PREVIEW_DEPLOYMENT_URL/api/entitlements/v1

The Entitlements API supports groups and other endpoints defined in the documentation.

OSDU Forum Community References: Entitlements API and Entitlements 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 in your Preview Deployemnt at: PREVIEW_DEPLOYMENT_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.

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 in your Preview Deployment at: PREVIEW_DEPLOYMENT_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 in your Preview Deployment at: PREVIEW_DEPLOYMENT_URL/api/indexer/v2/

The Indexer API supports reindex and other endpoints defined in the documentation.

OSDU Forum Community References: Indexer Documentation

Dataset

The OSDU Dataset service allows users to register and retrieve datasets in the OSDU Data Platform.

You can access the Dataset service in your Preview Deployment at: PREVIEW_DEPLOYMENT_URL/api/dataset/v1/

The Dataset API supports getStorageInstructions and other endpoints defined in the documentation.

OSDU Forum Community References: Dataset API

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 in your Preview Deployment at: PREVIEW_DEPLOYMENT_URL/api/partition/v1/

The Partition API supports partitions and other endpoints defined in the documentation.

OSDU Forum Community References: Partition API and Partition 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 in your Preview Deployment at: PREVIEW_DEPLOYMENT_URL/api/register/v1/

The Register API supports subscription and other endpoints defined in the documentation.

OSDU Forum Community References: Register API and Register Documentation

Notification

The Notification service, with Register service, allows interested consumers to subscribe to data and metadata changes using a publisher/subscriber pattern.

OSDU Forum Community References: Notification API and Notification Documentation