API reference
An overview of all the routes available in our API
Last updated
An overview of all the routes available in our API
Last updated
The following headers can be sent with requests to the API to tailor it to your needs:
Content-Type
No
The format the client requests the data in. Only supported value is application/json
.
Authorization
Yes
The Bearer token used to authenticate requests.
Accept
No
This header can be used to requests a different version from the API. This allows clients to switch to new breaking versions on their own time. The default is version=1
Get a (paginated) list of the assets you have documented in dScribe
/api/assets
Page from which to start returning results
Number of results to return
Add the label (and not only id) of property values returned on the asset
If true, the wysywig property value will be returned as full text instead of the the WYSYWIG JSON format (the JSON format includes mentions, links, images, etc...)
Create one or more assets
/api/assets
The ID of the asset to be created. If not provided, one will be generated for you. If provided, we will first try to update the asset before creating.
The name of the asset to be created.
The id of the discovery policy of this asset. The discovery policy should already exist in the platform.
A url pointing to the location of this specific asset in a source system.
A description that will be shown on the asset in the dScribe platform.
The id of the asset type. This equals a slugified version of the name. The asset type will have to exist in our system first. You can find the id on the Asset Type details page in the web application.
When creating a dataset, it is possible to immediately create dses. Just provide an array of dses as detailed in the dse docs. See an example here
The property values to store on this asset. The property itself will have to be created in the platform first.
No body
Delete one or more assets
/api/assets
No body
Get a (paginated) list of the assets you have documented in dScribe based on the defined filters
/api/assets/search
Page from which to start returning results
Number of results to return
Add the label (and not only id) of property values returned on the asset
If true, the wysywig property value will be returned as full text instead of the the WYSYWIG JSON format (the JSON format includes mentions, links, images, etc...)
Get an asset based on the passed id
/api/assets/{id}
Add the label (and not only id) of property values returned on the asset
If true, the wysywig property value will be returned as full text instead of the the WYSYWIG JSON format (the JSON format includes mentions, links, images, etc...)
Delete an asset based on the passed id
/api/assets/{id}
No body
Get a (paginated) list of the dses you have documented in dScribe
/api/dses
Page from which to start returning results
Number of results to return
Create one or more dses
/api/dses
use the id of the parent dse if the you want to display the dses hierarchically within dScribe
Convenience property exposed to help you determine if the DSE has a parent
The dataset id the dse is linked too. If the DSEs are created together with the dataset (via POST /api/assets), it will automatically use the created dataset id
Assets the DSE is linked too
No body
Delete one or more dses
/api/dses
No body
Get a (paginated) list of the dses you have documented in dScribe based on the defined filters
/api/dses/search
Page from which to start returning results
Number of results to return
Get a dse based on the passed id
/api/dses/{id}
Delete a dse based on the passed id
/api/dses/{id}
No body
Get a dse based on the passed id
/api/dses/{id}
Delete a dse based on the passed id
/api/dses/{id}
No body