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

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

Authorizations

Query parameters

pageinteger · int32 · min: 1Optional

Page from which to start returning results

Default: 1

pageSizeinteger · int32Optional

Number of results to return

Default: 15

addPropertyValueLabelbooleanOptional

Add the label (and not only id) of property values returned on the asset

Default: false

wysywigPropsAsFullTextbooleanOptional

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...)

Default: false

Responses

200

Successful operation

application/json

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/assets HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "metadata": {
    "page": 1,
    "pageSize": 1,
    "total": 1,
    "last_page": 1
  },
  "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

post

Create one or more assets

Authorizations

Body

idstringOptional

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.

namestringRequired

The name of the asset to be created.

discovery_policy_idstringOptional

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

urlstringOptional

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

descriptionstringOptional

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

asset_typestringRequired

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.

Responses

200

Successful operation

400

One of the values passed to the API is wrong

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /api/assets HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 294

[
  {
    "id": "text",
    "name": "text",
    "discovery_policy_id": "text",
    "url": "text",
    "description": "text",
    "asset_type": "text",
    "dses": [
      {
        "id": "text",
        "name": "text",
        "parent": "text",
        "is_leaf": true,
        "assets": [
          "text"
        ],
        "dataset_id": "text",
        "description": "text"
      }
    ],
    "properties": [
      {
        "property_id": "text",
        "value": [
          "text"
        ]
      }
    ]
  }
]

No content

Delete multiple assets

delete

Delete one or more assets

Authorizations

Body

string[]Optional

Responses

200

Successful operation

400

One of the values passed to the API is wrong

500

Internal server error

delete

HTTPcURLJavaScriptPython

DELETE /api/assets HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content

Search through existing assets

post

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

Authorizations

Query parameters

pageinteger · int32 · min: 1Optional

Page from which to start returning results

Default: 1

pageSizeinteger · int32Optional

Number of results to return

Default: 15

addPropertyValueLabelbooleanOptional

Add the label (and not only id) of property values returned on the asset

Default: false

wysywigPropsAsFullTextbooleanOptional

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...)

Default: false

Body

Responses

200

Successful operation

application/json

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /api/assets/search HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "where": {
    "name_contains": "text"
  }
}

{
  "metadata": {
    "page": 1,
    "pageSize": 1,
    "total": 1,
    "last_page": 1
  },
  "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

Get an asset based on the passed id

Authorizations

Path parameters

idstringRequired

Query parameters

addPropertyValueLabelbooleanOptional

Add the label (and not only id) of property values returned on the asset

Default: false

wysywigPropsAsFullTextbooleanOptional

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...)

Default: false

Responses

200

Successful operation

application/json

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/assets/{id} HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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

Delete an asset based on the passed id

Authorizations

Path parameters

idstringRequired

Responses

204

Successful operation

404

Asset not found

500

Internal server error

delete

HTTPcURLJavaScriptPython

DELETE /api/assets/{id} HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List existing dses

get

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

Authorizations

Query parameters

pageinteger · int32 · min: 1Optional

Page from which to start returning results

Default: 1

pageSizeinteger · int32Optional

Number of results to return

Default: 15

Responses

200

Successful operation

application/json

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/dses HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Upsert dses

post

Create one or more dses

Authorizations

Body

idstringOptional

namestringRequired

parentstringOptional

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

is_leafbooleanOptional

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

assetsstring[]Optional

Assets the DSE is linked too

dataset_idstringOptional

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

descriptionstringOptional

Responses

200

Successful operation

400

One of the values passed to the API is wrong

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /api/dses HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 415

[
  {
    "id": "text",
    "name": "text",
    "parent": "text",
    "is_leaf": true,
    "assets": [
      "text"
    ],
    "dataset_id": "text",
    "description": "text",
    "children": [
      {
        "id": "text",
        "name": "text",
        "parent": "text",
        "is_leaf": true,
        "assets": [
          "text"
        ],
        "dataset_id": "text",
        "description": "text",
        "children": [
          {
            "id": "text",
            "name": "text",
            "parent": "text",
            "is_leaf": true,
            "assets": [
              "text"
            ],
            "dataset_id": "text",
            "description": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    ]
  }
]

No content

Delete multiple dses

delete

Delete one or more dses

Authorizations

Body

string[]Optional

Responses

200

Successful operation

400

One of the values passed to the API is wrong

500

Internal server error

delete

HTTPcURLJavaScriptPython

DELETE /api/dses HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content

Search through existing dses

post

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

Authorizations

Query parameters

pageinteger · int32 · min: 1Optional

Page from which to start returning results

Default: 1

pageSizeinteger · int32Optional

Number of results to return

Default: 15

Body

Responses

200

Successful operation

application/json

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /api/dses/search HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "where": {
    "name_contains": "text",
    "parent": "text",
    "dataset_id": "text"
  }
}

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

Find one specific dse

get

Get a dse based on the passed id

Authorizations

Path parameters

idstringRequired

Responses

200

Successful operation

application/json

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/dses/{id} HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Delete a dse

delete

Delete a dse based on the passed id

Authorizations

Path parameters

idstringRequired

Responses

204

Successful operation

404

Asset not found

500

Internal server error

delete

HTTPcURLJavaScriptPython

DELETE /api/dses/{id} HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Find one specific dse

get

Get a dse based on the passed id

Authorizations

Path parameters

idstringRequired

Responses

200

Successful operation

application/json

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/dses/{id} HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Delete a dse

delete

Delete a dse based on the passed id

Authorizations

Path parameters

idstringRequired

Responses

204

Successful operation

404

Asset not found

500

Internal server error

delete

HTTPcURLJavaScriptPython

DELETE /api/dses/{id} HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content