Skip to content

Commit 64fea5f

Browse files
authored
Update httpdata-pull-parameterized.md
1 parent 5a76562 commit 64fea5f

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

docs/getting-started/documentation/httpdata-pull-parameterized.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,21 @@
22

33
### Overview
44

5-
In certain scenarios, it is beneficial to be able to provide multiple datasets and data-source APIs through a single asset.
6-
This approach enhances the scalability of the Connector by minimizing the number of contract negotiations and reducing the catalog size.
5+
In certain scenarios, it is beneficial to expose multiple datasets via a single asset, reducing contract negotiations and catalog size, thus improving Connector scalability.
76

87
### Providing Data
98

10-
In this example, multiple datasets of the same API are identified using a unique path parameter but having the same base-url:
9+
A datasource API can be structured with a base URL and path parameters to differentiate datasets:
1110
- `https://example.com/dataset/1`
1211
- `https://example.com/dataset/2`
1312
- `https://example.com/dataset/3`
1413
- `https://example.com/dataset/4`
1514

16-
This implies that the `baseUrl` of all datasets is `https://example.com/dataset/`.
15+
In this case, the base URL remains: `https://example.com/dataset/`.
1716

1817
#### Defining the Asset in the EDC
1918

20-
To enable this example by using a single asset, use the following way to create an asset in the EDC:
19+
To register a **single asset** in the EDC that references multiple datasets, use the following API request:
2120

2221
`POST {{MANAGEMENT-API}}/v3/assets`
2322

@@ -48,16 +47,18 @@ To enable this example by using a single asset, use the following way to create
4847
{% endcode %}
4948

5049
Ensure that `proxyPath` and `proxyQueryParams` are correctly set and enabled `true`.
50+
- `"proxyPath": "true"`: enables path-based dataset retrieval
51+
- `"proxyQueryParams": "true"`: allows dynamic query parameter inclusion
5152

5253
### Consuming Data
5354

54-
#### Querying the Catalog
55+
#### Step 1: Querying the Catalog
5556

5657
To access the dataset, query the provider's EDC catalog and identify the required asset. Extract the following details:
5758
- `dcat:dataset.{asset}.odrl:hasPolicy.@id` - The data offer ID, later to be used for `{{data-offer-id}}`
5859
- `dcat:dataset.{asset}.odrl:hasPolicy.odrl:permission` - The policies in this case permissions, needed to start the negotiation, later used for `{{permissions}}`
5960

60-
#### Negotiating the EDR Token
61+
#### Step 2: Negotiating the EDR Token
6162

6263
Next, request the `EDR token` to access the data plane:
6364

@@ -92,7 +93,7 @@ Extract the `@id` from the response, later to be used for `{{edr-id}}`.
9293
This ID represents the EDR token and is required for the next steps.
9394
Successfully reaching this stage confirms a successful negotiation.
9495

95-
#### Creating the Transfer Process
96+
#### Step 3: Creating the Transfer Process
9697

9798
Use the EDR token ID to retrieve the `transferProcessId`:
9899

@@ -120,7 +121,7 @@ Use the EDR token ID to retrieve the `transferProcessId`:
120121

121122
Copy the `transferProcessId` from the response to proceed, later to be used for `{{transferProcessId}}`.
122123

123-
#### Retrieving the Data Address
124+
#### Step 4: Retrieving the Data Address
124125

125126
To obtain the data address from which the dataset can be requested:
126127

@@ -130,7 +131,7 @@ The response contains two crucial data points:
130131
- `endpoint` – The URL of the data plane providing the requested asset, later to be used for `{{endpoint}}`.
131132
- `authorization` – The authorization information required for data retrieval, e.g. a token.
132133

133-
#### Requesting the Data
134+
#### Step 5: Requesting the Data
134135

135136
Finally, execute a `GET` request using the endpoint and authorization information.
136137

0 commit comments

Comments
 (0)