Sign in

v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB
Schemas

List Schemas

Retrieves schema information for all IDS (Intermediate Data Schema) in the organization.

Performance Notice: This endpoint may timeout with large datasets (500+ schemas). For better performance, use the targeted alternatives below.

Recommended Alternatives:

  1. List available IDS (if needed): GET /v1/artifacts/ids
  2. Get specific components:
  • Schema: GET /v1/artifacts/ids/{namespace}/{slug}/{version}/files/schema
  • Mapping: GET /v1/artifacts/ids/{namespace}/{slug}/{version}/files/mapping
  • Expected: GET /v1/artifacts/ids/{namespace}/{slug}/{version}/files/expected
  • README: GET /v1/artifacts/ids/{namespace}/{slug}/{version}/files/readme

When to use alternatives: If you need specific schema details or are working with organizations that have many IDS definitions.

get/v1/datalake/schemas

Query parameters

typestring

Return only IDS of a given type. Example: plate-reader. If omitted, will return the all the IDS the api key has access to.

versionstring

Return a specific version. This must be used with type. Example: v1.0.0. If omitted, will return all the versions.

fieldsstring

Comma-separated list of fields to return (nested paths are also supported). Example: namespace,slug,version,schema.description. If omitted, will return full structure. Not-existing fields will be ignored.

Headers

ts-auth-tokenstring required

JWT Token

x-org-slugstring required

Your organization slug

Response

200

namespacestring
slugstring
versionstring
expectedobject
elasticsearchobject
athenaobject
readmestring

Example response

[
  {
    "namespace": "common",
    "slug": "some-identificator",
    "version": "v1.0.0",
    "schema": {
      "type": "object",
      "properties": {
        "assay_name": {
          "type": "string"
        },
        "temperature": {
          "type": "number"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time"
        },
        "readout": {
          "type": "array",
          "items": {
            "type": "number"
          }
        }
      }
    },
    "readme": "Some text"
  }
]