How to Build Dataspaces?
Main IDSA Assets
Other Resources

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": "2024-05-29T10:36:09.482+0000",
    "modificationDate": "2024-05-29T10:36:09.482+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/6c052834-4a59-474e-9a6f-ba8291f91ae6"
        },
        "contracts": {
            "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/contracts{?page,size}",
            "templated": true
        },
        "representations": {
            "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/representations{?page,size}",
            "templated": true
        },
        "catalogs": {
            "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/catalogs{?page,size}",
            "templated": true
        },
        "subscriptions": {
            "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/subscriptions{?page,size}",
            "templated": true
        },
        "brokers": {
            "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/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": "2024-05-29T10:37:36.346+0000",
    "modificationDate": "2024-05-29T10:37:36.346+0000",
    "title": "IDS Catalog",
    "description": "This catalog is created from an IDS infomodel catalog.",
    "additional": {},
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/catalogs/824d97c3-d9e8-404f-8659-e89f3f7bf3fa"
        },
        "offers": {
            "href": "https://localhost:8080/api/catalogs/824d97c3-d9e8-404f-8659-e89f3f7bf3fa/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

824d97c3-d9e8-404f-8659-e89f3f7bf3fa

Use the offer as the Request body

[ "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6" ]

The response body should give code 200 and should have this structure:

{
    "_embedded": {
        "resources": [
            {
                "creationDate": "2024-05-29T10:36:09.482+0000",
                "modificationDate": "2024-05-29T10:36:09.482+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/6c052834-4a59-474e-9a6f-ba8291f91ae6"
                    },
                    "contracts": {
                        "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/contracts{?page,size}",
                        "templated": true
                    },
                    "representations": {
                        "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/representations{?page,size}",
                        "templated": true
                    },
                    "catalogs": {
                        "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/catalogs{?page,size}",
                        "templated": true
                    },
                    "subscriptions": {
                        "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/subscriptions{?page,size}",
                        "templated": true
                    },
                    "brokers": {
                        "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/brokers{?page,size}",
                        "templated": true
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/catalogs/824d97c3-d9e8-404f-8659-e89f3f7bf3fa/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": "2024-05-29T10:40:18.525+0000",
    "modificationDate": "2024-05-29T10:40:18.525+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/c873c14a-7ada-456b-998b-1bd0f8a46060"
        },
        "contracts": {
            "href": "https://localhost:8080/api/rules/c873c14a-7ada-456b-998b-1bd0f8a46060/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": "2023-10-22T07:48:37.068Z",
    "end": "2028-10-22T07:48:37.068Z"
}

The response body should give code 201 and should have this structure:

{
    "creationDate": "2024-05-29T10:40:57.025+0000",
    "modificationDate": "2024-05-29T10:40:57.025+0000",
    "title": "Contract",
    "description": "This is an example contract",
    "start": "2023-10-22T07:48:37.068+0000",
    "end": "2028-10-22T07:48:37.068+0000",
    "consumer": "",
    "additional": {},
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435"
        },
        "rules": {
            "href": "https://localhost:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435/rules{?page,size}",
            "templated": true
        },
        "offers": {
            "href": "https://localhost:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435/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

247ef8d0-d053-4069-90bf-e8aab7908435

Use the rule as the Request body

[ "https://localhost:8080/api/rules/c873c14a-7ada-456b-998b-1bd0f8a46060" ]

The response body should give code 200 and should have this structure:

{
    "_embedded": {
        "rules": [
            {
                "creationDate": "2024-05-29T10:40:18.525+0000",
                "modificationDate": "2024-05-29T10:40:18.525+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/c873c14a-7ada-456b-998b-1bd0f8a46060"
                    },
                    "contracts": {
                        "href": "https://localhost:8080/api/rules/c873c14a-7ada-456b-998b-1bd0f8a46060/contracts{?page,size}",
                        "templated": true
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435/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": "2024-05-29T10:43:02.929+0000",
    "modificationDate": "2024-05-29T10:43:02.929+0000",
    "remoteId": "genesis",
    "title": "Example artifact with weather data",
    "description": "This is an example artifact that contains information about weather data",
    "numAccessed": 0,
    "byteSize": 456,
    "checkSum": 1078006432,
    "additional": {},
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182"
        },
        "data": {
            "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/data"
        },
        "representations": {
            "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/representations{?page,size}",
            "templated": true
        },
        "agreements": {
            "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/agreements{?page,size}",
            "templated": true
        },
        "subscriptions": {
            "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/subscriptions{?page,size}",
            "templated": true
        },
        "route": {
            "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/route"
        }
    }
}

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": "2024-05-29T10:43:25.197+0000",
    "modificationDate": "2024-05-29T10:43:25.197+0000",
    "remoteId": "genesis",
    "title": "Example Representation",
    "description": "",
    "mediaType": "application/json",
    "language": "https://w3id.org/idsa/code/EN",
    "additional": {},
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e"
        },
        "artifacts": {
            "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e/artifacts{?page,size}",
            "templated": true
        },
        "offers": {
            "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e/offers{?page,size}",
            "templated": true
        },
        "subscriptions": {
            "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e/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

8d99b0d5-3f93-479d-9551-ab74d500018e

Use the artifact as the Request body

[ "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182" ]

The response body should give code 200 and should have this structure:

{
    "_embedded": {
        "artifacts": [
            {
                "creationDate": "2024-05-29T10:43:02.929+0000",
                "modificationDate": "2024-05-29T10:43:02.929+0000",
                "remoteId": "genesis",
                "title": "Example artifact with weather data",
                "description": "This is an example artifact that contains information about weather data",
                "numAccessed": 0,
                "byteSize": 456,
                "checkSum": 1078006432,
                "additional": {},
                "_links": {
                    "self": {
                        "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182"
                    },
                    "data": {
                        "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/data"
                    },
                    "representations": {
                        "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/representations{?page,size}",
                        "templated": true
                    },
                    "agreements": {
                        "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/agreements{?page,size}",
                        "templated": true
                    },
                    "subscriptions": {
                        "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/subscriptions{?page,size}",
                        "templated": true
                    },
                    "route": {
                        "href": "https://localhost:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182/route"
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e/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

6c052834-4a59-474e-9a6f-ba8291f91ae6

Use the representation as the Request body

[ "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e" ]

The response body should give code 200 and should have this structure:

{
    "_embedded": {
        "representations": [
            {
                "creationDate": "2024-05-29T10:43:25.197+0000",
                "modificationDate": "2024-05-29T10:43:25.197+0000",
                "remoteId": "genesis",
                "title": "Example Representation",
                "description": "",
                "mediaType": "application/json",
                "language": "https://w3id.org/idsa/code/EN",
                "additional": {},
                "_links": {
                    "self": {
                        "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e"
                    },
                    "artifacts": {
                        "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e/artifacts{?page,size}",
                        "templated": true
                    },
                    "offers": {
                        "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e/offers{?page,size}",
                        "templated": true
                    },
                    "subscriptions": {
                        "href": "https://localhost:8080/api/representations/8d99b0d5-3f93-479d-9551-ab74d500018e/subscriptions{?page,size}",
                        "templated": true
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/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

6c052834-4a59-474e-9a6f-ba8291f91ae6

Use the contract as the Request body

[ "https://localhost:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435" ]

The response body should give code 200 and should have this structure:

{
    "_embedded": {
        "contracts": [
            {
                "creationDate": "2024-05-29T10:40:57.025+0000",
                "modificationDate": "2024-05-29T10:40:57.025+0000",
                "title": "Contract",
                "description": "This is an example contract",
                "start": "2023-10-22T07:48:37.068+0000",
                "end": "2028-10-22T07:48:37.068+0000",
                "consumer": "",
                "additional": {},
                "_links": {
                    "self": {
                        "href": "https://localhost:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435"
                    },
                    "rules": {
                        "href": "https://localhost:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435/rules{?page,size}",
                        "templated": true
                    },
                    "offers": {
                        "href": "https://localhost:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435/offers{?page,size}",
                        "templated": true
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://localhost:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6/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": "8.0.2",
    "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/824d97c3-d9e8-404f-8659-e89f3f7bf3fa"
        }
    ],
    "ids:securityProfile": {
        "@id": "https://w3id.org/idsa/code/BASE_SECURITY_PROFILE"
    },
    "ids:maintainer": {
        "@id": "https://sovity.de/"
    },
    "ids:curator": {
        "@id": "https://sovity.de/"
    },
    "ids:inboundModelVersion": [
        "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",
        "4.2.6",
        "4.2.7"
    ],
    "ids:outboundModelVersion": "4.2.7"
}

From this Response body obtain the resource catalog @id

https://connectora:8080/api/catalogs/824d97c3-d9e8-404f-8659-e89f3f7bf3fa

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/824d97c3-d9e8-404f-8659-e89f3f7bf3fa

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/824d97c3-d9e8-404f-8659-e89f3f7bf3fa",
    "ids:offeredResource": [
        {
            "@type": "ids:Resource",
            "@id": "https://connectora:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6",
            "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/8d99b0d5-3f93-479d-9551-ab74d500018e",
                    "ids:mediaType": {
                        "@type": "ids:IANAMediaType",
                        "@id": "https://w3id.org/idsa/autogen/iANAMediaType/b1144236-a3dc-42f5-bff5-8bba8e1a4468",
                        "ids:filenameExtension": "application/json"
                    },
                    "ids:language": {
                        "@id": "https://w3id.org/idsa/code/EN"
                    },
                    "ids:created": {
                        "@value": "2024-05-29T10:43:25.197Z",
                        "@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
                    },
                    "ids:modified": {
                        "@value": "2024-05-29T10:43:25.197Z",
                        "@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
                    },
                    "ids:instance": [
                        {
                            "@type": "ids:Artifact",
                            "@id": "https://connectora:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182",
                            "ids:fileName": "Example artifact with weather data",
                            "ids:creationDate": {
                                "@value": "2024-05-29T10:43:02.929Z",
                                "@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
                            },
                            "ids:byteSize": 456,
                            "ids:checkSum": "1078006432"
                        }
                    ],
                    "ids:representationStandard": {
                        "@id": ""
                    }
                }
            ],
            "ids:publisher": {
                "@id": "https://dwd.com"
            },
            "ids:sovereign": {
                "@id": "https://dwd.com"
            },
            "ids:standardLicense": {
                "@id": ""
            },
            "ids:resourceEndpoint": [
                {
                    "@type": "ids:ConnectorEndpoint",
                    "@id": "https://w3id.org/idsa/autogen/connectorEndpoint/a0ba310e-8b66-4b83-8a4e-d747be7947ff",
                    "ids:endpointDocumentation": [
                        {
                            "@id": ""
                        }
                    ],
                    "ids:accessURL": {
                        "@id": "https://connectora:8080/api/offers/6c052834-4a59-474e-9a6f-ba8291f91ae6"
                    }
                }
            ],
            "ids:contractOffer": [
                {
                    "@type": "ids:ContractOffer",
                    "@id": "https://connectora:8080/api/contracts/247ef8d0-d053-4069-90bf-e8aab7908435",
                    "ids:provider": {
                        "@id": "https://connectora:8080/"
                    },
                    "ids:permission": [
                        {
                            "@type": "ids:Permission",
                            "@id": "https://connectora:8080/api/rules/c873c14a-7ada-456b-998b-1bd0f8a46060",
                            "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:contractEnd": {
                        "@value": "2028-10-22T07:48:37.068Z",
                        "@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
                    },
                    "ids:consumer": {
                        "@id": ""
                    },
                    "ids:contractStart": {
                        "@value": "2023-10-22T07:48:37.068Z",
                        "@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
                    },
                    "ids:contractDate": {
                        "@value": "2024-05-29T10:50:16.879Z",
                        "@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
                    }
                }
            ],
            "ids:keyword": [
                {
                    "@value": "DWD",
                    "@language": "DE"
                }
            ],
            "ids:created": {
                "@value": "2024-05-29T10:36:09.482Z",
                "@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
            },
            "ids:modified": {
                "@value": "2024-05-29T10:36:09.482Z",
                "@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/6c052834-4a59-474e-9a6f-ba8291f91ae6

https://connectora:8080/api/rules/c873c14a-7ada-456b-998b-1bd0f8a46060

https://connectora:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182

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/6c052834-4a59-474e-9a6f-ba8291f91ae6

Insert the artifact that should be requested (artifactIds)

https://connectora:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182

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/c873c14a-7ada-456b-998b-1bd0f8a46060",
        "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/95b43d79-9560-4ca5-8bdf-06dd5d109182"
} ]

The response body should give code 201 and should have this structure:

{
    "creationDate": "2024-05-29T10:51:37.773+0000",
    "modificationDate": "2024-05-29T10:51:37.773+0000",
    "remoteId": "https://connectora:8080/api/agreements/5b9c0883-1f3c-43d8-9b2d-c0d7c787b545",
    "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/5b9c0883-1f3c-43d8-9b2d-c0d7c787b545\",\n  \"ids:provider\" : {\n    \"@id\" : \"https://connector_A\"\n  },\n  \"ids:permission\" : [ {\n    \"@type\" : \"ids:Permission\",\n    \"@id\" : \"https://connectora:8080/api/rules/c873c14a-7ada-456b-998b-1bd0f8a46060\",\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/95b43d79-9560-4ca5-8bdf-06dd5d109182\"\n    }\n  } ],\n  \"ids:contractEnd\" : {\n    \"@value\" : \"2028-10-22T07:48:37.068Z\",\n    \"@type\" : \"http://www.w3.org/2001/XMLSchema#dateTimeStamp\"\n  },\n  \"ids:consumer\" : {\n    \"@id\" : \"https://connector_B\"\n  },\n  \"ids:contractStart\" : {\n    \"@value\" : \"2024-05-29T10:51:37.249Z\",\n    \"@type\" : \"http://www.w3.org/2001/XMLSchema#dateTimeStamp\"\n  },\n  \"ids:contractDate\" : {\n    \"@value\" : \"2024-05-29T10:51:37.249Z\",\n    \"@type\" : \"http://www.w3.org/2001/XMLSchema#dateTimeStamp\"\n  }\n}",
    "_links": {
        "self": {
            "href": "https://localhost:8081/api/agreements/4c49257a-097e-47ba-89fa-cb1a8775f2d0"
        },
        "artifacts": {
            "href": "https://localhost:8081/api/agreements/4c49257a-097e-47ba-89fa-cb1a8775f2d0/artifacts{?page,size}",
            "templated": true
        }
    }
}

From this response body it is obtained the Connector B agreement

https://localhost:8081/api/agreements/4c49257a-097e-47ba-89fa-cb1a8775f2d0

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

4c49257a-097e-47ba-89fa-cb1a8775f2d0

The response body should give code 200 and should have this structure:

{
    "_embedded": {
        "artifacts": [
            {
                "creationDate": "2024-05-29T10:51:38.210+0000",
                "modificationDate": "2024-05-29T10:51:38.210+0000",
                "remoteId": "https://connectora:8080/api/artifacts/95b43d79-9560-4ca5-8bdf-06dd5d109182",
                "title": "Example artifact with weather data",
                "description": "",
                "numAccessed": 0,
                "byteSize": 0,
                "checkSum": 0,
                "additional": {
                    "ids:byteSize": "456",
                    "ids:creationDate": "2024-05-29T10:43:02.929Z",
                    "ids:checkSum": "1078006432"
                },
                "_links": {
                    "self": {
                        "href": "https://localhost:8081/api/artifacts/37cba4ea-1036-438f-907b-52b8ffde06b7"
                    },
                    "data": {
                        "href": "https://localhost:8081/api/artifacts/37cba4ea-1036-438f-907b-52b8ffde06b7/data"
                    },
                    "representations": {
                        "href": "https://localhost:8081/api/artifacts/37cba4ea-1036-438f-907b-52b8ffde06b7/representations{?page,size}",
                        "templated": true
                    },
                    "agreements": {
                        "href": "https://localhost:8081/api/artifacts/37cba4ea-1036-438f-907b-52b8ffde06b7/agreements{?page,size}",
                        "templated": true
                    },
                    "subscriptions": {
                        "href": "https://localhost:8081/api/artifacts/37cba4ea-1036-438f-907b-52b8ffde06b7/subscriptions{?page,size}",
                        "templated": true
                    },
                    "route": {
                        "href": "https://localhost:8081/api/artifacts/37cba4ea-1036-438f-907b-52b8ffde06b7/route"
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://localhost:8081/api/agreements/4c49257a-097e-47ba-89fa-cb1a8775f2d0/artifacts?page=0&size=30"
        }
    },
    "page": {
        "size": 30,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}

From this response body it is obtained the url to obtain the data

https://localhost:8081/api/artifacts/37cba4ea-1036-438f-907b-52b8ffde06b7/data

If you paste it in a browser and download it is obtained the corresponding DWD weather data.

Validating Preconfigured Setup: Interaction with Broker

This section will explain the necessary steps to validate correct setup of the Broker with information regarding Connector A and B and to obtain information about the dataset offered by Connector A. With the Reference Testbed setup, follow the next steps on Connector B to obtain information from the Broker concerning Connector A. Access in a browser https://localhost:8081 and conduct the following steps in the Swagger UI of connector B.

Request Broker Self-Description: POST /api/ids/description

Obtain broker self-description using POST /api/ids/description.

Insert the recipient url

https://broker-reverseproxy/infrastructure

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:Broker",
    "@id": "https://broker-reverseproxy/",
    "ids:description": [
        {
            "@value": "A Broker with a graph persistence layer",
            "@language": "en"
        }
    ],
    "ids:title": [
        {
            "@value": "IDS Metadata Broker",
            "@language": "en"
        }
    ],
    "ids:hasDefaultEndpoint": {
        "@type": "ids:ConnectorEndpoint",
        "@id": "https://w3id.org/idsa/autogen/connectorEndpoint/fbcb92e9-084b-4846-a957-f7cd417ccc94",
        "ids:path": "/",
        "ids:accessURL": {
            "@id": "https://broker-reverseproxy/"
        },
        "ids:endpointInformation": [
            {
                "@value": "Dieser Endpunkt liefert eine Selbstbeschreibung dieses IDS Connectors",
                "@language": "de"
            },
            {
                "@value": "Endpoint providing a self-description of this connector",
                "@language": "en"
            }
        ]
    },
    "ids:hasEndpoint": [
        {
            "@type": "ids:ConnectorEndpoint",
            "@id": "https://w3id.org/idsa/autogen/connectorEndpoint/002793f6-8d61-468a-8d06-d035c1ed9e77",
            "ids:path": "/infrastructure",
            "ids:endpointDocumentation": [
                {
                    "@id": "https://app.swaggerhub.com/apis/idsa/IDS-Broker/1.3.1#/Multipart%20Interactions/post_infrastructure"
                }
            ],
            "ids:accessURL": {
                "@id": "https://broker-reverseproxy/infrastructure"
            },
            "ids:endpointInformation": [
                {
                    "@value": "This endpoint provides IDS Connector and IDS Resource registration and search capabilities at the IDS Metadata Broker.",
                    "@language": "en"
                },
                {
                    "@value": "Dieser Endpunkt ermöglicht die Registrierung von und das Suchen nach IDS Connectoren und IDS Ressourcen am IDS Metadata Broker.",
                    "@language": "de"
                }
            ]
        }
    ],
    "ids:resourceCatalog": [
        {
            "@type": "ids:ResourceCatalog",
            "@id": "https://w3id.org/idsa/autogen/resourceCatalog/24263dca-47a5-4b95-980e-48f88eff32c9",
            "ids:offeredResource": [
                {
                    "@type": "ids:DataResource",
                    "@id": "https://w3id.org/idsa/autogen/dataResource/34582161-2e82-4541-b79a-dfd8f2348761",
                    "ids:representation": [
                        {
                            "@type": "ids:DataRepresentation",
                            "@id": "https://w3id.org/idsa/autogen/dataRepresentation/577087e0-b1d5-41c0-8503-19f08b11d34c",
                            "ids:instance": [
                                {
                                    "@type": "ids:Artifact",
                                    "@id": "https://broker-reverseproxy/connectors/"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "ids:securityProfile": {
        "@id": "https://w3id.org/idsa/code/BASE_SECURITY_PROFILE"
    },
    "ids:maintainer": {
        "@id": "https://www.iais.fraunhofer.de"
    },
    "ids:curator": {
        "@id": "https://www.iais.fraunhofer.de"
    },
    "ids:inboundModelVersion": [
        "4.0.3"
    ],
    "ids:outboundModelVersion": "4.0.3"
}

Query List of Connectors to Check Successful Registration: POST /api/ids/description

Query the MetaData Broker for available connectors in the Testbed using message POST /api/ids/description.

Insert the recipient url

https://broker-reverseproxy/infrastructure

Insert the element id of the requested resource

https://broker-reverseproxy/connectors/

The response body should give code 200 and contain both connectors (A and B) in the list of connector as follows:

{
    "@graph": [
        {
            "@id": "https://broker-reverseproxy/connectors/",
            "@type": "ids:ConnectorCatalog",
            "listedConnector": [
                "https://broker-reverseproxy/connectors/2129657530",
                "https://broker-reverseproxy/connectors/2129657531"
            ]
        },
        {
            "@id": "https://broker-reverseproxy/connectors/2129657530",
            "@type": "ids:BaseConnector",
            "sameAs": "https://connector_A",
            "curator": "https://sovity.de/",
            "description": "IDS Connector A with static example resources",
            "hasDefaultEndpoint": "https://w3id.org/idsa/autogen/connectorEndpoint/e5e2ab04-633a-44b9-87d9-a097ae6da3cf",
            "inboundModelVersion": [
                "4.2.0",
                "4.2.1",
                "4.1.0",
                "4.0.0",
                "4.2.2",
                "4.2.3",
                "4.2.7",
                "4.1.2",
                "4.2.4",
                "4.2.5",
                "4.2.6"
            ],
            "maintainer": "https://sovity.de/",
            "outboundModelVersion": "4.2.7",
            "publicKey": "https://w3id.org/idsa/autogen/publicKey/78eb73a3-3a2a-4626-a0ff-631ab50a00f9",
            "resourceCatalog": "https://broker-reverseproxy/connectors/2129657530/1127754494",
            "securityProfile": "https://w3id.org/idsa/code/BASE_SECURITY_PROFILE",
            "title": "Dataspace Connector",
            "version": "8.0.2"
        },
        {
            "@id": "https://broker-reverseproxy/connectors/2129657530/1127754494",
            "@type": "ids:ResourceCatalog",
            "sameAs": "https://localhost:8080/api/catalogs/824d97c3-d9e8-404f-8659-e89f3f7bf3fa"
        },
        {
            "@id": "https://broker-reverseproxy/connectors/2129657531",
            "@type": "ids:BaseConnector",
            "sameAs": "https://connector_B",
            "curator": "https://sovity.de/",
            "description": "IDS Connector B with static example resources",
            "hasDefaultEndpoint": "https://w3id.org/idsa/autogen/connectorEndpoint/e5e2ab04-633a-44b9-87d9-a097ae6da3cf",
            "inboundModelVersion": [
                "4.2.6",
                "4.0.0",
                "4.2.7",
                "4.2.0",
                "4.1.0",
                "4.2.1",
                "4.2.2",
                "4.2.3",
                "4.1.2",
                "4.2.4",
                "4.2.5"
            ],
            "maintainer": "https://sovity.de/",
            "outboundModelVersion": "4.2.7",
            "publicKey": "https://w3id.org/idsa/autogen/publicKey/78eb73a3-3a2a-4626-a0ff-631ab50a00f9",
            "securityProfile": "https://w3id.org/idsa/code/BASE_SECURITY_PROFILE",
            "title": "Dataspace Connector",
            "version": "8.0.2"
        },
        {
            "@id": "https://w3id.org/idsa/autogen/connectorEndpoint/e5e2ab04-633a-44b9-87d9-a097ae6da3cf",
            "@type": "ids:ConnectorEndpoint",
            "accessURL": [
                "https://connectora:8080/api/ids/data",
                "https://connectorb:8081/api/ids/data"
            ]
        },
        {
            "@id": "https://w3id.org/idsa/autogen/publicKey/78eb73a3-3a2a-4626-a0ff-631ab50a00f9",
            "@type": "ids:PublicKey",
            "keyType": "https://w3id.org/idsa/code/RSA",
            "keyValue": "VkZWc1NsRnJiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR1VrOUZSazVUVld4RFVUSmtURkV3UmxKU1ZVWXhaSHBhZEZKdVNtdGFiWGhaVjJ4U1Mxb3dXbEJSVkZaNllsVlNXVkY2UVRWVk1qRjNVMnhrZGxJelFqVlNWa3BoVkd0V05VMTZSbmRUTWxKNlZXdGtiMVpIYkhkVmFra3pZV3BzY0dOdE1YUmpWMnh2Wkdwa2JsTlhaRFpSTWpVMFRtMTBTbFZyTlVoVFZFb3hUVWM1UjFWVVZrZGFNMXBRVFZob05Gb3pjR3BoVjJoclkwVlpkMUV5YUd4VU1sazFVMVUxYm1GWVRsRmhNMFV4WVVkdk5GRlhWWFpTUm14WllUTmFjV0ZHUlRKWmVscG9ZWGs1WVZkWFduRk5SVFYzWTFoc1JsVkhUa3RPVlRGTlZXMHhXbEl5VmpSVVYwWk9WMjB4VlZsdVJrVlRibHBMWWtSV1MxSjZUWEpaYTFWNlYxZEZlVTFYYUZWWGJHeFFaVWRzVkdGWFRuZGFhMXB1VTJwTmQyRXlOREZaVmxaS1VWaFNhMDFFVmtwWGJtc3paV3BHZWxKSGJGZFVTRkpWVjBkNFRWcHRWWFpYYkVaRVRraENkV0ZyV2pCamVYUXdXWHBGZVdNeFp6VmhWMmhLWWxjMVJHRXlVWGRXTTFvMlRUQk9WVmR0T1RWUmJFNTZXWHBHVlZwRlNuSlphbXgwVFVWTk1XUklXbTVOUjFwU1ZVUlNVbG93V1habGEyZDVWVmM1WVdKdE5YbFRWRlY1WkZWR1lVOUZNWFppVm1Rd1YxUktjMlJFVGtWTlIzUnlZMFpKTWs5WVFtMVdhMUpMVGpOcmVtUnJOSFphV0dSS1VrVkdVbEZWU1QwPQ=="
        },
        {
            "@id": "https://w3id.org/idsa/code/BASE_SECURITY_PROFILE",
            "@type": "ids:SecurityProfile"
        },
        {
            "@id": "https://w3id.org/idsa/code/RSA",
            "@type": "ids:KeyType"
        }
    ],
    "@context": {
        "description": {
            "@id": "https://w3id.org/idsa/core/description"
        },
        "title": {
            "@id": "https://w3id.org/idsa/core/title"
        },
        "sameAs": {
            "@id": "http://www.w3.org/2002/07/owl#sameAs",
            "@type": "@id"
        },
        "inboundModelVersion": {
            "@id": "https://w3id.org/idsa/core/inboundModelVersion"
        },
        "hasDefaultEndpoint": {
            "@id": "https://w3id.org/idsa/core/hasDefaultEndpoint",
            "@type": "@id"
        },
        "maintainer": {
            "@id": "https://w3id.org/idsa/core/maintainer",
            "@type": "@id"
        },
        "resourceCatalog": {
            "@id": "https://w3id.org/idsa/core/resourceCatalog",
            "@type": "@id"
        },
        "version": {
            "@id": "https://w3id.org/idsa/core/version"
        },
        "outboundModelVersion": {
            "@id": "https://w3id.org/idsa/core/outboundModelVersion"
        },
        "securityProfile": {
            "@id": "https://w3id.org/idsa/core/securityProfile",
            "@type": "@id"
        },
        "curator": {
            "@id": "https://w3id.org/idsa/core/curator",
            "@type": "@id"
        },
        "publicKey": {
            "@id": "https://w3id.org/idsa/core/publicKey",
            "@type": "@id"
        },
        "accessURL": {
            "@id": "https://w3id.org/idsa/core/accessURL",
            "@type": "@id"
        },
        "listedConnector": {
            "@id": "https://w3id.org/idsa/core/listedConnector",
            "@type": "@id"
        },
        "keyValue": {
            "@id": "https://w3id.org/idsa/core/keyValue"
        },
        "keyType": {
            "@id": "https://w3id.org/idsa/core/keyType",
            "@type": "@id"
        },
        "owl": "http://www.w3.org/2002/07/owl#",
        "ids": "https://w3id.org/idsa/core/"
    }
}

From this list of connectors we now know the connector A element id:

https://localhost/connectors/2129657530

Request Information About Connector A: POST /api/ids/description

With the connector A element id, more details on Connector A can be requested from the broker using POST /api/ids/description.

Insert the recipient url

https://broker-reverseproxy/infrastructure

Insert the element id of the requested connector A

https://broker-reverseproxy/connectors/2129657530

The response body should give code 200 and should have this structure

{
    "@graph": [
        {
            "@id": "https://broker-reverseproxy/connectors/2129657530",
            "@type": "ids:BaseConnector",
            "sameAs": "https://connector_A",
            "curator": "https://sovity.de/",
            "description": "IDS Connector A with static example resources",
            "hasDefaultEndpoint": "https://w3id.org/idsa/autogen/connectorEndpoint/e5e2ab04-633a-44b9-87d9-a097ae6da3cf",
            "inboundModelVersion": [
                "4.2.0",
                "4.2.1",
                "4.1.0",
                "4.0.0",
                "4.2.2",
                "4.2.3",
                "4.2.7",
                "4.1.2",
                "4.2.4",
                "4.2.5",
                "4.2.6"
            ],
            "maintainer": "https://sovity.de/",
            "outboundModelVersion": "4.2.7",
            "publicKey": "https://w3id.org/idsa/autogen/publicKey/78eb73a3-3a2a-4626-a0ff-631ab50a00f9",
            "resourceCatalog": "https://broker-reverseproxy/connectors/2129657530/1127754494",
            "securityProfile": "https://w3id.org/idsa/code/BASE_SECURITY_PROFILE",
            "title": "Dataspace Connector",
            "version": "8.0.2"
        },
        {
            "@id": "https://broker-reverseproxy/connectors/2129657530/1127754494",
            "@type": "ids:ResourceCatalog",
            "sameAs": "https://localhost:8080/api/catalogs/824d97c3-d9e8-404f-8659-e89f3f7bf3fa"
        },
        {
            "@id": "https://w3id.org/idsa/autogen/connectorEndpoint/e5e2ab04-633a-44b9-87d9-a097ae6da3cf",
            "@type": "ids:ConnectorEndpoint",
            "accessURL": "https://connectora:8080/api/ids/data"
        },
        {
            "@id": "https://w3id.org/idsa/autogen/publicKey/78eb73a3-3a2a-4626-a0ff-631ab50a00f9",
            "@type": "ids:PublicKey",
            "keyType": "https://w3id.org/idsa/code/RSA",
            "keyValue": "VkZWc1NsRnJiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR1VrOUZSazVUVld4RFVUSmtURkV3UmxKU1ZVWXhaSHBhZEZKdVNtdGFiWGhaVjJ4U1Mxb3dXbEJSVkZaNllsVlNXVkY2UVRWVk1qRjNVMnhrZGxJelFqVlNWa3BoVkd0V05VMTZSbmRUTWxKNlZXdGtiMVpIYkhkVmFra3pZV3BzY0dOdE1YUmpWMnh2Wkdwa2JsTlhaRFpSTWpVMFRtMTBTbFZyTlVoVFZFb3hUVWM1UjFWVVZrZGFNMXBRVFZob05Gb3pjR3BoVjJoclkwVlpkMUV5YUd4VU1sazFVMVUxYm1GWVRsRmhNMFV4WVVkdk5GRlhWWFpTUm14WllUTmFjV0ZHUlRKWmVscG9ZWGs1WVZkWFduRk5SVFYzWTFoc1JsVkhUa3RPVlRGTlZXMHhXbEl5VmpSVVYwWk9WMjB4VlZsdVJrVlRibHBMWWtSV1MxSjZUWEpaYTFWNlYxZEZlVTFYYUZWWGJHeFFaVWRzVkdGWFRuZGFhMXB1VTJwTmQyRXlOREZaVmxaS1VWaFNhMDFFVmtwWGJtc3paV3BHZWxKSGJGZFVTRkpWVjBkNFRWcHRWWFpYYkVaRVRraENkV0ZyV2pCamVYUXdXWHBGZVdNeFp6VmhWMmhLWWxjMVJHRXlVWGRXTTFvMlRUQk9WVmR0T1RWUmJFNTZXWHBHVlZwRlNuSlphbXgwVFVWTk1XUklXbTVOUjFwU1ZVUlNVbG93V1habGEyZDVWVmM1WVdKdE5YbFRWRlY1WkZWR1lVOUZNWFppVm1Rd1YxUktjMlJFVGtWTlIzUnlZMFpKTWs5WVFtMVdhMUpMVGpOcmVtUnJOSFphV0dSS1VrVkdVbEZWU1QwPQ=="
        },
        {
            "@id": "https://w3id.org/idsa/code/BASE_SECURITY_PROFILE",
            "@type": "ids:SecurityProfile"
        },
        {
            "@id": "https://w3id.org/idsa/code/RSA",
            "@type": "ids:KeyType"
        }
    ],
    "@context": {
        "description": {
            "@id": "https://w3id.org/idsa/core/description"
        },
        "title": {
            "@id": "https://w3id.org/idsa/core/title"
        },
        "sameAs": {
            "@id": "http://www.w3.org/2002/07/owl#sameAs",
            "@type": "@id"
        },
        "inboundModelVersion": {
            "@id": "https://w3id.org/idsa/core/inboundModelVersion"
        },
        "hasDefaultEndpoint": {
            "@id": "https://w3id.org/idsa/core/hasDefaultEndpoint",
            "@type": "@id"
        },
        "maintainer": {
            "@id": "https://w3id.org/idsa/core/maintainer",
            "@type": "@id"
        },
        "resourceCatalog": {
            "@id": "https://w3id.org/idsa/core/resourceCatalog",
            "@type": "@id"
        },
        "version": {
            "@id": "https://w3id.org/idsa/core/version"
        },
        "outboundModelVersion": {
            "@id": "https://w3id.org/idsa/core/outboundModelVersion"
        },
        "securityProfile": {
            "@id": "https://w3id.org/idsa/core/securityProfile",
            "@type": "@id"
        },
        "curator": {
            "@id": "https://w3id.org/idsa/core/curator",
            "@type": "@id"
        },
        "publicKey": {
            "@id": "https://w3id.org/idsa/core/publicKey",
            "@type": "@id"
        },
        "accessURL": {
            "@id": "https://w3id.org/idsa/core/accessURL",
            "@type": "@id"
        },
        "keyValue": {
            "@id": "https://w3id.org/idsa/core/keyValue"
        },
        "keyType": {
            "@id": "https://w3id.org/idsa/core/keyType",
            "@type": "@id"
        },
        "owl": "http://www.w3.org/2002/07/owl#",
        "ids": "https://w3id.org/idsa/core/"
    }
}

From here we can obtain the accessURL of Connector A

"accessURL" : "https://connectora:8080/api/ids/data"

This accessURL can be utilized to request the data set from Connector A as described in "Validating Preconfigured Setup: Interaction between Connectors".

Last updated