capabilities_info object
Deze pagina’s zijn in het engels ten behoeve van mogelijk internationale ontwikkelaars
This object is used in the following endpoints:
Information about all capabilities of a data service provider is contained in a single capabilities_info
object, as defined below.
Note: the capabilities_info
object is aligned with the iSHARE /capabilities endpoint, but has been appended with optional DSGO specific attributes, which are indicated with an asterisk *. These attributes are optional in order to ensure compatibility with the iSHARE framework.
Parameters | Type | Description | ||||
---|---|---|---|---|---|---|
| required | root level object | Contains information about capabilities. MUST be provided for every participant that provides services within DSGO | |||
|
| optional | array of objects in | MUST contain a list of public features | ||
|
|
| required | string in | Identifier of the data service, MUST be unique and defined by the data service provider | |
|
|
| required | string in | Human readable name of the data service, MUST be limited to a maximum of 100 characters | |
|
|
| optional | string in | Short description of the data service, MUST be limited to a maximum of 1000 characters | |
|
|
| optional | string in | URL that provides a description of the service endpoint. Could be for instance a URL to an OpenAPI description, a WSDL document, a a SPARQL Service Description, a DCAT Data Catalog, etc. | |
|
|
| required | string in | URL to the data service | |
|
|
| optional | string in | URL where access token for the feature could be retrieved. This is optional because if | |
|
|
| required | string in | Provides information on the status of the service. Must be either | |
|
|
| required | string in | A framework-defined service is required from a framework perspective (including for instance the /capabilities endpoint), a dataspace-defined service is required from a dataspace perspective and a self-defined service is define by the provider of the service (actual data services are part of this category). Allowed values are | |
|
|
| required | object in | Versioning information of the provided service. | |
|
|
|
| optional | array of strings in | Array of framework versions that the service complies with, at a framework level. If not included, the service is assumed to be compliant with the latest version. The versions can be retrieved using the /versions endpoint. NOG AANPASSEN Required for framework-defined services. |
|
|
|
| optional | array of strings in | Array of dataspace versions that the service complies with, at a dataspace level. |
|
|
|
| required | array of strings in | Version of the provided data service. Not related to the version numbering of the framework or dataspace. |
|
|
| optional | array of strings in | Array of HTTP methods supported by the endpoint, for example: | |
|
|
| optional | string in | Authentication Assurance Levels defined for the data service. Allowed values are | |
|
|
| optional | array of strings in | MUST contain a (reference to) (one or more) recognised standard to indicate ontologies, semantics, schemes to which the resource in the data service conforms. In order to be machine-readable, this MUST contain an array of URLs, if this is not possible, it MAY contain a human-readable description of the standard. | |
|
|
| optional | object in | Data service specification. MUST contain a valid | |
|
| Optional | Array of objects in | MUST contain supported restricted features. The structure and parameters are exactly the same as defined in |
A party may also have private (internal or bilateral) endpoints, which are endpoints for their own internal organization, also known as endpoints that are implemented, but not to share with the others. These endpoints are not within the scope of DSGO and MUST not be returned to other DSGO parties.
See below for an example capabilities_info object.