{
"$schema": "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Document.schema.json",
"openResourceDiscovery": "1.12",
"policyLevels": ["sap:core:v1"],
"products": [
{
"ordId": "sap:product:SampleProduct:",
"title": "Some Sample Product for Data Product Evaluation in Business Accelerator Hub",
"shortDescription": "The next generation digital core designed to help you run simple in a digital economy.",
"vendor": "sap:vendor:SAP:"
}
],
"packages": [
{
"ordId": "sap.xref:package:SomePackageDataProduct:v1",
"title": "Sample Package DP",
"shortDescription": "Sample Package for Data Product Evaluation in Business Accelerator Hub",
"description": "...",
"version": "1.0.0",
"vendor": "sap:vendor:SAP:",
"partOfProducts": ["sap:product:SampleProduct:"]
},
{
"ordId": "sap.xref:package:SomePackageIntegrationDependencies:v1",
"title": "Sample Package Integration Dependencies",
"shortDescription": "Sample Package for Data Product Evaluation in Business Accelerator Hub",
"description": "...",
"version": "1.0.0",
"vendor": "sap:vendor:SAP:",
"partOfProducts": ["sap:product:SampleProduct:"]
},
{
"ordId": "sap.xref:package:SomePackageAPIs:v1",
"title": "Sample Package APIs",
"shortDescription": "Sample Package for Data Product Evaluation in Business Accelerator Hub",
"description": "...",
"version": "1.0.0",
"vendor": "sap:vendor:SAP:",
"partOfProducts": ["sap:product:SampleProduct:"]
},
{
"ordId": "sap.xref:package:SomePackageEvents:v1",
"title": "Sample Package Events",
"shortDescription": "Sample Package for Data Product Evaluation in Business Accelerator Hub",
"description": "...",
"version": "1.0.0",
"vendor": "sap:vendor:SAP:",
"partOfProducts": ["sap:product:SampleProduct:"]
}
],
"consumptionBundles": [
{
"ordId": "sap.foo:consumptionBundle:someAuth:v1",
"title": "Protected with some auth",
"shortDescription": "Bundle of resources that...",
"description": "This Consumption Bundle contains all resources that share the same authentication method and access scope",
"version": "1.0.0",
"lastUpdate": "2022-12-19T15:47:04+00:00"
}
],
"dataProducts": [
{
"ordId": "sap.xref:dataProduct:Customer:v1",
"localId": "Customer",
"correlationIds": ["sap.xref:foo:bar"],
"title": "Customer",
"shortDescription": "A deprecated DP example",
"description": "The Customer data product offers access to all customers. And can be very long ........",
"partOfPackage": "sap.xref:package:SomePackageDataProduct:v1",
"visibility": "public",
"releaseStatus": "deprecated",
"version": "1.9.0",
"lastUpdate": "2020-12-08T15:47:04+00:00",
"deprecationDate": "2020-12-08T15:47:04+00:00",
"sunsetDate": "2022-01-08T15:47:04+00:00",
"successors": ["sap.xref:dataProduct:Customer:v2"],
"type": "primary",
"category": "business-object",
"outputPorts": [
{
"ordId": "sap.xref:apiResource:Customer:v1"
}
],
"responsible": "sap:ach:CIC-DP-CO"
},
{
"ordId": "sap.xref:dataProduct:Customer:v2",
"localId": "Customer",
"correlationIds": ["sap.xref:foo:bar"],
"title": "Customer",
"shortDescription": "A minimal DP example",
"description": "The Customer data product offers access to all customers. And can be very long ........",
"partOfPackage": "sap.xref:package:SomePackageDataProduct:v1",
"visibility": "public",
"releaseStatus": "active",
"version": "2.1.0",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"type": "primary",
"category": "business-object",
"outputPorts": [
{
"ordId": "sap.xref:apiResource:Customer:v1"
}
],
"responsible": "sap:ach:CIC-DP-CO"
},
{
"ordId": "sap.xref:dataProduct:CustomerOrder:v1",
"localId": "CustomerOrder",
"correlationIds": ["sap.xref:foo:bar"],
"title": "Customer Order",
"shortDescription": "The full example",
"description": "The data product Customer Order offers access to all online and offline orders submitted by customers. It provides a customer view on the orders. For fulfillment-specific aspects please refer to the data product Fulfillment Order.",
"partOfPackage": "sap.xref:package:SomePackageDataProduct:v1",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"visibility": "public",
"version": "1.4.0",
"releaseStatus": "active",
"changelogEntries": [
{
"date": "2020-04-29",
"description": "## Changelog\n...",
"releaseStatus": "active",
"version": "1.1.3",
"url": "https://www.sap.com/foo/bar"
},
{
"date": "2022-04-29",
"description": "## Changelog\n...",
"releaseStatus": "active",
"version": "1.2.3",
"url": "https://www.sap.com/foo/bar"
}
],
"type": "derived",
"category": "business-object",
"entityTypes": ["sap.odm:entityType:CustomerOrder:v1", "sap.odm:entityType:RetailTransaction:v1"],
"inputPorts": [
{
"ordId": "sap.xref:integrationDependency:CustomerOrder:v1"
}
],
"outputPorts": [
{
"ordId": "sap.xref:apiResource:CustomerOrderHeaderSQLPort:v1"
},
{
"ordId": "sap.xref:apiResource:CustomerOrderDeltaSharing:v1"
},
{
"ordId": "sap.xref:apiResource:CustomerOrderRest:v1"
},
{
"ordId": "sap.xref:eventResource:CustomerOrder:v1"
}
],
"responsible": "sap:ach:CIC-DP-CO",
"dataProductLinks": [
{
"type": "support",
"url": "https://example.com/some/absolute/url"
},
{
"type": "service-level-agreement",
"url": "https://example.com/some/absolute/url"
},
{
"type": "payment",
"url": "https://example.com/some/absolute/url"
},
{
"type": "custom",
"customType": "sap:some-custom-definition-format-type:v1",
"url": "https://example.com/some/absolute/url"
}
],
"links": [
{
"title": "Greatest DP of all time",
"description": "This gives you an overview how a customer is using the data product.\n",
"url": "https://blogs.sap.com/2018/04/11/testing-of-s4hana-inventory-management-odata-apis-via-sap-api-hub/"
}
],
"industry": ["Retail", "Consumer Products"],
"lineOfBusiness": ["Sales"],
"tags": ["CustomerOrder", "Order", "Online Sales", "Offline Sales"],
"labels": {
"label-key-1": ["label-value-1", "label-value-2"]
},
"documentationLabels": {
"Scope Items": [
"[Basic Bank Account Management (BFA)](https://rapid.sap.com/bp/#/scopeitems/BFA \\\" Link To BP \\\")"
]
},
"systemInstanceAware": true
}
],
"integrationDependencies": [
{
"ordId": "sap.xref:integrationDependency:CustomerOrder:v1",
"localId": "CustomerOrder",
"title": "Customer Order Integration Needs",
"shortDescription": "Integration dependency to realize customer order data product",
"description": "This integration dependency describes all the necessary aspects needed for the custom order data product to get data from. ...",
"partOfPackage": "sap.xref:package:SomePackageIntegrationDependencies:v1",
"version": "1.2.3",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"visibility": "public",
"releaseStatus": "active",
"mandatory": true,
"aspects": [
{
"title": "RawCustomerOrder",
"description": "Raw Custom Order Data (For this test case the API reference is not part of this ORD document and will eventually be uploaded to Business Accelerator Hub!)",
"mandatory": true,
"supportMultipleProviders": true,
"apiResources": [
{
"ordId": "sap.s4:apiResource:RawCustomerOrderData:v1"
}
],
"eventResources": [
{
"ordId": "sap.xref:eventResource:RawCustomerOrder:v1",
"minVersion": "1.3.0",
"subset": [
{
"eventType": "sap.xref.Order.OrderTransferred.v1"
}
]
},
{
"ordId": "sap.xref:eventResource:RawCustomerOrder:v2",
"subset": [
{
"eventType": "sap.xref.Order.OrderTransferred.v2"
}
]
}
]
},
{
"title": "RetailTransaction",
"description": "Optional aspect to include retail transactions as customer orders (in this test case the alternative is between different APIs that can be used to injest data",
"mandatory": false,
"apiResources": [
{
"ordId": "sap.xref:apiResource:RetailTransactionOData:v1",
"minVersion": "1.3.3"
},
{
"ordId": "sap.xref:apiResource:RetailTransactionSQL:v2"
}
]
}
]
}
],
"apiResources": [
{
"ordId": "sap.xref:apiResource:CSN_EXPOSURE:v1",
"title": "CSN EXPOSURE Endpoint",
"shortDescription": "Exposing CSN",
"description": "Internal CSN Exposure API",
"version": "1.2.3",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"releaseStatus": "active",
"apiProtocol": "rest",
"visibility": "internal",
"partOfPackage": "sap.xref:package:SomePackageAPIs:v1",
"partOfConsumptionBundles": [
{
"ordId": "sap.foo:consumptionBundle:someAuth:v1"
}
],
"entryPoints": ["./CSN_EXPOSURE"],
"implementationStandard": "sap:csn-exposure:v1",
"resourceDefinitions": [
{
"type": "openapi-v3",
"mediaType": "application/json",
"url": "/api/csn_exposure-oa3.json",
"accessStrategies": [
{
"type": "open"
}
]
}
],
"extensible": {
"supported": "no"
}
},
{
"ordId": "sap.xref:apiResource:RetailTransactionSQL:v2",
"localId": "RetailTransactionSQL",
"title": "Retail Transactions",
"shortDescription": "Exposing Retail Transactions...",
"description": "Retail Transactions SQL API",
"version": "2.2.3",
"releaseStatus": "active",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"visibility": "public",
"partOfPackage": "sap.xref:package:SomePackageAPIs:v1",
"partOfConsumptionBundles": [
{
"ordId": "sap.foo:consumptionBundle:someAuth:v1"
}
],
"entryPoints": ["sap://my.lob.data.platform.endpoint:30015"],
"apiProtocol": "sap-sql-api-v1",
"resourceDefinitions": [
{
"type": "sap-sql-api-definition-v1",
"mediaType": "application/json",
"url": "/api/retail-transaction-sql-v1.json",
"accessStrategies": [
{
"type": "open"
}
]
}
],
"implementationStandard": "sap:hana-cloud-sql:v1",
"supportedUseCases": ["data-federation"],
"exposedEntityTypes": [
{
"ordId": "sap.odm:entityType:RetailTransaction:v1"
},
{
"ordId": "sap.xref:entityType:RetailTransaction:v1"
}
],
"apiResourceLinks": [
{
"type": "api-documentation",
"url": "/some/relative/url"
},
{
"type": "authentication",
"url": "https://example.com/some/absolute/url"
},
{
"type": "service-level-agreement",
"url": "https://example.com/some/absolute/url"
}
],
"extensible": {
"supported": "manual",
"description": "API can be extended by custom fields on the following business contexts (field usage for this API needs to be selected):\r\n* Procurement: Purchasing Document (MM_PURDOC_HEADER)\r\n* Procurement: Purchasing Document Item (MM_PURDOC_ITEM)\r\n\r\n[How to add an extension field to an API](https://help.sap.com/viewer/9a281eac983f4f688d0deedc96b3c61c/latest/en-US/57909455bf7c4fdd8bcf48d76c1eae33.html)"
},
"countries": ["DE", "US"],
"lineOfBusiness": ["Sales"],
"industry": ["Retail", "Consumer Products"],
"tags": ["Commerce"],
"labels": {
"label-key-1": ["label-value-1", "label-value-2"]
},
"documentationLabels": {
"Expected Access Performance ": ["free text/markdown"]
}
},
{
"ordId": "sap.xref:apiResource:RetailTransactionOData:v1",
"localId": "RetailTransactionOData",
"title": "Retail Transactions",
"shortDescription": "Exposing Retail Transactions...",
"description": "Retail Transactions OData API",
"version": "1.2.3",
"releaseStatus": "active",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"visibility": "public",
"partOfPackage": "sap.xref:package:SomePackageAPIs:v1",
"partOfConsumptionBundles": [
{
"ordId": "sap.foo:consumptionBundle:someAuth:v1"
}
],
"entryPoints": ["sap://my.lob.data.platform.endpoint:30015"],
"apiProtocol": "odata-v2",
"resourceDefinitions": [
{
"type": "openapi-v3",
"mediaType": "application/json",
"url": "/api/customer-order-openapi/oas3.json",
"accessStrategies": [
{
"type": "open"
}
]
},
{
"type": "edmx",
"mediaType": "application/xml",
"url": "/api/customer-order-edmx.xml",
"accessStrategies": [
{
"type": "open"
}
]
}
],
"exposedEntityTypes": [
{
"ordId": "sap.odm:entityType:CustomerOrder:v1"
}
],
"extensible": {
"supported": "no"
}
},
{
"ordId": "sap.xref:apiResource:CustomerOrderHeaderSQLPort:v1",
"localId": "CustomerOrderHeaderSQLPort",
"title": "Customer Order",
"shortDescription": "Exposing Customer Order...",
"description": "Customer Order SQL API ...",
"version": "1.2.3",
"releaseStatus": "active",
"visibility": "public",
"partOfPackage": "sap.xref:package:SomePackageAPIs:v1",
"partOfConsumptionBundles": [
{
"ordId": "sap.foo:consumptionBundle:someAuth:v1"
}
],
"entryPoints": ["sap://my.lob.data.platform.endpoint:30015"],
"apiProtocol": "sap-sql-api-v1",
"resourceDefinitions": [
{
"type": "sap-sql-api-definition-v1",
"mediaType": "application/json",
"url": "/api/customer-order-sql-v1.json",
"accessStrategies": [
{
"type": "open"
}
]
}
],
"implementationStandard": "sap:hana-cloud-sql:v1",
"supportedUseCases": ["data-federation"],
"exposedEntityTypes": [
{
"ordId": "sap.odm:entityType:CustomerOrder:v1"
}
],
"apiResourceLinks": [
{
"type": "api-documentation",
"url": "/some/relative/url"
},
{
"type": "authentication",
"url": "https://example.com/some/absolute/url"
},
{
"type": "service-level-agreement",
"url": "https://example.com/some/absolute/url"
}
],
"extensible": {
"supported": "no"
},
"countries": ["DE", "US"],
"lineOfBusiness": ["Sales"],
"industry": ["Retail", "Consumer Products"],
"tags": ["Commerce"],
"labels": {
"label-key-1": ["label-value-1", "label-value-2"]
},
"documentationLabels": {
"Expected Access Performance ": ["free text/markdown"]
}
},
{
"ordId": "sap.xref:apiResource:CustomerOrderDeltaSharing:v1",
"localId": "CustomerOrderDeltaSharing",
"title": "Customer Order",
"shortDescription": "Exposing Customer Order...",
"description": "Customer Order Delta Sharing API ...",
"version": "1.2.3",
"releaseStatus": "active",
"visibility": "public",
"partOfPackage": "sap.xref:package:SomePackageAPIs:v1",
"partOfConsumptionBundles": [
{
"ordId": "sap.foo:consumptionBundle:someAuth:v1"
}
],
"entryPoints": ["sap://my.lob.data.platform.endpoint:30015"],
"apiProtocol": "delta-sharing",
"implementationStandard": "sap:delta-sharing:v1",
"supportedUseCases": ["streaming"],
"exposedEntityTypes": [
{
"ordId": "sap.odm:entityType:CustomerOrder:v1"
}
],
"apiResourceLinks": [
{
"type": "api-documentation",
"url": "/some/relative/url"
},
{
"type": "authentication",
"url": "https://example.com/some/absolute/url"
},
{
"type": "service-level-agreement",
"url": "https://example.com/some/absolute/url"
}
],
"extensible": {
"supported": "no"
},
"countries": ["DE", "US"],
"lineOfBusiness": ["Sales"],
"industry": ["Retail", "Consumer Products"],
"tags": ["Commerce"],
"labels": {
"label-key-1": ["label-value-1", "label-value-2"]
},
"documentationLabels": {
"Expected Access Performance ": ["free text/markdown"]
}
},
{
"ordId": "sap.xref:apiResource:CustomerOrderRest:v1",
"localId": "CustomerOrderRest",
"title": "Customer Order",
"shortDescription": "Exposing Customer Order...",
"description": "Customer Order Rest API ...",
"version": "1.2.3",
"releaseStatus": "active",
"visibility": "public",
"partOfPackage": "sap.xref:package:SomePackageAPIs:v1",
"partOfConsumptionBundles": [
{
"ordId": "sap.foo:consumptionBundle:someAuth:v1"
}
],
"entryPoints": ["sap://my.lob.data.platform.endpoint:30015"],
"apiProtocol": "rest",
"resourceDefinitions": [
{
"type": "openapi-v3",
"mediaType": "application/json",
"url": "/api/customer-order-oas3.json",
"accessStrategies": [
{
"type": "open"
}
]
}
],
"supportedUseCases": ["snapshot"],
"exposedEntityTypes": [
{
"ordId": "sap.odm:entityType:CustomerOrder:v1"
}
],
"apiResourceLinks": [
{
"type": "api-documentation",
"url": "/some/relative/url"
},
{
"type": "authentication",
"url": "https://example.com/some/absolute/url"
},
{
"type": "service-level-agreement",
"url": "https://example.com/some/absolute/url"
}
],
"extensible": {
"supported": "no"
},
"countries": ["DE", "US"],
"lineOfBusiness": ["Sales"],
"industry": ["Retail", "Consumer Products"],
"tags": ["Commerce"],
"labels": {
"label-key-1": ["label-value-1", "label-value-2"]
},
"documentationLabels": {
"Expected Access Performance ": ["free text/markdown"]
}
}
],
"eventResources": [
{
"ordId": "sap.xref:eventResource:RawCustomerOrder:v1",
"version": "1.3.3",
"title": "Raw Customer Order events",
"shortDescription": "Exposing raw events",
"description": "Some longer description understanding that this event is exposing raw Customer Order events",
"releaseStatus": "active",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"visibility": "public",
"partOfPackage": "sap.xref:package:SomePackageEvents:v1",
"resourceDefinitions": [
{
"type": "asyncapi-v2",
"url": "/some/url/events/eventCatalog.json",
"mediaType": "application/json"
}
],
"exposedEntityTypes": [
{
"ordId": "sap.odm:entityType:CustomerOrder:v1"
}
],
"extensible": {
"supported": "no"
}
},
{
"ordId": "sap.xref:eventResource:RawCustomerOrder:v2",
"version": "2.2.3",
"title": "Raw Customer Order events",
"shortDescription": "Exposing raw events",
"description": "Some longer description understanding that this event is exposing raw Customer Order events",
"releaseStatus": "active",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"visibility": "public",
"partOfPackage": "sap.xref:package:SomePackageEvents:v1",
"resourceDefinitions": [
{
"type": "asyncapi-v2",
"url": "/some/url/events/eventCatalog2.json",
"mediaType": "application/json"
}
],
"exposedEntityTypes": [
{
"ordId": "sap.odm:entityType:CustomerOrder:v1"
}
],
"extensible": {
"supported": "no"
}
},
{
"ordId": "sap.xref:eventResource:CustomerOrder:v1",
"version": "1.2.3",
"title": "Aggregated Customer Order events",
"shortDescription": "Exposing events",
"description": "Some longer description understanding that this event is exposing Customer Order events",
"releaseStatus": "active",
"lastUpdate": "2022-12-19T15:47:04+00:00",
"visibility": "public",
"partOfPackage": "sap.xref:package:SomePackageEvents:v1",
"resourceDefinitions": [
{
"type": "asyncapi-v2",
"url": "/some/url/events/eventCatalog2.json",
"mediaType": "application/json"
}
],
"exposedEntityTypes": [
{
"ordId": "sap.odm:entityType:CustomerOrder:v1"
}
],
"extensible": {
"supported": "no"
}
}
]
}