search

Data Spaces

circle-info

This page must be considered part of the iSHARE Framework

This page is considered normative and is therefore compliant with RFC 2119.

hashtag
Retrieves list of dataspaces

get
/[v2.2]/dataspaces

Used to obtain a list of dataspaces.

Server response is an iSHARE signed JSON Web Token. Please refer to the models 'jwt_header' and 'jwt_payload_dataspaces_token' which indicate what the decoded response will look like.

Authorizations
AuthorizationstringRequired

OAuth 2.0 authorization based on bearer token. MUST contain “Bearer “ + access token value. Must be provided if restricted endpoints are needed.

Responses
chevron-right
200

OK

application/json
get
/[v2.2]/dataspaces
200

OK

hashtag
Response model

Decoded dataspace_list_token parameters:

It contains iSHARE compliant JWT claims. In addition to that it also contains the following parameters:

  • dataspace_info Array of Objects. Root level. Contains results counts and information about data spaces.

    • total_count String. Contained in the object of dataspace_info. Total count of found data spaces.

    • pageCount String. Contained in the object of dataspace_info. Number of pages (10 per page).

    • count String. Contained in the object of dataspace_info. Number of dataspaces returned.

    • data Array of Objects. Contained in the object of dataspace_list_token. Array containing a collection of data space objects.

      • dataspace_title String. Contained in the object of data. Title of dataspace.

      • dataspace_id String. Contained in the object of data. Unique ID of the data space. This is in format of <Continent>.<DS>.<3 letter code for data spaces>.<Country>.<data space name> for example EU.DS.GND.NL.DVU. Where, continent is 2 letter code, followed by "DS" (stands for dataspace), followed by 3 letter code of common eu data spaces HLT - Health, INM - Industrial and Manufacturing, AGR - Agriculture, FIN - Finance, MOB - Mobility, GND - Green Deal, ENR - Energy, PUB - Public Administration, SKL - Skills, followed by ISO 3166-1 alpha-2 2 letter Country code and lastly the name/title of the data space. Name may not contain spaces or dot "." or other special characters. Maximum length of name can be 15 characters.

      • dataspacedef_url String. Contained in the object of data. URL pointing to the data space definition. This is expected to be based on OpenDEI model of building blocks for data spaces. The machine readable format definition is currently under development. The specifications will be made available once published.

      • dataspace_website String. Contained in the object of data. Website address of the dataspace, typically data space governance body. The website details out more information about the data space and guides (potential) participants (to become member of) the data space.

      • defaultParticipantIdentifierName String. Contained in the object of data. Name of the default participant identifier used in the dataspace, which must be mentioned in the dataspace description (e.g., iSHARE-DID). If no default identifier has been selected, the default identifier must be assumed to be ishare:did.

      • defaultParticipantIdentifierPrefix String. Contained in the object of data. Prefix of the default participant identifier used in the dataspace, which must be mentioned in the dataspace description. If no default identifier has been selected, the default identifier must be assumed to be ishare:did.

      • tags String. Contained in the object of data. Free text field for adding relevant tags that are relevant in the context of data space. Useful for searching for specific data spaces based on tags.

      • status String. Contained in the object of data. Status of the data space. Available values are new, in progress, active and not active.

      • country_reg String. Contained in the object of data. Country in which the data space is registered in.

      • countries_operation Array. Contained in the object of data. Array of country names in which the data space operates.

      • sectors Array. Contained in the object of data. Array of sector names in which the data space operates.

hashtag
Example request

hashtag
Example response

The response contains an encoded JWT, which looks like this:

After decoding, the example content of the JWT looks like this:

PreviousVersionsNextCreate Entitled Party / Service Consumer

Last updated