What sample data is loaded

GET

/api/v1/samples

const url = 'http://localhost:11044/api/v1/samples';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/samples \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

One entry per set, with how many nodes it put in.

Authorizations

apiKeyAuth
basicAuth

Responses

200

*/*

What sample data this world holds: the sets that were loaded, and any label where sample records now sit beside real ones

object

mixedLabels

required

Labels holding sample and real records at once. Reported alongside deliberately: the answer to “what is loaded” is incomplete without “and is any of it sitting next to real records of the same type”

Array<object>

A label holding sample and real records at once — the case where a view over it returns both with nothing on the row to tell them apart

object

label

required

The label carrying both kinds

string

real

required

How many are real records

integer format: int32

sample

required

How many of its nodes are sample data

integer format: int32

sets

required

One entry per loaded set, with how many nodes it put in

Array<object>

One loaded sample set, and how much of this world it accounts for

object

name

required

The set’s name, which is what removes it again

string

nodes

required

How many nodes this set put into the world

integer format: int32

realm

The realm the set belongs to, where it came from one. Null for a set loaded on its own

string