piveau hub-repo service (3.3.25)
Download OpenAPI specification:Download
The API simplifies the management of datasets, adhering to the DCAT-AP standard for structured data descriptions. It integrates seamlessly with Virtuoso, an efficient database server and Triplestore, making dataset management more accessible. The DCAT-AP standard ensures consistent, comprehensive data descriptions, enhancing data sharing and discovery. The API simplifies the process of making datasets accessible to a wider audience. This promotes transparency, knowledge sharing, and collaboration. This introduction lays the groundwork for exploring the hub-repo Open API. Detailed information on authentication, API endpoints, error handling, and practical examples can be found in the subsequent sections to gain a comprehensive understanding of the API's functionality.
List catalogues
To retrieve the list of catalogues, send a GET request to the specified URL of the API with the resource path "catalogues". The query parameter "limit" specifies the number of resources to retrieve, while the query parameter "offset" determines the starting point for counting. Upon success, the response will contain, by default, an array with the URLs of the chosen number of catalogues (with 100 being the default limit). To retrieve identifiers (normalized IDs), metadata, or original IDs (IDs as by data provider) , you can choose a different value for the parameter "valueType".
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
Responses
Response samples
- 200
[- "string"
]Headers only for "List catalogues"
To retrieve only the headers for the list of catalogues, send a HEAD request to the specified URL of the API with the resource path "catalogues". The query parameter "limit" specifies the number of catalogues to retrieve, while the query parameter "offset" determines the starting point for counting. Upon success, the response will contain, by default, the headers for chosen number of catalogues' URLs (with 100 being the default limit). To retrieve the headers for the other data of catalogues select a different value for the parameter "valueType".
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
Responses
Get catalogue
You can get a catalogue making a GET request to the specified URL of the API endpoint with the resource path "catalogues/{catalogueId}" set the unique ID of the catalogue as {catalogueId} element of the URL. If successful, the response contains the information about the specified catalogue.
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
Responses
Response samples
- 200
Headers only for "Get catalogue"
You can get only the headers for catalogue making a HEAD request to the specified URL of the API endpoint with the resource path "catalogues/{catalogueId}" set the unique ID of the catalogue as {catalogueId} element of the URL. If successful, the response contains the headers of the specified catalogue.
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
Responses
Create or update catalogue
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user you can create or update the information of a specific catalog. Send a PUT request to the specified URL of the API endpoint, including the unique ID of the catalogue as {catalogueId} element of the URL and the updated information in the request. If the request is successful and the catalogueID already exists, the information in the catalogue will be updated with the newly provided information. If the catalogueID is new, a new catalogue will be created.
Authorizations:
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
Request Body schema: required
Responses
Request samples
- Payload
Delete catalogue
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user you can delete a specific catalogue. Send a DELETE request to the specified URL of the API endpoint with the resource path "/catalogues/{catalogueId}" at the end of URL, set the unique ID of the catalogue as {catalogueId} element of the URL. This operation deletes a catalogue's metadata, as well as the metadata of all referenced datasets, from the repository and the index. It also removes any related quality measurements if they exist. Caution: you cannot revert this operation
Authorizations:
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
Responses
List datasets of catalogue
To retrieve a list of datasets of a specific catalogue make a GET request to the specified URL of the API endpoint with the resource path "/catalogues/{catalogueId}/datasets" at the end of the URL, including the unique ID of the catalogue as {catalogueId} element of the URL. The query parameter "limit" specifies the number of datasets to retrieve, while the query parameter "offset" determines the starting point for counting. If the request is successful, by default, the response will contain an array with the URLs of the chosen number of datasets (with 100 being the default limit) from the specified catalogue. To retrieve other data of the datasets from the specified catalogue select a different value for the parameter "valueType".
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
Responses
Response samples
- 200
[- "string"
]Headers only for "List datasets of catalogue"
To retrieve only the headers for the list of datasets from a specific catalogue, you can make a HEAD request to the specified URL of the API endpoint with the resource path "/catalogues/{catalogueId}/datasets" at the end of the URL, including the unique ID of the catalogue as {catalogueId} element of the URL. The query parameter "limit" specifies the number of datasets to retrieve, while the query parameter "offset" determines the starting point for counting. If the request is successful, by default, the response will contain the headers for chosen number of datasets' URLs (with 100 being the default limit) from the specified catalogue. To retrieve the headers for other data of the datasets from the specified catalogue select a different value for the parameter "valueType".
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
Responses
Add dataset to catalogue
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to add a dataset. As an authorized user, you make a POST request to the specified URL of the API endpoint with the resource path "/catalogues/{catalogueId}/datasets" at the end of the URL and specify the unique ID of the catalogues as the {catalogueId} element of the URL.
Authorizations:
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
Request Body schema: required
Responses
Request samples
- Payload
Get datasets of catalogue by means of an original id
To retrieve a specific dataset send a GET request to the specified URL of the API endpoint with the resource path "/catalogues/{catalogueId}/datasets/origin" at the end of the URL, set the unique ID of the catalogue as {catalogueId} element and the unique ID of the dataset as {origin} element of the URL.
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
query Parameters
| originalId required | string The original id of the dataset |
Responses
Response samples
- 200
Headers only for "Get dataset of a catalogue by means of an original id"
To retrieve the headers for a specific dataset send a HEAD request to the specified URL of the API endpoint with the resource path "/catalogues/{catalogueId}/datasets/origin" at the end of the URL, set the unique ID of the catalogue as {catalogueId} element and the unique ID of the dataset as {origin} element of the URL.
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
query Parameters
| originalId required | string The original id of the dataset |
Responses
Create or update dataset of catalogue by means of an original id
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to create or update a dataset. As an authorized user, you make a PUT request to the specified URL of the API endpoint with the resource path "/catalogues/{catalogueId}/datasets/origin" at the end of the URL. Specify the unique ID of the catalogue, where the dataset is created, as the {catalogueId} and the unique ID of the dataset as the {origin} element of the URL accordingly. If the dataset with this ID already exists, it is updated.
Authorizations:
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
query Parameters
| originalId required | string The original id of the dataset |
Request Body schema: required
Responses
Request samples
- Payload
Delete dataset of catalogue by means of an original id
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user you can delete a dataset of a specific catalogue. Send a DELETE request to the specified URL of the API endpoint with the resource path "/catalogues/{catalogueId}/datasets/origin". Specify the unique ID of the catalogue as the {catalogueId} and the unique ID of the dataset as the {origin} element of the URL accordingly. This operation deletes the specified dataset, as well as all referenced distributions, from the repository and the index. It also removes any related quality measurements if they exist. Caution: you cannot revert this operation
Authorizations:
path Parameters
| catalogueId required | string[a-z,0-9,\-]+ The catalogue id |
query Parameters
| originalId required | string The original id of the dataset |
Responses
List datasets
Retrieve a list of datasets. This endpoint supports pagination using the "limit" and "offset" query parameters. The "valueType" query parameter can be used to specify the type of value to be returned for each dataset (e.g. normalized ID, metadata, or original ID). The "catalogue" and "sourceIds" query parameters are deprecated and will be removed in a future version.
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| catalogue | string Deprecated Please, use |
| sourceIds | boolean Deprecated Default: false Please, use |
| hydra | boolean Default: false Indicate that hydra paging should be used, only for valueType=metadata. If your service is behind a proxy, this might not work correctly. Find out more in the documentation: https://doc.piveau.eu/admin-guide/hub-repo-admin-guide/ |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
| usePagedCollection | boolean Default: false Set to 'true' to use the legacy PagedCollection format for pagination. By default, the response will use the updated PartialCollectionView format. This parameter is provided for backward compatibility with clients that expect the old format. |
Responses
Response samples
- 200
[- "string"
]Headers only for "List datasets"
Retrieve only the headers for a list of datasets. This endpoint has the same query parameters and behavior as the GET method, but it only returns the headers of the response.
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| catalogue | string Deprecated Please, use |
| sourceIds | boolean Deprecated Default: false Please, use |
| hydra | boolean Default: false Indicate that hydra paging should be used, only for valueType=metadata. If your service is behind a proxy, this might not work correctly. Find out more in the documentation: https://doc.piveau.eu/admin-guide/hub-repo-admin-guide/ |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
| usePagedCollection | boolean Default: false Set to 'true' to use the legacy PagedCollection format for pagination. By default, the response will use the updated PartialCollectionView format. This parameter is provided for backward compatibility with clients that expect the old format. |
Responses
Add dataset Deprecated
Deprecated. Please use POST /catalogues/{catalogueId}/datasets/origin instead.
Authorizations:
query Parameters
| catalogue required | string The catalogue to add the dataset |
Request Body schema: required
Responses
Request samples
- Payload
Create or update dataset Deprecated
Deprecated. Please use PUT /catalogues/{catalogueId}/datasets/origin instead
Authorizations:
query Parameters
| id required | string The dataset id |
| catalogue required | string The catalogue id |
| data | boolean Default: false Generate data url |
Request Body schema: required
Responses
Request samples
- Payload
Get dataset
To retrieve only the headers for a list of datasets, send a HEAD request to the specified API URL with the resource path "datasets". The query parameter "limit" specifies the number of resources to retrieve, while the query parameter "offset" determines the starting point for counting. Upon success, the response will contain, by default, the headers for the URLs of the chosen number of datasets (with 100 being the default limit). To retrieve identifiers (normalized IDs), metadata, or original IDs (IDs as by data provider) , you can choose a different value for the parameter "valueType".
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| catalogue | string Deprecated Please, use |
Responses
Response samples
- 200
Headers only for "Get dataset"
You can get the headers for a specific dataset making a HEAD request to the specified API endpoint URL with the resource path "datasets/{datasetId}" at the end of the URL. Replace {datasetId} with the unique ID of the dataset as an element in the URL.
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| catalogue | string Deprecated Please, use |
Responses
Update a Dataset
Update a dataset. When you use an original dataset id for creation or update, please, use PUT /catalogues/{catalogueId}/datasets/origin instead.
Authorizations:
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| catalogue | string Deprecated Please, use |
Request Body schema: required
Responses
Request samples
- Payload
Delete a dataset
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user you can delete a specific dataset. Send a DELETE request to the specified URL of the API endpoint with the resource path "datasets/{datasetId}". Set the {datasetId} as the unique ID of the dataset you want to delete. This operation deletes the specified dataset, as well as all referenced distributions, from the repository and the index. It also removes any related quality measurements if they exist. Caution: you cannot revert this operation
Authorizations:
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| catalogue | string Deprecated Please, use |
Responses
Get dataset revision
To retrieve a specific dataset revision send a GET request to the specified URL of the API endpoint with the resource path "/datasets/revisions/{revisionId}" at the end of the URL and set the unique ID of the dataset revision as {revisionId} element.
path Parameters
| revisionId required | string[a-z,0-9,\-,~]+ The dataset id |
Responses
Response samples
- 200
Get difference between two revisions
To retrieve the difference between two dataset revisions send a GET request to the specified URL of the API endpoint with the resource path "/datasets/{datasetId}/diff" at the end of the URL, set the unique ID of the dataset as {datasetId} element and the revision numbers of the revisions that are to be compared. To retrieve the difference between the most recent dataset and a revision of the dataset send a GET request to the specified URL of the API endpoint with the resource path "/datasets/{datasetId}/diff" at the end of the URL, set the unique ID of the dataset as {datasetId} element and leave one of the revision numbers empty and set the other revision number to the revision number of the dataset revision.
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| revisionNumber1 | string The revision number of the first revision |
| revisionNumber2 | string The revision number of the second revision |
Responses
Response samples
- 200
List dataset distributions
To get a list of distributions of a particular dataset make a GET request to the specified URL of the API endpoint with the resource path "/datasets/{datasetId}/distributions" at the end of the URL, set the unique ID of the dataset as {datasetId} element of the URL. If successful, the response will contain, by default, an array with the URLs of all distributions. To retrieve the other data of the distributions from the specified dataset select a different value for the parameter "valueType".
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
Responses
Response samples
- 200
[- "string"
]Headers only for "List dataset distributions"
To retrieve only the headers of the distributions' list from a specific dataset, make a HEAD request to the specified URL of the API endpoint with the resource path "/datasets/{datasetId}/distributions", including the unique ID of the dataset as {datasetId} element of the URL. The query parameter "limit" specifies the number of distributions to retrieve, while the query parameter "offset" determines the starting point for counting. If the request is successful, by default, the response will contain the headers for the list of URLs of all distributions from the specified dataset. To retrieve the headers for other data of the list of distributions from the specified dataset select a different value for the parameter "valueType".
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
Responses
Add distribution to dataset
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to insert a new distribution into a dataset. As an authorized user, you make a POST request to the specified URL of the API endpoint with the resource path "datasets/{datasetId}/distributions", setting the unique ID of the dataset as {datasetId} element of the URL, to add a new distribution of the specified dataset.
Authorizations:
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
Request Body schema: required
Responses
Request samples
- Payload
Get dataset metrics
To retrieve the metrics of metadata quality and their corresponding values for a specified dataset, send a GET request to the designated API endpoint URL with the resource path "/datasets/{datasetId}/metrics" added at the end of the URL, set the unique ID of the dataset as {datasetId} element of the URL. By default the latest measurements will be provide. To obtain a graph with all data collected for the specified dataset, set the query parameter "historic" to "true".
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| historic | boolean Default: false Whether the historic metrics graph should be returned. Ignored when historic graphs are disabled in config. |
Responses
Response samples
- 200
Headers only for "Get dataset metrics"
To retrieve the headers for the metrics of metadata quality and their corresponding values for a specified dataset, send a HEAD request to the specified API endpoint URL with the resource path "/datasets/{datasetId}/metrics" added at the end of the URL, set the unique ID of the dataset as {datasetId} element of the URL. By default the headers for metadata of the latest measurements will be provide. To get headers for a graph with the metadata of all data, collected for the specified dataset, set the query parameter "historic" to "true".
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| historic | boolean Default: false Whether the historic metrics graph should be returned. Ignored when historic graphs are disabled in config. |
Responses
Create/Update metrics for a dataset
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user you can createor update metrics for a dataset, by making a PUT request to the specified API endpoint URL with the resource path "/datasets/{datasetId}/metrics" added at the end of the URL. Specify the unique ID of the dataset as the {datasetId}.
Authorizations:
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
Request Body schema: required
Responses
Request samples
- Payload
Delete metrics
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user you can create or update metrics for a dataset, making a DELETE request to the specified API endpoint URL with the resource path "/datasets/{datasetId}/metrics" added at the end of the URL. Specify the unique ID of the dataset as the {datasetId}.
Authorizations:
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
Responses
Get catalogue record
To retrieve the catalogue record of a specific dataset, make a GET request to the specified URL of the API endpoint with the resource path "/datasets/{datasetId}/record" at the end of the URL, set the unique ID of the dataset as {datasetId} element of the URL.
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
Responses
Response samples
- 200
Headers only for "Get catalogue record"
To retrieve only the headers for a catalogue record of a specific dataset make a HEAD request to the specified API endpoint URL with the resource path "/datasets/{datasetId}/record" added at the end of the URL, set the unique ID of the dataset as {datasetId} element of the URL.
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
Responses
Get catalogue record of a dataset revision
To retrieve the catalogue record of a specific dataset revision, make a GET request to the specified URL of the API endpoint with the resource path "/records/revisionRecord/{revisionId}" added at the end of the URL and set the unique ID of the dataset revision as {revisionId} element of the URL.
path Parameters
| revisionId required | string[a-z,0-9,\-,~]+ The dataset id |
Responses
Response samples
- 200
Index/Reindex a dataset
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user, you can add a specified dataset to the distributed document store (hub-search) and receive an index of the stored dataset in the response.
Authorizations:
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
Responses
Get distribution
You can get a specific distribution of a dataset making a GET request to the specified URL of the API endpoint with the resource path "/distributions/{distributionId}" at the end of the URL, set the unique ID of the distribution as {distributionId} element of the URL.
path Parameters
| distributionId required | string[a-z,0-9,\-,~]+ The distribution id |
Responses
Response samples
- 200
Headers only for "Get distribution"
To retrieve only the headers for a specific distribution of a dataset make a HEAD request to the specified URL of the API endpoint with the resource path "/distributions/{distributionId}" at the end of the URL, set the unique ID of the distribution as {distributionId} element of the URL.
path Parameters
| distributionId required | string[a-z,0-9,\-,~]+ The distribution id |
Responses
Update distribution
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to create or update a dataset's distribution. As an authorized user, you make a PUT request to the specified URL of the API endpoint with the resource path "/distributions/{distributionId}" at the end of the URL. Specify the unique ID of the distribution as the {distributionId}. If the distribution with this ID already exists, it will be updated. If the distribution ID is new, a new distribution will be created.
Authorizations:
path Parameters
| distributionId required | string[a-z,0-9,\-,~]+ The distribution id |
Request Body schema: required
Responses
Request samples
- Payload
Delete distribution
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user you can delete a specific distribution. Send a DELETE request to the specified URL of the API endpoint with the resource path "/distributions/{distributionId}" at the end of the URL. Specify the unique ID of the distribution as the {distributionId}. The specified distribution will be deleted.
Authorizations:
path Parameters
| distributionId required | string[a-z,0-9,\-,~]+ The distribution id |
Responses
Get list of vocabularies
You can get a list of indexed (controlled) vocabularies used by the portal sending a GET request to the specified URL of the API endpoint with the resource path "/vocabularies" at the end of the URL. Upon success, the response will contain, by default, an array with the URLs of the chosen number of vocabularies (with 100 being the default limit). To retrieve identifiers (normalized IDs), metadata etc. you can choose a different value for the parameter "valueType".
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
Responses
Response samples
- 200
[- "string"
]Head get list of vocabularies
To retrieve only the headers for the list of indexed (controlled) vocabularies used by the portal sending a HEAD request to the specified URL of the API endpoint with the resource path "/vocabularies" at the end of the URL. Upon success, the response will contain, by default, the headers for chosen number of the vocabularies' URLs (with 100 being default limit). To retrieve headers for other data of the vocabularies select a different value for the parameter "valueType".
query Parameters
| valueType | string Default: "uriRefs" Enum: "uriRefs" "identifiers" "originalIds" "metadata" Return value type. In case of |
| offset | number <int64> >= 0 Default: 0 |
| limit | number <int64> [ 1 .. 5000 ] Default: 100 |
Responses
Create or Update a vocabulary Deprecated
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can create or update a vocabulary, sending a PUT request to the specified API endpoint URL with the resource path "/vocabularies" at the end of the URL. Set the unique ID and URI of the vocabulary as required parameters of the request, if the vocabulary ID and URI already exist, the vocabulary is updated.
Authorizations:
query Parameters
| vocabularyId required | string ID of the vocabulary |
| uri required | string URI of the vocabulary |
| hash | string Hash of the vocabulary. Used for chunk-wise processing. Default is empty. |
| chunkId | integer >= 0 Id of the corresponding chunk of the vocabulary. Used for chunk-wise processing. Default is 0. |
| numberOfChunks | integer >= 1 Number of total chunks of the vocabulary. Used for chunk-wise processing. Default is 1. |
Request Body schema: required
Responses
Request samples
- Payload
Get a vocabulary
You can get a vocabulary, making a GET request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabularyId}". Set the unique identifier of the vocabulary as {vocabularyId} element of the URL. If successful, the response contains the vocabulary.
path Parameters
| vocabularyId required | string[a-z,0-9,\-,~]+ The vocabulary id |
Responses
Response samples
- 200
Head get a vocabulary
You can get only the headers for a vocabulary making a HEAD request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabularyId}". Set the unique identifier of the vocabulary as {vocabularyId} element of the URL. If successful, the response contains the headers of the specified vocabulary.
path Parameters
| vocabularyId required | string[a-z,0-9,\-,~]+ The vocabulary id |
Responses
Create or update a vocabulary
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can create or update a vocabulary, sending a PUT request to the specified URL of the API endpoint "/vocabularies/{vocabularyId}". Set the unique identifier of the vocabulary as {vocabularyId} element of the URL. If the vocabulary ID already exists, the vocabulary is updated. If the vocabulary ID is new, a new vocabulary will be created
Authorizations:
path Parameters
| vocabularyId required | string[a-z,0-9,\-,~]+ The vocabulary id |
Request Body schema: required
Responses
Request samples
- Payload
Delete a vocabulary
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can delete a vocabulary, sending a DELETE request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabularyId}" added at the end of the URL. Set the unique ID of the vocabulary as {vocabularyId} element of the URL. Caution! You cannot revert this operation.
Authorizations:
path Parameters
| vocabularyId required | string[a-z,0-9,\-,~]+ The vocabulary id |
Responses
Get dataset drafts
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to retrieve drafts of datasets. As an authorized user, you make a GET request to the specified API endpoint URL with the resource path "/drafts/datasets" added at the end of the URL. If successful, the response contains an array of the drafts' ID that the user is authorized to read, update and delete.
Authorizations:
query Parameters
| filterByProvider | boolean By default, all drafts that the user is allowed to read, update and delete are returned. With |
Responses
Response samples
- 200
"string"Create a dataset draft
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to create a draft of a dataset. As an authorized user, you make a POST request to the specified URL of the API endpoint with the resource path "/drafts/datasets" added at the end of the URL. The ID of the catalogue, where the draft is added, is a required query parameter. If successful, the draft ID will be created automatically.
Authorizations:
query Parameters
| catalogue required | string The ID of the catalogue which should contain this dataset draft |
Responses
Get a dataset draft
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to get a dataset draft. As an authorized user, you make a GET request to the specified URL of the API endpoint with the resource path "/drafts/datasets/{id}" at the end of the URL, set the unique ID of the draft as {id} element of the URL.
Authorizations:
path Parameters
| id required | string ID of the draft dataset. |
query Parameters
| catalogue required | string The ID of the catalogue which should contain this dataset draft |
Responses
Response samples
- 200
"string"Create or Update a dataset draft
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to create or update a dataset draft with given ID. As an authorized user, you make a PUT request to the specified URL of the API endpoint with the resource path "/drafts/datasets/{id}" added at the end of the URL, set the unique ID of the draft as {id} element of the URL. If the request is successful and the ID already exists, the information in the draft will be updated with the newly provided information. If the ID is new, a new draft will be created.
Authorizations:
path Parameters
| id required | string ID of the draft dataset. |
query Parameters
| catalogue required | string The ID of the catalogue which should contain this dataset draft |
Request Body schema: required
Responses
Request samples
- Payload
Delete a dataset draft
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to delete a dataset draft. As an authorized user, you make a DELETE request to the specified URL of the API endpoint with the resource path "/drafts/datasets/{id}" at the end of the URL, set the unique ID of the draft as {id} element of the URL. Caution: you cannot revert this operation
Authorizations:
path Parameters
| id required | string ID of the draft dataset. |
query Parameters
| catalogue required | string The ID of the catalogue which should contain this dataset draft |
Responses
Publish a dataset draft
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to publish a dataset draft. As an authorized user, you make a PUT request to the specified URL of the API endpoint with the resource path "/drafts/datasets/publish/{id}" added at the end of the URL, set the unique ID of the specified draft as {id} element of the URL. If successful, the draft is published and gets another ID as dataset.
Authorizations:
path Parameters
| id required | string ID of the draft dataset. |
query Parameters
| catalogue required | string The ID of the catalogue which should contain this dataset draft |
Responses
Hide a published dataset
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to withdraw a published dataset from publication, by setting it into draft. As an authorized user, you make a PUT request to the specified URL of the API endpoint with the resource path "/drafts/datasets/hide/{id}" at the end of the URL, set the unique ID of the specified dataset as {id} element of the URL. If successful, the dataset is retracted and set to the drafts.
Authorizations:
path Parameters
| id required | string ID of the published dataset. |
query Parameters
| catalogue required | string The ID of the catalogue which should contain this dataset draft |
Responses
Create a persistent identifier for a dataset
This function is reserved for internal use only and is not part of our public API offerings. This endpoint allows to create a persistent identifier for a dataset, that will be stored in the adms:identifier property. Choose value "mock" for the query parameter type if you need it for simulation purpose.
Authorizations:
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| catalogue | string Deprecated The the catalogue id to which the dataset belongs |
| type required | string Enum: "eu-ra-doi" "mock" The type of the persistent identifier |
Responses
Response samples
- 200
- 422
{ }Check if an identifier can be issued for the given dataset.
This function is reserved for internal use only and is not part of our public API offerings. As an authorized user you can check if the specified dataset has all required elements ("creator", "publisher" etc.) to obtain an identifier. Send a GET request to the specified API endpoint URL with the resource path "/identifiers/datasets/{datasetId}/eligibility" added at the end of the URL, set the unique ID of the dataset as {datasetID} element of the URL. Choose value "mock" for the query parameter type if you need it for simulation purpose.
Authorizations:
path Parameters
| datasetId required | string[a-z,0-9,\-,~]+ The dataset id |
query Parameters
| catalogue | string The the catalogue id to which the dataset belongs |
| type | string Enum: "eu-ra-doi" "mock" The type of the persistent identifier |
Responses
List resources
You can get a list of resources of an exact type with required parameter 'type'.
path Parameters
| type required | string Type to which the resources belong. |
query Parameters
| valueType | string Default: "identifier" Enum: "identifier" "uriRef" What to return |
| catalogId | string Catalog ID to which the resource belongs. |
Responses
Response samples
- 200
[ ]Create a resource
You can post a resource with type.
Authorizations:
path Parameters
| type required | string Type to which the resource belongs. |
query Parameters
| catalogId | string Catalog ID to which the resource belongs. |
Request Body schema: required
Model of the new Resource
Responses
Create or Update a resource
You can put a resource with id and type.
Authorizations:
path Parameters
| type required | string Type to which the resource belongs. |
query Parameters
| id required | string Id of the created or updated resource |
| catalogId | string Catalog ID to which the resource belongs. |
Request Body schema: required
Model of the new Resource
Responses
The action API utilizes the JSON-RPC 2.0 specification with the following constraints:
idreference needs to be a stringparamsare passed as object map, not as array listdataof an error is an object- Batch processing of actions is not yet supported
Although a correlation identifier (id) is not necessary on top of HTTP, you should always include it to allow
the server to distinguish between sync calls and notifications. Omit the id only in case of a notification.
For notifications, the server will immediately respond with a 202 Accepted without a body.
Call an Action
Post a JSON-RPC request to make a call to an action
Authorizations:
Request Body schema: application/jsonrequired
The action in JSON-RPC format
Responses
Request samples
- Payload
{ }Response samples
- 200
{ }Post a completed translation.
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can add a completed translation for catalogues, datasets, distributions.
Authorizations:
Request Body schema: application/jsonrequired
JSON with the completed translations.
Responses
Request samples
- Payload
{ }