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

Tessell Sample Dataset API

The Sample Dataset API from Tessell — 3 operation(s) for sample dataset.

Tessell Sample Dataset API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, {server}.

4 operations 3 paths 14 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.console.tessell.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Tessell Sample Dataset API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 4

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

Sample Dataset 4
GET
/services/{serviceId}/sample-datasets/suggestions
Returns details about sample datasets that can be loaded in the given DB Service
getSampleDatasetSuggestions 2 params → 200default
PATCH
/services/{serviceId}/sample-datasets/manage-suggestions
Controls if the sample data loading suggestions should be shown for the given DB Service
updateSampleDatasetSuggestion 2 params body → 200default
GET
/services/{serviceId}/sample-datasets
Get details about existing sample datasets being/already loaded in the given DB Service
getSampleDatasetLoadingInfo 2 params → 200default
POST
/services/{serviceId}/sample-datasets
Submits a request to load sample-dataset in given DB Service.
loadSampleDatasetRequest 2 params body → 200default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are SampleDatasetOpsDTO (14 properties), ServiceSampleDatasetLoadingInfo (7 properties), ApiError (7 properties), LoadSampleDatasetRequestPayload (6 properties). Each schema is shown below with its type and property counts.

SampleDatasetOpsDTO
object
Details about the sample dataset
14 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
apiStatus
object
2 properties
ManageLoadSampleDatasetSuggestionPayload
object
1 property 1 required
ServiceSampleDatasetInfoResponse
object
1 property
SampleDatasetOpsStatus
Status of the the sample dataset
databaseEngineType
string
Database Engine Type
apiResponse
object
2 properties
SampleDatasetSuggestionsResponse
object
1 property
apiPaginationInfo
object
2 properties
LoadSampleDatasetRequestPayload
object
Details needed to load a sample dataset in a DB Service
6 properties 1 required
SampleDatasetLoadingStatus
Status of the the sample dataset
ServiceSampleDatasetLoadingInfo
object
Details about the sample dataset being/already loaded in a DB Service.
7 properties
apiMetadata
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-sample-dataset-api-openapi.yml Raw ↑

Other APIs Tessell publishes across the network.

Tessell activity-center API
Tessell Ad Domain API
Tessell Ad Domain Governance API
Tessell agentController API
Tessell alert-controller API
Tessell Authorization API
Tessell Availability Machine API
Tessell azure-netapp-admin-controller API
Tessell azure-netapp-service-controller API
Tessell cloud-resource API
Tessell Compute API
Tessell Compute Governance API