...
| Status | ||||
|---|---|---|---|---|
| ||||
| Status | ||||
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
This endpoint MAY be implemented by the following roles:
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
...
Used to obtain information about the capabilities of participants in the DSGO from the trust framework catalogue (provided by the DSGO Trust framework authority). The /capabilities endpoint is used by all parties providing services within the context of the DSGO (data service providers, market facilities and the trust framework catalogue) to provide information about features provided. In the DSGO, a data service can be considered as a specific feature.
...
Information about participants is provided in capabilitiescapability_info objects, as defined below.
Capabilities_info object
| Info |
|---|
Note, the DSGO follows the iSHARE (v2.0) /capabilities endpoint. We are in ongoing discussions to ensure the alignment of this endpoint with the requirements from the DSGO. |
The capabilities_info object is aligned with the capabilities_info as defined in iSHARE (v2.0). The roles and features have been appended with DSGO specific parameters. These DSGO specific parameters are indicated with an asterisk.
...
Parameters
...
Type
...
Description
...
party_id
...
Required
...
String
...
Unique identifier of the party, MUST be a valid Organisation ID, containing an EORI or KvK number.
...
roles
...
Required
...
Array of objects
...
MUST be an object containing an array of role objects hat provide the information about the roles of the party in the DSGO
...
role
...
Required
...
String in roles object
...
MUST be the party role. Available values are Data Service Provider, Data Service Consumer, Data entitled Party,Authorisation Registry, Identity Provider, Data Service Broker, Technically compliant data service provider or Scheme Owner
...
supported_versions
...
Array of objects
...
Contains information about supported version endpoints for each version. MUST contains version and supported_features
...
version
...
Required
...
String in supported_versions object
...
MUST be the version of the system which is under support
...
supported_features
...
Required
...
Array of objects in supported_versions object
...
Contains a list of supported features. MUST contains public and restricted objects.
...
public
...
Optional
...
Array of objects in supported_features object
...
MUST Contain a list of public features (id, feature, description, url and token_endpoint)
...
id
...
Required
...
String in public object
...
Unique identifier of the data service, MUST be a unique identifier distributed by the DSGO Trust framework authority, when no identifier is received yet, field MUST be To be received
...
feature
...
Required
...
String in public object
...
Friendly name of the data service, MUST be limited to a maximum of 100 characters
...
description
...
Required
...
String in public object
...
Short description of the data service, MUST be limited to a maximum of 1000 characters
...
url
...
Required
...
String in public object
...
URL to the data service
...
token_endpoint
...
Optional
...
String in public object
...
URL where access token for the feature could be retrieved. This is optional because if feature is access token, it is not needed to mention it twice, or if the data service does not require an access token.
...
data_service_info*
...
Required
...
object in public object
...
Data service specification, MUST contain a valid data_service_info object. See Data service specification for more information.
...
restricted
...
Optional
...
Array of objects in supported_features object
...
MUST contain supported restricted features. The structure and parameters are exactly the same as defined in public above (id, feature, description, url and token_endpoint). It should only be provided to the parties which provided a valid access token. If an access token was not provided or restricted endpoints do not exist, this paramter MUST not be returned.
* these parameters are DSGO specific and have been added on top of the parameters defined in iSHARE (v2.0).
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Endpoint
the /parties endpoint on the page capability_info object.
The /capabilities endpoint follows the generic technical requirements, as well as the requirements specified for specific methods. The figure below gives an overview of the HTTP methods that are supported by the /partiescapabilities endpoint. These methods are further detailed and specified in the pages below:
...