List all datasets

Returns a list of datasets.

Path Parameters

namespace string required

Possible values: <= 1024 characters

The name of the namespace.

dataset string required

Possible values: <= 1024 characters

The name of the dataset.

Query Parameters

orderBy string

Default value: name

sortDirection string
pattern string

Default value: %

limit integer

Default value: 100

The number of results to return from offset.

offset integer

The initial position from which to return results.

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

datasets object[] required
Array [
id object
The ID of the dataset.
namespace string
The namespace of the dataset.
name string
The name of the dataset.
type string
The type of the dataset.
name string
The logical name of the dataset.
physicalName string
The physical name of the dataset.
createdAt date-time
An ISO-8601 timestamp representing the date/time the dataset was created.
updatedAt date-time
An ISO-8601 timestamp representing the date/time the dataset was updated.
namespace string
The namespace of the dataset.
sourceName string
The name of the source associated with the dataset.
fields object[]
The fields of the dataset.
Array [
name string required
The name of the field.
type string required
The data type of the field.
tags string[]
List of tags.
description string
The description of the field.
]
tags string[]
List of tags.
lastModifiedAt date-time
An ISO-8601 timestamp representing the date/time the dataset was last modified by a successful run.
lastLifecycleState string
The last lifecycle state of the dataset.
description string
The description of the dataset.
facets object
The facets of the dataset. For a full list of standard dataset facets, see OpenLineage.
description
allOf
title
currentVersion uuid
The current version of the dataset.
deleted boolean
The deleted state of the dataset.
]
totalCount number

The total number of datasets for the given namespace

{
  "datasets": [
    {
      "id": {
        "namespace": "my-namespace",
        "name": "my-dataset"
      },
      "type": "DB_TABLE",
      "name": "my-dataset",
      "physicalName": "public.mytable",
      "createdAt": "2019-05-09T19:49:24.201361Z",
      "updatedAt": "2019-05-09T19:49:24.201361Z",
      "namespace": "my-namespace",
      "sourceName": "my-source",
      "fields": [
        {
          "name'": "a",
          "type": "INTEGER",
          "tags": []
        },
        {
          "name'": "b",
          "type": "TIMESTAMP",
          "tags": []
        },
        {
          "name'": "c",
          "type": "INTEGER",
          "tags": []
        },
        {
          "name'": "d",
          "type": "INTEGER",
          "tags": []
        }
      ],
      "tags": [],
      "lastModifiedAt": null,
      "description": "My first dataset!",
      "facets": {},
      "currentVersion": "b1d626a2-6d3a-475e-9ecf-943176d4a8c6"
    }
  ],
  "totalCount": 0
}

GET /namespaces/:namespace/datasets

Request

Base URL

http://localhost:5000/api/v1

namespace — path required

dataset — path required

orderBy — query

sortDirection — query

pattern — query

limit — query

offset — query

curl / cURL

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'http://localhost:5000/api/v1/namespaces/:namespace/datasets' \
-H 'Accept: application/json'