IDS Reference Testbed
Ask or search…
K
Links
Comment on page

Guide for Preparing and Validating the Preconfigured Setup

This file explains how to configure connector A and B for the preconfigured setup expected in the user guide. Additionally, it contains instructions how to ensure the correct configuration of those connectors.
All the steps included in this document are automated in a postman collection called "TestBed_Guide.postman_collection.json" available at the IDS_testbed repository.
First, install Postman tool in your environment to automatically execute the provided postman collection.
sudo snap install postman
On success, an output similar to this should be displayed:
It is installed postman (v9/stable) 9.16.0 por Postman, Inc. (postman-inc✓)
In the Activities search bar type Postman and click on the icon to launch the application.
Inside the application click on Import. In the section File click on Upload Files and select the TestbedPreconfiguration.postman_collection.json that is included in the downloaded directory IDS-testbed.
This Postman collection provides the end user with different calls in order to create a full offer at DataspaceconnectorA with all the required dependencies, register connector A and B at Metadata Broker and perform a successful contract negotiation between provider (connector A) and consumer (connector B).

Preconfiguration

Registering Data at connector A

First of all, this section will explain the necessary steps that need to be follow in order to have a data offered at the Connector A of the reference Testbed (Connector A acting as Provider).
The following steps have been extracted from the official documentation guide (https://international-data-spaces-association.github.io/DataspaceConnector/CommunicationGuide/v6/Provider) and have been modified in order to work for the reference Testbed deployment setup.
Setup the Reference Testbed and follow the next steps on Connector A to create a complete resource. Access in a browser https://localhost:8080 and enter in the Swagger UI of connector A.

Register Resource: POST /api/offers

Create a base resource with the following Request Body
{
"title": "DWD Weather Warnings",
"description": "DWD weather warnings for Germany.",
"keywords": [
"DWD"
],
"publisher": "https://dwd.com",
"language": "DE",
"license": "",
"sovereign": "https://dwd.com",
"endpointDocumentation": "",
"paymentModality": "undefined"
}
The response body should give code 201 and should have this structure:
{
"creationDate": "2021-12-15T15:50:58.703+0000",
"modificationDate": "2021-12-15T15:50:58.703+0000",
"title": "DWD Weather Warnings",
"description": "DWD weather warnings for Germany.",
"keywords": [
"DWD"
],
"publisher": "https://dwd.com",
"language": "DE",
"license": "",
"version": 1,
"sovereign": "https://dwd.com",
"endpointDocumentation": "",
"paymentModality": "undefined",
"samples": [],
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991"
},
"contracts": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/contracts{?page,size}",
"templated": true
},
"representations": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/representations{?page,size}",
"templated": true
},
"catalogs": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/catalogs{?page,size}",
"templated": true
},
"subscriptions": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/subscriptions{?page,size}",
"templated": true
},
"brokers": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/brokers{?page,size}",
"templated": true
}
}
}

Create Catalog: POST /api/catalogs

Create a base resource with the following Request body
{
"title": "IDS Catalog",
"description": "This catalog is created from an IDS infomodel catalog."
}
The response body should give code 201 and should have this structure:
{
"creationDate": "2021-12-16T10:08:51.817+0000",
"modificationDate": "2021-12-16T10:08:51.817+0000",
"title": "IDS Catalog",
"description": "This catalog is created from an IDS infomodel catalog.",
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/catalogs/2cd59c94-54e4-4979-9842-36ee45dd354f"
},
"offers": {
"href": "https://localhost:8080/api/catalogs/2cd59c94-54e4-4979-9842-36ee45dd354f/offers{?page,size}",
"templated": true
}
}
}

Add Offer to Catalog: POST /api/catalogs/{id}/offers

Link the created offer to the created catalog.
Insert the catalog id
2cd59c94-54e4-4979-9842-36ee45dd354f
Use the offer as the Request body
[ "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991" ]
The response body should give code 200 and should have this structure:
{
"_embedded": {
"resources": [
{
"creationDate": "2021-12-15T15:50:58.703+0000",
"modificationDate": "2021-12-15T15:50:58.703+0000",
"title": "DWD Weather Warnings",
"description": "DWD weather warnings for Germany.",
"keywords": [
"DWD"
],
"publisher": "https://dwd.com",
"language": "DE",
"license": "",
"version": 1,
"sovereign": "https://dwd.com",
"endpointDocumentation": "",
"paymentModality": "undefined",
"samples": [],
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991"
},
"contracts": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/contracts{?page,size}",
"templated": true
},
"representations": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/representations{?page,size}",
"templated": true
},
"catalogs": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/catalogs{?page,size}",
"templated": true
},
"subscriptions": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/subscriptions{?page,size}",
"templated": true
},
"brokers": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/brokers{?page,size}",
"templated": true
}
}
}
]
},
"_links": {
"self": {
"href": "https://localhost:8080/api/catalogs/2cd59c94-54e4-4979-9842-36ee45dd354f/offers?page=0&size=30"
}
},
"page": {
"size": 30,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}

Generate Usage Control Policy: POST /api/examples/policy

Obtain a usage policy for provide access following the documentation (https://international-data-spaces-association.github.io/DataspaceConnector/Documentation/v6/UsageControl#example-endpoint)
Insert the following Request body
{
"title": "Example Usage Policy",
"description": "Usage policy provide access applied",
"type": "PROVIDE_ACCESS"
}
The response body should give code 200 and should have this structure:
{
"@context": {
"ids": "https://w3id.org/idsa/core/",
"idsc": "https://w3id.org/idsa/code/"
},
"@type": "ids:Permission",
"@id": "https://w3id.org/idsa/autogen/permission/51f5f7e4-f97f-4f91-bc57-b243714642be",
"ids:description": [
{
"@value": "Usage policy provide access applied",
"@type": "http://www.w3.org/2001/XMLSchema#string"
}
],
"ids:title": [
{
"@value": "Example Usage Policy",
"@type": "http://www.w3.org/2001/XMLSchema#string"
}
],
"ids:action": [
{
"@id": "https://w3id.org/idsa/code/USE"
}
]
}

Create Rule: POST /api/rules

Create a rule for provide access usage policy with the following Request body (it is used the provide access usage policy obtained from the previous call).
{
"title": "Example Usage Policy",
"description": "Usage policy provide access applied",
"value": "{\n \"@context\" : {\n \"ids\" : \"https://w3id.org/idsa/core/\",\n \"idsc\" : \"https://w3id.org/idsa/code/\"\n },\n \"@type\" : \"ids:Permission\",\n \"@id\" : \"https://w3id.org/idsa/autogen/permission/51f5f7e4-f97f-4f91-bc57-b243714642be\",\n \"ids:description\" : [ {\n \"@value\" : \"Usage policy provide access applied\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#string\"\n } ],\n \"ids:title\" : [ {\n \"@value\" : \"Example Usage Policy\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#string\"\n } ],\n \"ids:action\" : [ {\n \"@id\" : \"https://w3id.org/idsa/code/USE\"\n } ]\n }"
}
The response body should give code 201 and should have this structure:
{
"creationDate": "2021-12-16T10:22:02.982+0000",
"modificationDate": "2021-12-16T10:22:02.982+0000",
"title": "[\"Example Usage Policy\"^^http://www.w3.org/2001/XMLSchema#string]",
"description": "",
"value": "{\n \"@context\" : {\n \"ids\" : \"https://w3id.org/idsa/core/\",\n \"idsc\" : \"https://w3id.org/idsa/code/\"\n },\n \"@type\" : \"ids:Permission\",\n \"@id\" : \"https://w3id.org/idsa/autogen/permission/51f5f7e4-f97f-4f91-bc57-b243714642be\",\n \"ids:description\" : [ {\n \"@value\" : \"Usage policy provide access applied\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#string\"\n } ],\n \"ids:title\" : [ {\n \"@value\" : \"Example Usage Policy\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#string\"\n } ],\n \"ids:action\" : [ {\n \"@id\" : \"https://w3id.org/idsa/code/USE\"\n } ]\n }",
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802"
},
"contracts": {
"href": "https://localhost:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802/contracts{?page,size}",
"templated": true
}
}
}

Generate Contract Template: POST /api/contracts

Create a contract defining the provider url, the start and end dates at the following Request body
{
"title": "Contract",
"description": "This is an example contract",
"provider":"https://connectora:8080/",
"start": "2021-10-22T07:48:37.068Z",
"end": "2023-10-22T07:48:37.068Z"
}
The response body should give code 201 and should have this structure:
{
"creationDate": "2021-12-16T10:24:10.248+0000",
"modificationDate": "2021-12-16T10:24:10.248+0000",
"title": "Contract",
"description": "This is an example contract",
"start": "2021-12-16T10:24:10.230+0000",
"end": "2023-10-22T07:48:37.068+0000",
"consumer": "",
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea"
},
"rules": {
"href": "https://localhost:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea/rules{?page,size}",
"templated": true
},
"offers": {
"href": "https://localhost:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea/offers{?page,size}",
"templated": true
}
}
}

Add Rule to Contract Template: POST /api/contracts/{id}/rules

Link the created rule to the created contract
Insert the contract id
122355bd-f49a-423e-9a3d-15bd55b639ea
Use the rule as the Request body
[ "https://localhost:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802" ]
The response body should give code 200 and should have this structure:
{
"_embedded": {
"rules": [
{
"creationDate": "2021-12-16T10:22:02.982+0000",
"modificationDate": "2021-12-16T10:22:02.982+0000",
"title": "Example Usage Policy",
"description": "Usage policy provide access applied",
"value": "{\n \"@context\" : {\n \"ids\" : \"https://w3id.org/idsa/core/\",\n \"idsc\" : \"https://w3id.org/idsa/code/\"\n },\n \"@type\" : \"ids:Permission\",\n \"@id\" : \"https://w3id.org/idsa/autogen/permission/51f5f7e4-f97f-4f91-bc57-b243714642be\",\n \"ids:description\" : [ {\n \"@value\" : \"Usage policy provide access applied\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#string\"\n } ],\n \"ids:title\" : [ {\n \"@value\" : \"Example Usage Policy\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#string\"\n } ],\n \"ids:action\" : [ {\n \"@id\" : \"https://w3id.org/idsa/code/USE\"\n } ]\n }",
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802"
},
"contracts": {
"href": "https://localhost:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802/contracts{?page,size}",
"templated": true
}
}
}
]
},
"_links": {
"self": {
"href": "https://localhost:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea/rules?page=0&size=30"
}
},
"page": {
"size": 30,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}

Artifacts: POST /api/artifacts

Create an artifact that contains DWD weather data with the following Request body
{
"title": "Example artifact with weather data",
"description": "This is an example artifact that contains information about weather data",
"value": "{‘type’:’FeatureCollection’,’features’:[{‘type’:’Feature’,’id’:’Autowarn_Analyse.fid-46a27240_180cc7856b1_-1fb6’,’geometry’:null,’geometry_name’:’THE_GEOM’,’properties’:{‘ID’:1667125,’CREATED’:’2022-05-02T21:55:05.285Z’,’ID_ALERT’:’1651528474710.2’,’SOURCE’:’NowCastMIXAnalysis’,’CATEGORY’:’Met’,’EVENT’:’HBN’,’SEVERITY’:’Unknown’,’EC_II’:’HBN’,’EC_GROUP’:’HEARTBEAT’,’EC_AREA_COLOR’:’255 255 255’,’EFFECTIVE’:’2022-05-02T21:54:34Z’,’ONSET’:’2022-05-02T21:50:00Z’,’EXPIRES’:’2022-05-02T21:55:00Z’,’SENDERNAME’:’propHB’,’HEADLINE’:’Heartbeat Event (NowCastMIX)’,’ALTITUDE’:0,’CEILING’:9842.52}}",
"automatedDownload": true
}
The response body should give code 201 and should have this structure:
{
"creationDate": "2021-12-16T10:35:37.850+0000",
"modificationDate": "2021-12-16T10:35:37.850+0000",
"remoteId": "genesis",
"title": "Example artifact with weather data",
"description": "This is an example artifact that contains information about weather data",
"numAccessed": 0,
"byteSize": 761,
"checkSum": 976845905,
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6"
},
"data": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/data"
},
"representations": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/representations{?page,size}",
"templated": true
},
"agreements": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/agreements{?page,size}",
"templated": true
},
"subscriptions": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/subscriptions{?page,size}",
"templated": true
}
}
}

Representations: POST /api/representations

Create a representation with the following Request body
{
"title": "Example Representation",
"description": "",
"mediaType": "json",
"language": "https://w3id.org/idsa/code/EN"
}
The response body should give code 201 and should have this structure:
{
"creationDate": "2021-12-16T10:37:10.751+0000",
"modificationDate": "2021-12-16T10:37:10.751+0000",
"remoteId": "genesis",
"title": "Example Representation",
"description": "",
"mediaType": "json",
"language": "https://w3id.org/idsa/code/EN",
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d"
},
"artifacts": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d/artifacts{?page,size}",
"templated": true
},
"offers": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d/offers{?page,size}",
"templated": true
},
"subscriptions": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d/subscriptions{?page,size}",
"templated": true
}
}
}

Add Artifact to Representation: POST /api/representations/{id}/artifacts

Link the created representation to the created artifact
Insert the representation id
b734b25b-042f-462e-8203-6c8f2ba6852d
Use the artifact as the Request body
[ "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6" ]
The response body should give code 200 and should have this structure:
{
"_embedded": {
"artifacts": [
{
"creationDate": "2021-12-16T10:35:37.850+0000",
"modificationDate": "2021-12-16T10:35:37.850+0000",
"remoteId": "genesis",
"title": "Example artifact with weather data",
"description": "This is an example artifact that contains information about weather data",
"numAccessed": 0,
"byteSize": 761,
"checkSum": 976845905,
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6"
},
"data": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/data"
},
"representations": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/representations{?page,size}",
"templated": true
},
"agreements": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/agreements{?page,size}",
"templated": true
},
"subscriptions": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/subscriptions{?page,size}",
"templated": true
},
"route": {
"href": "https://localhost:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6/route"
}
}
}
]
},
"_links": {
"self": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d/artifacts?page=0&size=30"
}
},
"page": {
"size": 30,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}

Add Representation to Offer: POST /api/offers/{id}/representations

Link the created representation to the created offer.
Insert the offer id
03735877-0111-49a4-b20d-51734c81a991
Use the representation as the Request body
[ "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d" ]
The response body should give code 200 and should have this structure:
{
"_embedded": {
"representations": [
{
"creationDate": "2021-12-16T10:37:10.751+0000",
"modificationDate": "2021-12-16T10:37:10.751+0000",
"remoteId": "genesis",
"title": "Example Representation",
"description": "",
"mediaType": "json",
"language": "https://w3id.org/idsa/code/EN",
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d"
},
"artifacts": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d/artifacts{?page,size}",
"templated": true
},
"offers": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d/offers{?page,size}",
"templated": true
},
"subscriptions": {
"href": "https://localhost:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d/subscriptions{?page,size}",
"templated": true
}
}
}
]
},
"_links": {
"self": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/representations?page=0&size=30"
}
},
"page": {
"size": 30,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}

Add Contract to Offer: POST /api/offers/{id}/contracts

Link the created contract to the created offer.
Insert the offer id
03735877-0111-49a4-b20d-51734c81a991
Use the contract as the Request body
[ "https://localhost:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea" ]
The response body should give code 200 and should have this structure:
{
"_embedded": {
"contracts": [
{
"creationDate": "2021-12-16T10:24:10.248+0000",
"modificationDate": "2021-12-16T10:24:10.248+0000",
"title": "Contract",
"description": "This is an example contract",
"start": "2021-12-16T10:24:10.230+0000",
"end": "2023-10-22T07:48:37.068+0000",
"consumer": "",
"additional": {},
"_links": {
"self": {
"href": "https://localhost:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea"
},
"rules": {
"href": "https://localhost:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea/rules{?page,size}",
"templated": true
},
"offers": {
"href": "https://localhost:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea/offers{?page,size}",
"templated": true
}
}
}
]
},
"_links": {
"self": {
"href": "https://localhost:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991/contracts?page=0&size=30"
}
},
"page": {
"size": 30,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}

Register Connector A at MetaData Broker: POST /api/ids/connector/update

At the Swagger UI of Connector A insert the following recipient url for message POST /api/ids/connector/update:
https://broker-reverseproxy/infrastructure
The server response should give code 200.

Register Connector B at MetaData Broker: POST /api/ids/connector/update

At the Swagger UI of the Connector B insert the following recipient url for message POST /api/ids/connector/update:
https://broker-reverseproxy/infrastructure
The server response should give code 200.

Validating Preconfigured Setup: Interaction between Connectors

This section will explain the necessary steps that need to be follow in order to request data from Connector A (acting as data provider) using Connector B (acting as data consumer). The following steps have been extracted from the official documentation guide (https://international-data-spaces-association.github.io/DataspaceConnector/CommunicationGuide/v6/Consumer) and have been modified in order to work for the reference Testbed deployment setup.
With the Reference Testbed setup, follow the next steps on Connector B to obtain data from Connector A. Access in a browser https://localhost:8081 and conduct the following steps in the Swagger UI of connector B.

Request Self-description from Connector A: POST /api/ids/description

Request the self-description of Connector A utilizing POST /api/ids/description.
Insert the recipient url of Connector A
https://connectora:8080/api/ids/data
Left the elementId empty because the id of the requested resource is not known.
The response body should give code 200 and be euqivalent to the following:
{
"@context" : {
"ids" : "https://w3id.org/idsa/core/",
"idsc" : "https://w3id.org/idsa/code/"
},
"@type" : "ids:BaseConnector",
"@id" : "https://connector_A",
"ids:version" : "7.0.1",
"ids:description" : [ {
"@value" : "IDS Connector A with static example resources",
"@type" : "http://www.w3.org/2001/XMLSchema#string"
} ],
"ids:publicKey": {
"@type": "ids:PublicKey",
"@id": "https://w3id.org/idsa/autogen/publicKey/78eb73a3-3a2a-4626-a0ff-631ab50a00f9",
"ids:keyType": {
"@id": "https://w3id.org/idsa/code/RSA"
},
"ids:keyValue": "VFVsSlFrbHFRVTVDWjJ0eGFHdHBSemwzTUVKQlVVVkdRVUZQUTBGUk9FRk5TVWxDUTJkTFEwRlJSVUYxZHpadFJuSmtabXhZV2xSS1owWlBRVFZ6YlVSWVF6QTVVMjF3U2xkdlIzQjVSVkphVGtWNU16RndTMlJ6VWtkb1ZHbHdVakkzYWpscGNtMXRjV2xvZGpkblNXZDZRMjU0Tm10SlVrNUhTVEoxTUc5R1VUVkdaM1pQTVhoNFozcGphV2hrY0VZd1EyaGxUMlk1U1U1bmFYTlFhM0UxYUdvNFFXVXZSRmxZYTNacWFGRTJZelpoYXk5YVdXWnFNRTV3Y1hsRlVHTktOVTFNVW0xWlIyVjRUV0ZOV20xVVluRkVTblpLYkRWS1J6TXJZa1V6V1dFeU1XaFVXbGxQZUdsVGFXTndaa1puU2pNd2EyNDFZVlZKUVhSa01EVkpXbmszZWpGelJHbFdUSFJVV0d4TVptVXZXbEZETkhCdWFrWjBjeXQwWXpFeWMxZzVhV2hKYlc1RGEyUXdWM1o2TTBOVVdtOTVRbE56WXpGVVpFSnJZamx0TUVNMWRIWm5NR1pSVURSUlowWXZla2d5VVc5YWJtNXlTVFV5ZFVGYU9FMXZiVmQwV1RKc2RETkVNR3RyY0ZJMk9YQm1Wa1JLTjNremRrNHZaWGRKUkVGUlFVST0="
},
"ids:title" : [ {
"@value" : "Dataspace Connector",
"@type" : "http://www.w3.org/2001/XMLSchema#string"
} ],
"ids:hasDefaultEndpoint" : {
"@type" : "ids:ConnectorEndpoint",
"@id" : "https://w3id.org/idsa/autogen/connectorEndpoint/e5e2ab04-633a-44b9-87d9-a097ae6da3cf",
"ids:accessURL" : {
"@id" : "https://connectora:8080/api/ids/data"
}
},
"ids:resourceCatalog" : [ {
"@type" : "ids:ResourceCatalog",
"@id" : "https://connectora:8080/api/catalogs/2cd59c94-54e4-4979-9842-36ee45dd354f"
} ],
"ids:securityProfile" : {
"@id" : "https://w3id.org/idsa/code/BASE_SECURITY_PROFILE"
},
"ids:maintainer": {
"@id": "https://www.isst.fraunhofer.de/"
},
"ids:curator": {
"@id": "https://www.isst.fraunhofer.de/"
},
"ids:inboundModelVersion": [
"4.2.6",
"4.2.7",
"4.2.0",
"4.1.2",
"4.2.1",
"4.0.0",
"4.1.0",
"4.2.4",
"4.2.5",
"4.2.2",
"4.2.3"
],
"ids:outboundModelVersion": "4.2.7"
}
From this Response body obtain the resource catalog @id
https://connectora:8080/api/catalogs/2cd59c94-54e4-4979-9842-36ee45dd354f

Request Information regarding the desired resource: POST /api/ids/description

Request the specific resource catalog of Connector A using POST /api/ids/description
Insert the recipient url of Connector A (recipient)
https://connectora:8080/api/ids/data
Insert the id of the requested resource (elementId)
https://connectora:8080/api/catalogs/2cd59c94-54e4-4979-9842-36ee45dd354f
The response body should give code 200 and should have this structure:
{
"@context" : {
"ids" : "https://w3id.org/idsa/core/",
"idsc" : "https://w3id.org/idsa/code/"
},
"@type" : "ids:ResourceCatalog",
"@id" : "https://connectora:8080/api/catalogs/2cd59c94-54e4-4979-9842-36ee45dd354f",
"ids:offeredResource" : [ {
"@type" : "ids:Resource",
"@id" : "https://connectora:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991",
"ids:version": "1",
"ids:language": [
{"@id": "https://w3id.org/idsa/code/DE"
}],
"ids:description" : [ {
"@value" : "DWD weather warnings for Germany.",
"@language" : "DE"
} ],
"ids:title" : [ {
"@value" : "DWD Weather Warnings",
"@language" : "DE"
} ],
"ids:representation" : [ {
"@type" : "ids:Representation",
"@id" : "https://connectora:8080/api/representations/b734b25b-042f-462e-8203-6c8f2ba6852d",
"ids:mediaType" : {
"@type" : "ids:IANAMediaType",
"@id" : "https://w3id.org/idsa/autogen/iANAMediaType/bbd0d6d4-0fb2-4d68-a941-6bef561a334f",
"ids:filenameExtension" : "json"
},
"ids:language" : {
"@id" : "https://w3id.org/idsa/code/EN"
},
"ids:instance" : [ {
"@type" : "ids:Artifact",
"@id" : "https://connectora:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6",
"ids:fileName" : "Example artifact with weather data",
"ids:creationDate" : {
"@value" : "2021-12-16T10:35:37.850Z",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:byteSize" : 761,
"ids:checkSum" : "976845905"
} ],
"ids:created" : {
"@value" : "2021-12-15T15:50:58.703Z",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:modified" : {
"@value" : "2021-12-15T15:50:58.703Z",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:representationStandard": {
"@id": ""
}}],
"ids:publisher": {"@id": "https://dwd.com"},
"ids:sovereign": {"@id": "https://dwd.com"},
"ids:created" : {
"@value" : "2021-12-15T15:50:58.703Z",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:standardLicense": {"@id": ""},
"ids:resourceEndpoint" : [ {
"@type" : "ids:ConnectorEndpoint",
"@id" : "https://w3id.org/idsa/autogen/connectorEndpoint/e3e0fb5a-f0bd-4c29-8200-f6c8e138d04c",
"ids:endpointDocumentation": [{"@id": ""}],
"ids:accessURL" : {
"@id" : "https://connectora:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991"
}}],
"ids:contractOffer" : [ {
"@type" : "ids:ContractOffer",
"@id" : "https://connectora:8080/api/contracts/122355bd-f49a-423e-9a3d-15bd55b639ea",
"ids:provider": {"@id": "https://connectora:8080/"},
"ids:permission" : [ {
"@type" : "ids:Permission",
"@id" : "https://connectora:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802",
"ids:description" : [ {
"@value" : "Usage policy provide access applied",
"@type" : "http://www.w3.org/2001/XMLSchema#string"
} ],
"ids:title" : [ {
"@value" : "Example Usage Policy",
"@type" : "http://www.w3.org/2001/XMLSchema#string"
} ],
"ids:action" : [ {
"@id" : "https://w3id.org/idsa/code/USE"
} ],
} ],
"ids:consumer" : {
"@id" : ""
},
"ids:contractEnd" : {
"@value" : "2023-10-22T07:48:37.068Z",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:contractStart" : {
"@value" : "2021-12-16T10:24:10.230Z",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:contractDate" : {
"@value" : "2021-12-16T13:20:30.521Z",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
}}],
"ids:keyword" : [ {
"@value" : "DWD",
"@language" : "DE"
} ],
"ids:modified" : {
"@value" : "2021-12-16T10:37:10.751Z",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
}}]
}
From this response body it is obtained the necessary information in order to negotiate the contract (Connector A: offer id, artifact id, rule id)
https://connectora:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991
https://connectora:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802
https://connectora:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6

Start Negotiation: POST /api/ids/contract

Send IDS contract request message POST /api/ids/contract.
Insert the recipient url of Connector A (recipient)
https://connectora:8080/api/ids/data
Insert the ids resource that should be requested (resourceIds)
https://connectora:8080/api/offers/03735877-0111-49a4-b20d-51734c81a991
Insert the artifact that should be requested (artifactIds)
https://connectora:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6
Put the connector automatically download data of an artifact to False (download)
false
The request body must contain a contract offer, this contract must match the one the resource was created with. Therefore, it is a policy with a USE permission. The rule list will be automatically turned into a contract request to then send it to the provider. This will read this contract request, compare it to the artifact’s (respectively the corresponding resource’s) contract offers, and return either a ContractRejectionMessage or a ContractAgreementMessage.
Include in it the id of the Connector A rule and as ids:target the artifact.
[ {
"@type" : "ids:Permission",
"@id" : "https://connectora:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802",
"ids:description" : [ {
"@value" : "Usage policy provide access applied",
"@type" : "http://www.w3.org/2001/XMLSchema#string"
} ],
"ids:title" : [ {
"@value" : "Example Usage Policy",
"@type" : "http://www.w3.org/2001/XMLSchema#string"
} ],
"ids:action" : [ {
"@id" : "https://w3id.org/idsa/code/USE"
}],
"ids:target" : "https://connectora:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6"
} ]
The response body should give code 201 and should have this structure:
{
"creationDate": "2021-12-16T13:27:38.959+0000",
"modificationDate": "2021-12-16T13:27:38.959+0000",
"remoteId": "https://connectora:8080/api/agreements/01c29b32-b202-46d3-ade1-e9401b43ed0f",
"confirmed": true,
"value": "{\n \"@context\" : {\n \"ids\" : \"https://w3id.org/idsa/core/\",\n \"idsc\" : \"https://w3id.org/idsa/code/\"\n },\n \"@type\" : \"ids:ContractAgreement\",\n \"@id\" : \"https://connectora:8080/api/agreements/d01c29b32-b202-46d3-ade1-e9401b43ed0f\",\n \"ids:provider\" : {\n \"@id\" : \"https://connector_A\"\n },\n \"ids:permission\" : [ {\n \"@type\" : \"ids:Permission\",\n \"@id\" : \"https://connectora:8080/api/rules/fac53177-3e4c-45cf-bdfc-181c3f3e3802\",\n \"ids:description\" : [ {\n \"@value\" : \"Usage policy provide access applied\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#string\"\n } ],\n \"ids:title\" : [ {\n \"@value\" : \"Example Usage Policy\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#string\"\n } ],\n \"ids:assignee\" : [ {\n \"@id\" : \"https://connector_B\"\n } ],\n \"ids:assigner\" : [ {\n \"@id\" : \"https://connector_A\"\n } ],\n \"ids:action\" : [ {\n \"@id\" : \"https://w3id.org/idsa/code/USE\"\n } ],\n \"ids:target\" : {\n \"@id\" : \"https://connectora:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6\"\n }\n } ],\n \"ids:consumer\" : {\n \"@id\" : \"https://connector_B\"\n },\n \"ids:contractEnd\" : {\n \"@value\" : \"2023-10-22T07:48:37.068Z\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#dateTimeStamp\"\n },\n \"ids:contractStart\" : {\n \"@value\" : \"2021-12-16T13:27:37.868Z\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#dateTimeStamp\"\n },\n \"ids:contractDate\" : {\n \"@value\" : \"2021-12-16T13:27:37.868Z\",\n \"@type\" : \"http://www.w3.org/2001/XMLSchema#dateTimeStamp\"\n }\n}",
"_links": {
"self": {
"href": "https://localhost:8081/api/agreements/3a638d21-07fb-40a0-be14-bea6d353825e"
},
"artifacts": {
"href": "https://localhost:8081/api/agreements/3a638d21-07fb-40a0-be14-bea6d353825e/artifacts{?page,size}",
"templated": true
}
}
}
From this response body it is obtained the Connector B agreement
https://localhost:8081/api/agreements/3a638d21-07fb-40a0-be14-bea6d353825e

Request the Artifact based on the Existing Agreement: POST /api/agreements/{id}/artifacts

To get the artifact and their data link, make the following request: POST /api/agreements/{id}/artifacts
Insert the agreement id
3a638d21-07fb-40a0-be14-bea6d353825e
The response body should give code 200 and should have this structure:
{
"_embedded": {
"artifacts": [
{
"creationDate": "2021-12-16T13:27:40.183+0000",
"modificationDate": "2021-12-16T15:32:57.815+0000",
"remoteId": "https://connectora:8080/api/artifacts/d5eb7f14-b99b-4bbf-94e7-4e612a4ccac6",
"title": "Example artifact with weather data",
"description": "",
"numAccessed": 0,
"byteSize": 0,
"checkSum": 0,
"additional": {
"ids:byteSize": "761",
"ids:creationDate":