Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TetraScience IDS API

The IDS API from TetraScience — 8 operation(s) for ids.

TetraScience IDS API is one of 35 APIs that TetraScience publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IDS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, and authentication docs.

This API exposes 8 operations across 8 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 4.0.

Requests are made against 5 base URLs: https://api.tetrascience.com, https://api.tetrascience-uat.com, https://api.tetrascience-dev.com, https://api.tetrascience-uat.com, api.tetrascience.com.

8 operations 8 paths 9 schemas 7 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0
Base URL
https://api.tetrascience.com
Authentication
API Key, API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 3

TetraScience IDS API declares 3 security schemes for authenticating requests. An API key is passed in the header as ts-auth-token (token). An API key is passed in the header as x-org-slug (orgSlug). An API key is passed in the header as ts-auth-token (tsAuthToken). By default, every request must be authenticated.

  • token — JWT Token for authentication
  • orgSlug — Your organization slug

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 7 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

IDS 8
GET
/v1/artifacts/ids/{namespace}
List all IDSes for namespace
getIdsArtifactByNamespace 3 params → 200404
GET
/v1/artifacts/ids/{namespace}/{slug}
Returns a list of IDS artifacts given a namespace and slug
getIdsArtifactByNamespaceAndSlug 4 params → 200404
GET
/v1/artifacts/ids/{namespace}/{slug}/{version}/files/{fileSlug}
Get contents for an IDS file
getIdsArtifactByNamespaceSlugAndFileSlug 6 params → 200400404
GET
/v1/artifacts/ids/{namespace}/{slug}/{version}
Get single IDS
getIdsArtifactByNamespaceSlugAndVersion 4 params → 200404
GET
/v1/artifacts/ids/{namespace}/{slug}/{version}/labels
Get labels for an IDS
getIdsArtifactLabels 4 params → 200404
GET
/v1/artifacts/ids/{namespace}/{slug}/{version}/relationships
Get artifacts related to IDS
getIdsArtifactRelationships 4 params → 200404
GET
/v1/artifacts/ids
List all ids artifacts
getIdsArtifacts 3 params → 200
POST
/v1/artifacts/ids/search
Search for items
searchIds 3 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ArtifactObjectBase (9 properties), Key (4 properties), Relationships (4 properties), SupportedPlatformVersion (2 properties). Each schema is shown below with its type and property counts.

Relationships
object
4 properties
LabelList
array
IdsObject
SupportedPlatformVersion
object
2 properties
IdsFileSlug
string
ArtifactNamespace
string
ArtifactObjectBase
object
9 properties 5 required
Key
object
4 properties 4 required
IdsObjectList
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrascience-ids-api-openapi.yml Raw ↑

Other APIs TetraScience publishes across the network.

TetraScience Access Groups API
TetraScience Agents API
TetraScience ai-workflows API
TetraScience Attributes API
TetraScience Audit Trail API
TetraScience clusters API
TetraScience Commands API
TetraScience Connectors API
TetraScience Data Acquisition API
TetraScience Data App Providers API
TetraScience Data Apps API
TetraScience databricks API