API reference

An overview of all the routes available in our API

The following headers can be sent with requests to the API to tailor it to your needs:

Name	Required	Description
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

List of existing assets

Get a (paginated) list of the assets you have documented in dScribe

GEThttps://__tenant__.dscribedata.com/api/assets

Authorization

BearerAuth

Query parameters

Response

200500

Successful operation

Body

application/json

metadataMetadata (object)

resultsarray of Asset (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/assets', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "metadata": {
    "page": 0,
    "pageSize": 0,
    "total": 0,
    "last_page": 0
  },
  "results": [
    {
      "id": "text",
      "name": "text",
      "description": {
        "raw": "text",
        "text": "text"
      },
      "asset_type": {
        "id": "text",
        "name": "text"
      },
      "properties": [
        {
          "value": [
            "text"
          ],
          "property_id": "text",
          "property_name": "text",
          "component": "text"
        }
      ]
    }
  ]
}

Upsert assets

Create one or more assets

POSThttps://__tenant__.dscribedata.com/api/assets

Authorization

BearerAuth

Body

application/json

The filters passed to the request.

idstring

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.

name*string

The name of the asset to be created.

discovery_policy_idstring

The id of the discovery policy of this asset. The discovery policy should already exist in the platform.

urlstring

A url pointing to the location of this specific asset in a source system.

descriptionstring

A description that will be shown on the asset in the dScribe platform.

asset_type*string

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.

dsesarray of Dse (object)

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

propertiesarray of PropertyValueUpsert (object)

The property values to store on this asset. The property itself will have to be created in the platform first.

Response

200400500

Successful operation

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/assets', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text",
        "asset_type": "text"
      }
    ]),
});
const data = await response.json();

Delete multiple assets

Delete one or more assets

DELETEhttps://__tenant__.dscribedata.com/api/assets

Authorization

BearerAuth

Body

application/json

A list of asset ids to be deleted.

itemsstring

Response

200400500

Successful operation

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/assets', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Search through existing assets

Get a (paginated) list of the assets you have documented in dScribe based on the defined filters

POSThttps://__tenant__.dscribedata.com/api/assets/search

Authorization

BearerAuth

Query parameters

Body

application/json

The filters passed to the request.

whereobject

Response

200500

Successful operation

Body

application/json

metadataMetadata (object)

resultsarray of Asset (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/assets/search', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "metadata": {
    "page": 0,
    "pageSize": 0,
    "total": 0,
    "last_page": 0
  },
  "results": [
    {
      "id": "text",
      "name": "text",
      "description": {
        "raw": "text",
        "text": "text"
      },
      "asset_type": {
        "id": "text",
        "name": "text"
      },
      "properties": [
        {
          "value": [
            "text"
          ],
          "property_id": "text",
          "property_name": "text",
          "component": "text"
        }
      ]
    }
  ]
}

Find one specific asset

Get an asset based on the passed id

GEThttps://__tenant__.dscribedata.com/api/assets/{id}

Authorization

BearerAuth

Path parameters

id*string

Query parameters

Response

200500

Successful operation

Body

application/json

idstring

name*string

descriptionobject

asset_type*object

propertiesarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/assets/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "description": {
    "raw": "text",
    "text": "text"
  },
  "asset_type": {
    "id": "text",
    "name": "text"
  },
  "properties": [
    {
      "value": [
        "text"
      ],
      "property_id": "text",
      "property_name": "text",
      "component": "text"
    }
  ]
}

Delete on asset

Delete an asset based on the passed id

DELETEhttps://__tenant__.dscribedata.com/api/assets/{id}

Authorization

BearerAuth

Path parameters

id*string

Response

204404500

Successful operation

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/assets/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

List existing dses

Get a (paginated) list of the dses you have documented in dScribe

GEThttps://__tenant__.dscribedata.com/api/dses

Authorization

BearerAuth

Query parameters

Response

200500

Successful operation

Body

application/json

metadataMetadata (object)

resultsarray of Dse (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/dses', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "metadata": {
    "page": 0,
    "pageSize": 0,
    "total": 0,
    "last_page": 0
  },
  "results": [
    {
      "id": "text",
      "name": "text",
      "parent": "text",
      "is_leaf": false,
      "assets": [
        "text"
      ],
      "dataset_id": "text",
      "description": "text"
    }
  ]
}

Upsert dses

Create one or more dses

POSThttps://__tenant__.dscribedata.com/api/dses

Authorization

BearerAuth

Body

application/json

The filters passed to the request.

idstring

name*string

parentstring

use the id of the parent dse if the you want to display the dses hierarchically within dScribe

is_leafboolean

Convenience property exposed to help you determine if the DSE has a parent

assetsarray of string

Assets the DSE is linked too

dataset_idstring

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

descriptionstring

childrenarray of DseToUpsert (object)

Response

200400500

Successful operation

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/dses', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text"
      }
    ]),
});
const data = await response.json();

Delete multiple dses

Delete one or more dses

DELETEhttps://__tenant__.dscribedata.com/api/dses

Authorization

BearerAuth

Body

application/json

A list of asset ids to be deleted.

itemsstring

Response

200400500

Successful operation

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/dses', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Search through existing dses

Get a (paginated) list of the dses you have documented in dScribe based on the defined filters

POSThttps://__tenant__.dscribedata.com/api/dses/search

Authorization

BearerAuth

Query parameters

Body

application/json

The filters passed to the request.

whereobject

Response

200500

Successful operation

Body

application/json

metadataMetadata (object)

resultsarray of Dse (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/dses/search', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "metadata": {
    "page": 0,
    "pageSize": 0,
    "total": 0,
    "last_page": 0
  },
  "results": [
    {
      "id": "text",
      "name": "text",
      "parent": "text",
      "is_leaf": false,
      "assets": [
        "text"
      ],
      "dataset_id": "text",
      "description": "text"
    }
  ]
}

Find one specific dse

Get a dse based on the passed id

GEThttps://__tenant__.dscribedata.com/api/dses/{id}

Authorization

BearerAuth

Path parameters

id*string

Response

200500

Successful operation

Body

application/json

idstring

name*string

parentstring

use the id of the parent dse if the you want to display the dses hierarchically within dScribe

is_leafboolean

Convenience property exposed to help you determine if the DSE has a parent

assetsarray of string

Assets the DSE is linked too

dataset_idstring

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

descriptionstring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/dses/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "parent": "text",
  "is_leaf": false,
  "assets": [
    "text"
  ],
  "dataset_id": "text",
  "description": "text"
}

Delete a dse

Delete a dse based on the passed id

DELETEhttps://__tenant__.dscribedata.com/api/dses/{id}

Authorization

BearerAuth

Path parameters

id*string

Response

204404500

Successful operation

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/dses/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Find one specific dse

Get a dse based on the passed id

GEThttps://__tenant__.dscribedata.com/api/dses/{id}

Authorization

BearerAuth

Path parameters

id*string

Response

200500

Successful operation

Body

application/json

idstring

name*string

parentstring

use the id of the parent dse if the you want to display the dses hierarchically within dScribe

is_leafboolean

Convenience property exposed to help you determine if the DSE has a parent

assetsarray of string

Assets the DSE is linked too

dataset_idstring

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

descriptionstring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/dses/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "parent": "text",
  "is_leaf": false,
  "assets": [
    "text"
  ],
  "dataset_id": "text",
  "description": "text"
}

Delete a dse

Delete a dse based on the passed id

DELETEhttps://__tenant__.dscribedata.com/api/dses/{id}

Authorization

BearerAuth

Path parameters

id*string

Response

204404500

Successful operation

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://__tenant__.dscribedata.com/api/dses/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();