Creates a new app token for metered public API access. This endpoint is unauthenticated — no session or credentials are required. The token is created in the `pending` state and a 6-digit verification code is emailed to the supplied address. The token value is **not** issued yet — confirm the code with `POST /app-token/verify` to activate the token and receive its value (shown only once). The server assigns a default read quota. The token grants access to public data only, metered by the read quota. Once active, pass the token via the `X-App-Token` header on subsequent requests.

/app-token

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.entryscape.com/app-token" \
 -d '{
  "name" : "my-data-app",
  "email" : "owner@example.com"
}'

var api = new Entryscape.AppTokenApi();
api.createAppToken({name: 'my-data-app', email: 'owner@example.com'}, function(error, data) {
  if (!error) {
    console.log('Token ID:', data.id);
    console.log('Status:', data.status);
    // data.token is null until verified via POST /app-token/verify
    console.log('Check', data.email, 'for the 6-digit verification code');
  }
});

const api = new AppTokenApi(config);
const response = await api.createAppToken({
  appTokenCreateRequest: { name: 'my-data-app', email: 'owner@example.com' },
});
console.log('Token ID:', response.id);
console.log('Status:', response.status);
// response.token is null until verified via POST /app-token/verify
console.log('Check', response.email, 'for the 6-digit verification code');

api_instance = entryscape_client.AppTokenApi()
response = api_instance.create_app_token(
    app_token_create_request={'name': 'my-data-app', 'email': 'owner@example.com'}
)
print(f'Token ID: {response.id}')
print(f'Status: {response.status}')
# response.token is None until verified via POST /app-token/verify
print(f'Check {response.email} for the 6-digit verification code')

var apiInstance = new AppTokenApi();
var response = apiInstance.CreateAppToken(
    appTokenCreateRequest: new AppTokenCreateRequest(name: "my-data-app", email: "owner@example.com")
);
Debug.WriteLine("Token ID: " + response.Id);
Debug.WriteLine("Status: " + response.Status);
// response.Token is null until verified via POST /app-token/verify
Debug.WriteLine("Check " + response.Email + " for the 6-digit verification code");

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns details and quota usage for a specific app token. Requires authentication via the `X-App-Token` header. The token in the header must match the token associated with the requested app token ID.

/app-token/{app_token_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
-H "X-App-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/app-token/{app_token_id}"

var client = Entryscape.ApiClient.instance;
client.authentications['app_token_header'].apiKey = 'YOUR_APP_TOKEN';
var api = new Entryscape.AppTokenApi();
api.getAppToken('550e8400-e29b-41d4-a716-446655440000', function(error, data) {
  if (!error) {
    console.log('Token ID:', data.id);
    console.log('Name:', data.name);
    console.log('Quota:', data.read_quota);
    console.log('Used:', data.reads_used);
  }
});

const config = new Configuration({
  apiKey: { 'X-App-Token': 'YOUR_APP_TOKEN' },
});
const api = new AppTokenApi(config);
const response = await api.getAppToken({
  appTokenId: '550e8400-e29b-41d4-a716-446655440000',
});
console.log('Token ID:', response.id);
console.log('Name:', response.name);
console.log('Quota:', response.readQuota);
console.log('Used:', response.readsUsed);

configuration = entryscape_client.Configuration()
configuration.api_key['X-App-Token'] = 'YOUR_APP_TOKEN'
api_instance = entryscape_client.AppTokenApi(
    entryscape_client.ApiClient(configuration)
)
response = api_instance.get_app_token(
    app_token_id='550e8400-e29b-41d4-a716-446655440000'
)
print(f'Token ID: {response.id}')
print(f'Name: {response.name}')
print(f'Quota: {response.read_quota}')
print(f'Used: {response.reads_used}')

var config = new Configuration();
config.ApiKey.Add("X-App-Token", "YOUR_APP_TOKEN");
var apiInstance = new AppTokenApi(config);
var response = apiInstance.GetAppToken(
    appTokenId: "550e8400-e29b-41d4-a716-446655440000"
);
Debug.WriteLine("Token ID: " + response.Id);
Debug.WriteLine("Name: " + response.Name);
Debug.WriteLine("Quota: " + response.ReadQuota);
Debug.WriteLine("Used: " + response.ReadsUsed);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Verifies a pending app token by confirming the 6-digit code that was emailed to the owner at creation time. This endpoint is unauthenticated — no session or credentials are required. On success the token transitions from `pending` to `active` and the response includes the token value, which is only shown once. Store it securely; it cannot be retrieved again. Pass the token via the `X-App-Token` header on subsequent requests.

/app-token/verify

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.entryscape.com/app-token/verify" \
 -d '{
  "id" : "550e8400-e29b-41d4-a716-446655440000",
  "code" : "123456"
}'

var api = new Entryscape.AppTokenApi();
api.verifyAppToken({
  id: '550e8400-e29b-41d4-a716-446655440000',
  code: '123456',
}, function(error, data) {
  if (!error) {
    console.log('Status:', data.status);
    console.log('Token:', data.token);
  }
});

const api = new AppTokenApi(config);
const response = await api.verifyAppToken({
  appTokenVerifyRequest: {
    id: '550e8400-e29b-41d4-a716-446655440000',
    code: '123456',
  },
});
console.log('Status:', response.status);
console.log('Token:', response.token);

api_instance = entryscape_client.AppTokenApi()
response = api_instance.verify_app_token(
    app_token_verify_request={
        'id': '550e8400-e29b-41d4-a716-446655440000',
        'code': '123456',
    }
)
print(f'Status: {response.status}')
print(f'Token: {response.token}')

var apiInstance = new AppTokenApi();
var response = apiInstance.VerifyAppToken(
    appTokenVerifyRequest: new AppTokenVerifyRequest(
        id: "550e8400-e29b-41d4-a716-446655440000",
        code: "123456"
    )
);
Debug.WriteLine("Status: " + response.Status);
Debug.WriteLine("Token: " + response.Token);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example
• Headers

• Schema
• Response Example

• Schema
• Response Example

Authenticates an EntryStore user and starts a session. The API server forwards the credentials to EntryStore's `auth/cookie` endpoint and never logs or stores them. On success the response body contains the `auth_token` — send it on subsequent requests via the `X-Auth-Token` header. The same token is also set as the `auth_token` cookie (`SameSite=Lax; Secure`) for browser clients. This endpoint is unauthenticated and CSRF-exempt, and is rate-limited per client to deter credential stuffing.

/auth/login

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.entryscape.com/auth/login?entrystore_host=dev.entryscape.com/store/" \
 -d '{
  "password" : "password",
  "max_age_seconds" : 604800,
  "username" : "example@metasolutions.se"
}'

var api = new Entryscape.AuthApi();
api.login({username: 'example@metasolutions.se', password: 'your-password'}, function(error, data) {
  if (!error) {
    console.log('Token:', data.auth_token);
    console.log('User:', data.user);
  }
});

const api = new AuthApi(config);
const response = await api.login({
  loginRequest: { username: 'example@metasolutions.se', password: 'your-password' },
});
console.log('Token:', response.authToken);
console.log('User:', response.user);

api_instance = entryscape_client.AuthApi()
response = api_instance.login(
    login_request={'username': 'example@metasolutions.se', 'password': 'your-password'}
)
print(f'Token: {response.auth_token}')
print(f'User: {response.user}')

var apiInstance = new AuthApi();
var response = apiInstance.Login(
    loginRequest: new LoginRequest(username: "example@metasolutions.se", password: "your-password")
);
Debug.WriteLine("Token: " + response.AuthToken);
Debug.WriteLine("User: " + response.User);

Scopes

Parameters

Responses

• Schema
• Response Example
• Headers

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example
• Headers

• Schema
• Response Example

• Schema
• Response Example

Ends the session by invalidating the token via EntryStore's `auth/logout` endpoint, and clears the `auth_token` cookie. Send the token in the `X-Auth-Token` header (or the `auth_token` cookie in browsers).

/auth/logout

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X POST \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/auth/logout?entrystore_host=dev.entryscape.com/store/"

var api = new Entryscape.AuthApi();
api.logout(function(error) {
  if (!error) {
    console.log('Logged out');
  }
});

const api = new AuthApi(config);
await api.logout();

api_instance = entryscape_client.AuthApi()
api_instance.logout()

var apiInstance = new AuthApi();
apiInstance.Logout();

Scopes

Parameters

Responses

• Headers

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns the EntryStore user associated with the supplied session token, resolved via EntryStore's `auth/user` endpoint. Send the token in the `X-Auth-Token` header (or the `auth_token` cookie in browsers). A request with no or an invalid token returns `authenticated: false` with a guest/anonymous user rather than an error.

/auth/whoami

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/auth/whoami?entrystore_host=dev.entryscape.com/store/"

var api = new Entryscape.AuthApi();
api.whoami(function(error, data) {
  if (!error) {
    console.log('User:', data.user, 'Authenticated:', data.authenticated);
  }
});

const api = new AuthApi(config);
const response = await api.whoami();
console.log('User:', response.user, 'Authenticated:', response.authenticated);

api_instance = entryscape_client.AuthApi()
response = api_instance.whoami()
print(f'User: {response.user}, Authenticated: {response.authenticated}')

var apiInstance = new AuthApi();
var response = apiInstance.Whoami();
Debug.WriteLine("User: " + response.User + ", Authenticated: " + response.Authenticated);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Creates a new catalog in the specified context. The request body must contain valid DCAT-AP metadata in JSON-LD format. Requires authentication with write access to the target context.

/catalog

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X POST \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/ld+json" \
 "https://api.entryscape.com/catalog?entrystore_host=dev.entryscape.com/store/&context=1" \
 -d 'Custom MIME type example not yet supported: application/ld+json'

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.CatalogApi();
var metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:Catalog',
  'dct:title': [{ '@value': 'My Catalog', '@language': 'en' }],
  'dct:description': [{ '@value': 'A new catalog', '@language': 'en' }]
};
api.createCatalog('1', metadata, function(error, data) {
  if (!error) {
    console.log('Created:', data.context_id + '/' + data.entry_id);
    console.log('URI:', data.uri);
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new CatalogApi(config);
const metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:Catalog',
  'dct:title': [{ '@value': 'My Catalog', '@language': 'en' }],
  'dct:description': [{ '@value': 'A new catalog', '@language': 'en' }],
};
const response = await api.createCatalog({
  context: '1',
  body: metadata,
});
console.log(`Created: ${response.contextId}/${response.entryId}`);
console.log('URI:', response.uri);

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.CatalogApi(
    entryscape_client.ApiClient(configuration)
)
metadata = {
    '@context': {'dcat': 'http://www.w3.org/ns/dcat#', 'dct': 'http://purl.org/dc/terms/'},
    '@type': 'dcat:Catalog',
    'dct:title': [{'@value': 'My Catalog', '@language': 'en'}],
    'dct:description': [{'@value': 'A new catalog', '@language': 'en'}],
}
response = api_instance.create_catalog(context='1', body=metadata)
print(f'Created: {response.context_id}/{response.entry_id}')
print(f'URI: {response.uri}')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new CatalogApi(config);
var metadata = new Dictionary<string, object>
{
    {"@context", new Dictionary<string, string> {{"dcat", "http://www.w3.org/ns/dcat#"}, {"dct", "http://purl.org/dc/terms/"}}},
    {"@type", "dcat:Catalog"},
    {"dct:title", new List<object> {
        new Dictionary<string, string> {{"@value", "My Catalog"}, {"@language", "en"}}
    }}
};
var response = apiInstance.CreateCatalog(context: "1", body: metadata);
Debug.WriteLine($"Created: {response.ContextId}/{response.EntryId}");
Debug.WriteLine("URI: " + response.Uri);

Scopes

Parameters

Responses

• Schema
• Response Example
• Headers

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Deletes a specific catalog and its associated metadata. This operation is irreversible. Requires authentication with write access to the entry's context.

/catalog/{context_id}/{entry_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X DELETE \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/catalog/{context_id}/{entry_id}?entrystore_host=dev.entryscape.com/store/"

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.CatalogApi();
api.deleteCatalog('1', '100', function(error) {
  if (!error) {
    console.log('Catalog deleted successfully');
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new CatalogApi(config);
await api.deleteCatalog({
  contextId: '1',
  entryId: '100',
});
console.log('Catalog deleted successfully');

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.CatalogApi(
    entryscape_client.ApiClient(configuration)
)
api_instance.delete_catalog(context_id='1', entry_id='100')
print('Catalog deleted successfully')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new CatalogApi(config);
apiInstance.DeleteCatalog(contextId: "1", entryId: "100");
Debug.WriteLine("Catalog deleted successfully");

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns basic reference information for a specific catalog. Use the /metadata sub-endpoint to retrieve the full DCAT-AP metadata. Authentication is optional. Public entries are accessible without authentication. Authenticated requests may access additional non-public entries.

/catalog/{context_id}/{entry_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/catalog/{context_id}/{entry_id}?entrystore_host=dev.entryscape.com/store/"

var api = new Entryscape.CatalogApi();
api.getCatalog('1', '100', function(error, data) {
  if (!error) {
    console.log('Context ID:', data.context_id);
    console.log('Entry ID:', data.entry_id);
    console.log('URI:', data.uri);
    console.log('Entity Type:', data.entity_type);
    console.log('Created:', data.created);
  }
});

const api = new CatalogApi(config);
const response = await api.getCatalog({
  contextId: '1',
  entryId: '100',
});
console.log('Context ID:', response.contextId);
console.log('Entry ID:', response.entryId);
console.log('URI:', response.uri);
console.log('Entity Type:', response.entityType);
console.log('Created:', response.created);

api_instance = entryscape_client.CatalogApi()
response = api_instance.get_catalog(
    context_id='1', entry_id='100'
)
print(f'Context ID: {response.context_id}')
print(f'Entry ID: {response.entry_id}')
print(f'URI: {response.uri}')
print(f'Entity Type: {response.entity_type}')
print(f'Created: {response.created}')

var apiInstance = new CatalogApi();
var response = apiInstance.GetCatalog(
    contextId: "1", entryId: "100"
);
Debug.WriteLine("Context ID: " + response.ContextId);
Debug.WriteLine("Entry ID: " + response.EntryId);
Debug.WriteLine("URI: " + response.Uri);
Debug.WriteLine("Entity Type: " + response.EntityType);
Debug.WriteLine("Created: " + response.Created);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns the raw DCAT-AP metadata for a specific catalog. The response format can be specified using the `format` query parameter. Authentication is optional. Public entries are accessible without authentication. Authenticated requests may access additional non-public entries.

/catalog/{context_id}/{entry_id}/metadata

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/ld+json,application/rdf+json,text/turtle,application/n-triples,application/rdf+xml,application/json" \
 "https://api.entryscape.com/catalog/{context_id}/{entry_id}/metadata?entrystore_host=dev.entryscape.com/store/&format=json-ld"

var api = new Entryscape.CatalogApi();
api.getCatalogMetadata('1', '100', function(error, data) {
  if (!error) {
    var entity = data['@graph'] ? data['@graph'][0] : data;
    var titleValue = entity['dcterms:title'] || entity['dct:title'];
    var title = Array.isArray(titleValue)
      ? (titleValue.find(function(v) { return v['@language'] === 'en'; }) || titleValue[0] || {})['@value']
      : (titleValue && typeof titleValue === 'object') ? titleValue['@value'] : titleValue;
    console.log('Title:', title);
    console.log('Full response:', data);
  }
});

const api = new CatalogApi(config);
const response = await api.getCatalogMetadata({
  contextId: '1',
  entryId: '100',
});
const metadata = response as Record<string, unknown>;
const entity = '@graph' in metadata && Array.isArray(metadata['@graph'])
  ? metadata['@graph'][0] as Record<string, unknown>
  : metadata;
const titleValue = entity['dcterms:title'] || entity['dct:title'];
const title = Array.isArray(titleValue)
  ? titleValue.find((v: any) => v['@language'] === 'en')?.['@value'] || titleValue[0]?.['@value']
  : typeof titleValue === 'object' ? (titleValue as any)['@value'] : titleValue;
console.log('Title:', title);
console.log('Full response:', response);

api_instance = entryscape_client.CatalogApi()
response = api_instance.get_catalog_metadata(
    context_id='1', entry_id='100'
)
metadata = response if isinstance(response, dict) else response.to_dict()
entity = metadata.get('@graph', [{}])[0] if '@graph' in metadata else metadata
title_value = entity.get('dcterms:title') or entity.get('dct:title')
if isinstance(title_value, list):
    title = next((v.get('@value') for v in title_value if v.get('@language') == 'en'),
                 title_value[0].get('@value') if title_value else None)
elif isinstance(title_value, dict):
    title = title_value.get('@value')
else:
    title = title_value
print(f'Title: {title}')

var apiInstance = new CatalogApi();
var response = apiInstance.GetCatalogMetadata(
    contextId: "1", entryId: "100"
);
var metadata = response as Dictionary<string, object>;
if (metadata != null && metadata.ContainsKey("@graph"))
{
    var graph = metadata["@graph"] as List<object>;
    var entity = graph?[0] as Dictionary<string, object>;
    object titleValue;
    entity?.TryGetValue("dcterms:title", out titleValue);
    Debug.WriteLine("Title: " + titleValue);
}
Debug.WriteLine(response);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns a paginated list of the data services this catalog links with `dcat:service`. Membership is the link, not the context: a data service the catalog does not link is not listed here, and a catalog that links none answers with zero results. Authentication is optional. Without authentication, only publicly available entries are returned. Authenticated requests may return additional non-public entries. Answered from an asynchronously updated index: an entry created moments ago may be missing here while reading it by id already returns it. The alpha `configured_type` filter narrows existing route membership without changing legacy `entity_type`. Matching and authorization occur before pagination and counts; see the parameter for details.

/catalog/{context_id}/{entry_id}/dataservices

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/catalog/{context_id}/{entry_id}/dataservices?entrystore_host=dev.entryscape.com/store/&limit=56&offset=56&cursor=AoE/EGVudHJ5OjEvMTAw&query=open data&sort=title+asc,modified+desc&public=true&created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z&modified_after=2024-01-01T00:00:00Z&modified_before=2024-12-31T23:59:59Z&configured_type=https://example.org/store/entitytypes/resource/example_geo"

var api = new Entryscape.CatalogApi();
var opts = {
  'query': 'weather'
};
api.listCatalogDataservices('1', '100', opts, function(error, data) {
  if (!error) {
    console.log('Total results:', data.results);
    data.items.forEach(function(item) {
      console.log('- [' + item.context_id + '/' + item.entry_id + '] ' + item.entity_type);
    });
  }
});

const api = new CatalogApi(config);
const response = await api.listCatalogDataservices({
  contextId: '1',
  entryId: '100',
  query: 'weather',
});
console.log('Total results:', response.results);
for (const item of response.items) {
  console.log(`- [${item.contextId}/${item.entryId}] ${item.entityType}`);
}

api_instance = entryscape_client.CatalogApi()
response = api_instance.list_catalog_dataservices(
    context_id='1', entry_id='100',
    query='weather'
)
print(f'Total results: {response.results}')
for item in response.items:
    print(f'- [{item.context_id}/{item.entry_id}] {item.entity_type}')

var apiInstance = new CatalogApi();
var response = apiInstance.ListCatalogDataservices(
    contextId: "1", entryId: "100",
    query: "weather"
);
Debug.WriteLine("Total results: " + response.Results);
foreach (var item in response.Items)
{
    Debug.WriteLine($"- [{item.ContextId}/{item.EntryId}] {item.EntityType}");
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns a paginated list of the datasets this catalog links with `dcat:dataset`. Membership is the link, not the context: a dataset the catalog does not link is not listed here, and a catalog that links none answers with zero results. Authentication is optional. Without authentication, only publicly available entries are returned. Authenticated requests may return additional non-public entries. Answered from an asynchronously updated index: an entry created moments ago may be missing here while reading it by id already returns it. The alpha `configured_type` filter narrows existing route membership without changing legacy `entity_type`. Matching and authorization occur before pagination and counts; see the parameter for details.

/catalog/{context_id}/{entry_id}/datasets

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/catalog/{context_id}/{entry_id}/datasets?entrystore_host=dev.entryscape.com/store/&limit=56&offset=56&cursor=AoE/EGVudHJ5OjEvMTAw&query=open data&sort=title+asc,modified+desc&public=true&created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z&modified_after=2024-01-01T00:00:00Z&modified_before=2024-12-31T23:59:59Z&configured_type=https://example.org/store/entitytypes/resource/example_geo"

var api = new Entryscape.CatalogApi();
var opts = {
  'query': 'transport'
};
api.listCatalogDatasets('1', '100', opts, function(error, data) {
  if (!error) {
    console.log('Total results:', data.results);
    data.items.forEach(function(item) {
      console.log('- [' + item.context_id + '/' + item.entry_id + '] ' + item.entity_type);
    });
  }
});

const api = new CatalogApi(config);
const response = await api.listCatalogDatasets({
  contextId: '1',
  entryId: '100',
  query: 'transport',
});
console.log('Total results:', response.results);
for (const item of response.items) {
  console.log(`- [${item.contextId}/${item.entryId}] ${item.entityType}`);
}

api_instance = entryscape_client.CatalogApi()
response = api_instance.list_catalog_datasets(
    context_id='1', entry_id='100',
    query='transport'
)
print(f'Total results: {response.results}')
for item in response.items:
    print(f'- [{item.context_id}/{item.entry_id}] {item.entity_type}')

var apiInstance = new CatalogApi();
var response = apiInstance.ListCatalogDatasets(
    contextId: "1", entryId: "100",
    query: "transport"
);
Debug.WriteLine("Total results: " + response.Results);
foreach (var item in response.Items)
{
    Debug.WriteLine($"- [{item.ContextId}/{item.EntryId}] {item.EntityType}");
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns a paginated list of all catalogs. Catalogs are curated collections of metadata about datasets and data services. Authentication is optional. Without authentication, only publicly available entries are returned. Authenticated requests may return additional non-public entries. Answered from an asynchronously updated index: an entry created moments ago may be missing here while reading it by id already returns it. The alpha `configured_type` filter narrows existing route membership without changing legacy `entity_type`. Matching and authorization occur before pagination and counts; see the parameter for details.

/catalog

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/catalog?entrystore_host=dev.entryscape.com/store/&limit=56&offset=56&cursor=AoE/EGVudHJ5OjEvMTAw&query=open data&sort=title+asc,modified+desc&context=1&rdf_type=http://www.w3.org/ns/dcat#Dataset&public=true&created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z&modified_after=2024-01-01T00:00:00Z&modified_before=2024-12-31T23:59:59Z&entry_type=Local&graph_type=List&resource_type=Information&configured_type=https://example.org/store/entitytypes/resource/example_geo"

var api = new Entryscape.CatalogApi();
var opts = {
  'entrystoreHost': "dev.entryscape.com/store/"
};
api.listCatalogs(opts, function(error, data) {
  if (!error) {
    console.log('Total results:', data.results);
    data.items.forEach(function(item) {
      console.log('- [' + item.context_id + '/' + item.entry_id + '] ' + item.entity_type);
    });
  }
});

const api = new CatalogApi(config);
const response = await api.listCatalogs({
  entrystoreHost: "dev.entryscape.com/store/",
});
console.log('Total results:', response.results);
for (const item of response.items) {
  console.log(`- [${item.contextId}/${item.entryId}] ${item.entityType}`);
}

api_instance = entryscape_client.CatalogApi()
response = api_instance.list_catalogs(
    entrystore_host="dev.entryscape.com/store/"
)
print(f'Total results: {response.results}')
for item in response.items:
    print(f'- [{item.context_id}/{item.entry_id}] {item.entity_type}')

var apiInstance = new CatalogApi();
var response = apiInstance.ListCatalogs(
    entrystoreHost: "dev.entryscape.com/store/"
);
Debug.WriteLine("Total results: " + response.Results);
foreach (var item in response.Items)
{
    Debug.WriteLine($"- [{item.ContextId}/{item.EntryId}] {item.EntityType}");
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Replaces the DCAT-AP metadata for a specific catalog. The request body is forwarded directly to EntryStore without structural transformation; use the Content-Type header to select the RDF serialization (application/ld+json, text/turtle, application/rdf+xml, application/n-triples, or application/rdf+json). This is a full replacement, not a partial update. Requires authentication with write access to the entry's context.

/catalog/{context_id}/{entry_id}/metadata

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X PUT \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/ld+json,application/json" \
 -H "Content-Type: application/ld+json" \
 "https://api.entryscape.com/catalog/{context_id}/{entry_id}/metadata?entrystore_host=dev.entryscape.com/store/" \
 -d 'Custom MIME type example not yet supported: application/ld+json'

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.CatalogApi();
var metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:Catalog',
  'dct:title': [{ '@value': 'Updated Catalog Title', '@language': 'en' }],
  'dct:description': [{ '@value': 'Updated description', '@language': 'en' }]
};
api.updateCatalogMetadata('1', '100', metadata, function(error, data) {
  if (!error) {
    console.log('Metadata updated successfully');
    console.log('Response:', data);
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new CatalogApi(config);
const metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:Catalog',
  'dct:title': [{ '@value': 'Updated Catalog Title', '@language': 'en' }],
  'dct:description': [{ '@value': 'Updated description', '@language': 'en' }],
};
const response = await api.updateCatalogMetadata({
  contextId: '1',
  entryId: '100',
  body: metadata,
});
console.log('Metadata updated successfully');
console.log('Response:', response);

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.CatalogApi(
    entryscape_client.ApiClient(configuration)
)
metadata = {
    '@context': {'dcat': 'http://www.w3.org/ns/dcat#', 'dct': 'http://purl.org/dc/terms/'},
    '@type': 'dcat:Catalog',
    'dct:title': [{'@value': 'Updated Catalog Title', '@language': 'en'}],
    'dct:description': [{'@value': 'Updated description', '@language': 'en'}],
}
response = api_instance.update_catalog_metadata(
    context_id='1', entry_id='100', body=metadata
)
print('Metadata updated successfully')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new CatalogApi(config);
var metadata = new Dictionary<string, object>
{
    {"@context", new Dictionary<string, string> {{"dcat", "http://www.w3.org/ns/dcat#"}, {"dct", "http://purl.org/dc/terms/"}}},
    {"@type", "dcat:Catalog"},
    {"dct:title", new List<object> {
        new Dictionary<string, string> {{"@value", "Updated Catalog Title"}, {"@language", "en"}}
    }}
};
var response = apiInstance.UpdateCatalogMetadata(
    contextId: "1", entryId: "100", body: metadata
);
Debug.WriteLine("Metadata updated successfully");

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Retrieves the stored metadata for this catalog entry from EntryStore and validates it against the SHACL shapes for the requested profile (a DCAT-AP profile, or the domain's custom shapes with profile=custom). No request body is needed — the endpoint operates on the entry's existing metadata, similar to how the `/metadata` endpoint returns it. Returns a detailed report with any violations, warnings, or informational findings. A 200 response with `conforms: false` is expected when the metadata has issues — it means validation completed successfully. `conforms: true` alone does not mean the metadata was checked. If no shape in the profile targets the entry — usually because its `rdf:type` is missing or wrong — the report conforms with nothing in it. `summary.targetedShapes` counts the shapes that had something to check; `0` means nothing was. Read `outcome` first: `validated` or `invalid` means the metadata was checked, anything else that nothing was. With `profile=custom` shapes follow the entry's configured type (`configuredType`). Authentication is optional. Public entries can be validated without authentication. Authenticated requests may validate additional non-public entries.

/catalog/{context_id}/{entry_id}/validate

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/catalog/{context_id}/{entry_id}/validate?entrystore_host=dev.entryscape.com/store/&profile=dcat-ap-3.0"

var api = new Entryscape.CatalogApi();
api.validateCatalog('1', '100', Entryscape.ValidationProfile['dcat-ap-3.0'], function(error, data) {
  if (!error) {
    console.log('Conforms:', data.conforms);
    console.log('Profile:', data.profile);
    console.log('Violations:', data.summary.violations);
    console.log('Warnings:', data.summary.warnings);
    data.results.forEach(function(r) {
      console.log(r.severity + ': ' + r.message);
    });
  }
});

const api = new CatalogApi(config);
const response = await api.validateCatalog({
  contextId: '1',
  entryId: '100',
  profile: ValidationProfile.DcatAp30,
});
console.log('Conforms:', response.conforms);
console.log('Profile:', response.profile);
console.log('Violations:', response.summary.violations);
console.log('Warnings:', response.summary.warnings);
response.results.forEach((r) => {
  console.log(`${r.severity}: ${r.message}`);
});

api_instance = entryscape_client.CatalogApi()
response = api_instance.validate_catalog(
    context_id='1', entry_id='100',
    profile=ValidationProfile.DCAT_MINUS_AP_MINUS_3_DOT_0
)
print(f'Conforms: {response.conforms}')
print(f'Profile: {response.profile}')
print(f'Violations: {response.summary.violations}')
print(f'Warnings: {response.summary.warnings}')
for r in response.results:
    print(f'{r.severity}: {r.message}')

var apiInstance = new CatalogApi();
var response = apiInstance.ValidateCatalog(
    contextId: "1", entryId: "100",
    profile: ValidationProfile.DcatAp30
);
Debug.WriteLine("Conforms: " + response.Conforms);
Debug.WriteLine("Profile: " + response.Profile);
Debug.WriteLine("Violations: " + response.Summary.Violations);
Debug.WriteLine("Warnings: " + response.Summary.Warnings);
foreach (var r in response.Results)
{
    Debug.WriteLine(r.Severity + ": " + r.Message);
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Creates a new contact in the specified context. The request body must contain valid vCard metadata in JSON-LD format. The `@type` must be `vcard:Kind` — that is the only type this endpoint accepts, and anything else is rejected with `400`. A contact already in the store may carry `vcard:Organization` or `vcard:Individual` instead, and both are read back and matched by a type-filtered search; they just cannot be created here. Requires authentication with write access to the target context.

/contact

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X POST \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/ld+json" \
 "https://api.entryscape.com/contact?entrystore_host=dev.entryscape.com/store/&context=1" \
 -d 'Custom MIME type example not yet supported: application/ld+json'

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.ContactApi();
var metadata = {
  '@context': { vcard: 'http://www.w3.org/2006/vcard/ns#', foaf: 'http://xmlns.com/foaf/0.1/' },
  '@type': 'vcard:Kind',
  'foaf:name': [{ '@value': 'John Doe', '@language': 'en' }],
  'vcard:hasEmail': { '@id': 'mailto:john.doe@example.com' },
  'vcard:hasTelephone': { '@id': 'tel:+123456789' }
};
api.createContact('1', metadata, function(error, data) {
  if (!error) {
    console.log('Created:', data.context_id + '/' + data.entry_id);
    console.log('URI:', data.uri);
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new ContactApi(config);
const metadata = {
  '@context': { vcard: 'http://www.w3.org/2006/vcard/ns#', foaf: 'http://xmlns.com/foaf/0.1/' },
  '@type': 'vcard:Kind',
  'foaf:name': [{ '@value': 'John Doe', '@language': 'en' }],
  'vcard:hasEmail': { '@id': 'mailto:john.doe@example.com' },
  'vcard:hasTelephone': { '@id': 'tel:+123456789' },
};
const response = await api.createContact({
  context: '1',
  body: metadata,
});
console.log(`Created: ${response.contextId}/${response.entryId}`);
console.log('URI:', response.uri);

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.ContactApi(
    entryscape_client.ApiClient(configuration)
)
metadata = {
    '@context': {'vcard': 'http://www.w3.org/2006/vcard/ns#', 'foaf': 'http://xmlns.com/foaf/0.1/'},
    '@type': 'vcard:Kind',
    'foaf:name': [{'@value': 'John Doe', '@language': 'en'}],
    'vcard:hasEmail': {'@id': 'mailto:john.doe@example.com'},
    'vcard:hasTelephone': {'@id': 'tel:+123456789'},
}
response = api_instance.create_contact(context='1', body=metadata)
print(f'Created: {response.context_id}/{response.entry_id}')
print(f'URI: {response.uri}')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new ContactApi(config);
var metadata = new Dictionary<string, object>
{
    {"@context", new Dictionary<string, string> {{"vcard", "http://www.w3.org/2006/vcard/ns#"}, {"foaf", "http://xmlns.com/foaf/0.1/"}}},
    {"@type", "vcard:Kind"},
    {"foaf:name", new List<object> {
        new Dictionary<string, string> {{"@value", "John Doe"}, {"@language", "en"}}
    }},
    {"vcard:hasEmail", new Dictionary<string, string> {{"@id", "mailto:john.doe@example.com"}}}
};
var response = apiInstance.CreateContact(context: "1", body: metadata);
Debug.WriteLine($"Created: {response.ContextId}/{response.EntryId}");
Debug.WriteLine("URI: " + response.Uri);

Scopes

Parameters

Responses

• Schema
• Response Example
• Headers

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Deletes a specific contact and its associated metadata. This operation is irreversible. Requires authentication with write access to the entry's context.

/contact/{context_id}/{entry_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X DELETE \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/contact/{context_id}/{entry_id}?entrystore_host=dev.entryscape.com/store/"

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.ContactApi();
api.deleteContact('1', '100', function(error) {
  if (!error) {
    console.log('Contact deleted successfully');
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new ContactApi(config);
await api.deleteContact({
  contextId: '1',
  entryId: '100',
});
console.log('Contact deleted successfully');

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.ContactApi(
    entryscape_client.ApiClient(configuration)
)
api_instance.delete_contact(context_id='1', entry_id='100')
print('Contact deleted successfully')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new ContactApi(config);
apiInstance.DeleteContact(contextId: "1", entryId: "100");
Debug.WriteLine("Contact deleted successfully");

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns basic reference information for a specific contact. Use the /metadata sub-endpoint to retrieve the full vCard metadata. Authentication is optional. Public entries are accessible without authentication. Authenticated requests may access additional non-public entries.

/contact/{context_id}/{entry_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/contact/{context_id}/{entry_id}?entrystore_host=dev.entryscape.com/store/"

var api = new Entryscape.ContactApi();
api.getContact('1', '100', function(error, data) {
  if (!error) {
    console.log('Context ID:', data.context_id);
    console.log('Entry ID:', data.entry_id);
    console.log('URI:', data.uri);
    console.log('Entity Type:', data.entity_type);
    console.log('Created:', data.created);
  }
});

const api = new ContactApi(config);
const response = await api.getContact({
  contextId: '1',
  entryId: '100',
});
console.log('Context ID:', response.contextId);
console.log('Entry ID:', response.entryId);
console.log('URI:', response.uri);
console.log('Entity Type:', response.entityType);
console.log('Created:', response.created);

api_instance = entryscape_client.ContactApi()
response = api_instance.get_contact(
    context_id='1', entry_id='100'
)
print(f'Context ID: {response.context_id}')
print(f'Entry ID: {response.entry_id}')
print(f'URI: {response.uri}')
print(f'Entity Type: {response.entity_type}')
print(f'Created: {response.created}')

var apiInstance = new ContactApi();
var response = apiInstance.GetContact(
    contextId: "1", entryId: "100"
);
Debug.WriteLine("Context ID: " + response.ContextId);
Debug.WriteLine("Entry ID: " + response.EntryId);
Debug.WriteLine("URI: " + response.Uri);
Debug.WriteLine("Entity Type: " + response.EntityType);
Debug.WriteLine("Created: " + response.Created);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns raw DCAT-AP metadata for a specific contact. The response format can be specified using the `format` query parameter. Authentication is optional. Public entries are accessible without authentication. Authenticated requests may access additional non-public entries.

/contact/{context_id}/{entry_id}/metadata

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/ld+json,application/rdf+json,text/turtle,application/n-triples,application/rdf+xml,application/json" \
 "https://api.entryscape.com/contact/{context_id}/{entry_id}/metadata?entrystore_host=dev.entryscape.com/store/&format=json-ld"

var api = new Entryscape.ContactApi();
api.getContactMetadata('1', '100', function(error, data) {
  if (!error) {
    var entity = data['@graph'] ? data['@graph'][0] : data;
    var titleValue = entity['dcterms:title'] || entity['dct:title'];
    var title = Array.isArray(titleValue)
      ? (titleValue.find(function(v) { return v['@language'] === 'en'; }) || titleValue[0] || {})['@value']
      : (titleValue && typeof titleValue === 'object') ? titleValue['@value'] : titleValue;
    console.log('Title:', title);
    console.log('Full response:', data);
  }
});

const api = new ContactApi(config);
const response = await api.getContactMetadata({
  contextId: '1',
  entryId: '100',
});
const metadata = response as Record<string, unknown>;
const entity = '@graph' in metadata && Array.isArray(metadata['@graph'])
  ? metadata['@graph'][0] as Record<string, unknown>
  : metadata;
const titleValue = entity['dcterms:title'] || entity['dct:title'];
const title = Array.isArray(titleValue)
  ? titleValue.find((v: any) => v['@language'] === 'en')?.['@value'] || titleValue[0]?.['@value']
  : typeof titleValue === 'object' ? (titleValue as any)['@value'] : titleValue;
console.log('Title:', title);
console.log('Full response:', response);

api_instance = entryscape_client.ContactApi()
response = api_instance.get_contact_metadata(
    context_id='1', entry_id='100'
)
metadata = response if isinstance(response, dict) else response.to_dict()
entity = metadata.get('@graph', [{}])[0] if '@graph' in metadata else metadata
title_value = entity.get('dcterms:title') or entity.get('dct:title')
if isinstance(title_value, list):
    title = next((v.get('@value') for v in title_value if v.get('@language') == 'en'),
                 title_value[0].get('@value') if title_value else None)
elif isinstance(title_value, dict):
    title = title_value.get('@value')
else:
    title = title_value
print(f'Title: {title}')

var apiInstance = new ContactApi();
var response = apiInstance.GetContactMetadata(
    contextId: "1", entryId: "100"
);
var metadata = response as Dictionary<string, object>;
if (metadata != null && metadata.ContainsKey("@graph"))
{
    var graph = metadata["@graph"] as List<object>;
    var entity = graph?[0] as Dictionary<string, object>;
    object titleValue;
    entity?.TryGetValue("dcterms:title", out titleValue);
    Debug.WriteLine("Title: " + titleValue);
}
Debug.WriteLine(response);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns a paginated list of all contacts. Contacts provide contact information for resources (vCard). Authentication is optional. Without authentication, only publicly available entries are returned. Authenticated requests may return additional non-public entries. Answered from an asynchronously updated index: an entry created moments ago may be missing here while reading it by id already returns it. The alpha `configured_type` filter narrows existing route membership without changing legacy `entity_type`. Matching and authorization occur before pagination and counts; see the parameter for details.

/contact

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/contact?entrystore_host=dev.entryscape.com/store/&limit=56&offset=56&cursor=AoE/EGVudHJ5OjEvMTAw&query=open data&sort=title+asc,modified+desc&context=1&rdf_type=http://www.w3.org/ns/dcat#Dataset&public=true&created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z&modified_after=2024-01-01T00:00:00Z&modified_before=2024-12-31T23:59:59Z&entry_type=Local&graph_type=List&resource_type=Information&configured_type=https://example.org/store/entitytypes/resource/example_geo"

var api = new Entryscape.ContactApi();
var opts = {
  'entrystoreHost': "dev.entryscape.com/store/"
};
api.listContacts(opts, function(error, data) {
  if (!error) {
    console.log('Total results:', data.results);
    data.items.forEach(function(item) {
      console.log('- [' + item.context_id + '/' + item.entry_id + '] ' + item.entity_type);
    });
  }
});

const api = new ContactApi(config);
const response = await api.listContacts({
  entrystoreHost: "dev.entryscape.com/store/",
});
console.log('Total results:', response.results);
for (const item of response.items) {
  console.log(`- [${item.contextId}/${item.entryId}] ${item.entityType}`);
}

api_instance = entryscape_client.ContactApi()
response = api_instance.list_contacts(
    entrystore_host="dev.entryscape.com/store/"
)
print(f'Total results: {response.results}')
for item in response.items:
    print(f'- [{item.context_id}/{item.entry_id}] {item.entity_type}')

var apiInstance = new ContactApi();
var response = apiInstance.ListContacts(
    entrystoreHost: "dev.entryscape.com/store/"
);
Debug.WriteLine("Total results: " + response.Results);
foreach (var item in response.Items)
{
    Debug.WriteLine($"- [{item.ContextId}/{item.EntryId}] {item.EntityType}");
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Replaces the vCard metadata for a specific contact. The request body is forwarded directly to EntryStore without structural transformation; use the Content-Type header to select the RDF serialization (application/ld+json, text/turtle, application/rdf+xml, application/n-triples, or application/rdf+json). This is a full replacement, not a partial update. Requires authentication with write access to the entry's context.

/contact/{context_id}/{entry_id}/metadata

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X PUT \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/ld+json,application/json" \
 -H "Content-Type: application/ld+json" \
 "https://api.entryscape.com/contact/{context_id}/{entry_id}/metadata?entrystore_host=dev.entryscape.com/store/" \
 -d 'Custom MIME type example not yet supported: application/ld+json'

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.ContactApi();
var metadata = {
  '@context': { vcard: 'http://www.w3.org/2006/vcard/ns#', foaf: 'http://xmlns.com/foaf/0.1/' },
  '@type': 'vcard:Individual',
  'foaf:name': [{ '@value': 'Updated Contact Name', '@language': 'en' }],
  'vcard:hasEmail': { '@id': 'mailto:updated@example.com' },
  'vcard:hasTelephone': { '@id': 'tel:+123456789' }
};
api.updateContactMetadata('1', '100', metadata, function(error, data) {
  if (!error) {
    console.log('Metadata updated successfully');
    console.log('Response:', data);
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new ContactApi(config);
const metadata = {
  '@context': { vcard: 'http://www.w3.org/2006/vcard/ns#', foaf: 'http://xmlns.com/foaf/0.1/' },
  '@type': 'vcard:Individual',
  'foaf:name': [{ '@value': 'Updated Contact Name', '@language': 'en' }],
  'vcard:hasEmail': { '@id': 'mailto:updated@example.com' },
  'vcard:hasTelephone': { '@id': 'tel:+123456789' },
};
const response = await api.updateContactMetadata({
  contextId: '1',
  entryId: '100',
  body: metadata,
});
console.log('Metadata updated successfully');
console.log('Response:', response);

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.ContactApi(
    entryscape_client.ApiClient(configuration)
)
metadata = {
    '@context': {'vcard': 'http://www.w3.org/2006/vcard/ns#', 'foaf': 'http://xmlns.com/foaf/0.1/'},
    '@type': 'vcard:Individual',
    'foaf:name': [{'@value': 'Updated Contact Name', '@language': 'en'}],
    'vcard:hasEmail': {'@id': 'mailto:updated@example.com'},
    'vcard:hasTelephone': {'@id': 'tel:+123456789'},
}
response = api_instance.update_contact_metadata(
    context_id='1', entry_id='100', body=metadata
)
print('Metadata updated successfully')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new ContactApi(config);
var metadata = new Dictionary<string, object>
{
    {"@context", new Dictionary<string, string> {{"vcard", "http://www.w3.org/2006/vcard/ns#"}, {"foaf", "http://xmlns.com/foaf/0.1/"}}},
    {"@type", "vcard:Individual"},
    {"foaf:name", new List<object> {
        new Dictionary<string, string> {{"@value", "Updated Contact Name"}, {"@language", "en"}}
    }},
    {"vcard:hasEmail", new Dictionary<string, string> {{"@id", "mailto:updated@example.com"}}}
};
var response = apiInstance.UpdateContactMetadata(
    contextId: "1", entryId: "100", body: metadata
);
Debug.WriteLine("Metadata updated successfully");

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Retrieves the stored metadata for this contact point entry from EntryStore and validates it against the SHACL shapes for the requested profile (a DCAT-AP profile, or the domain's custom shapes with profile=custom). No request body is needed — the endpoint operates on the entry's existing metadata, similar to how the `/metadata` endpoint returns it. Returns a detailed report with any violations, warnings, or informational findings. A 200 response with `conforms: false` is expected when the metadata has issues — it means validation completed successfully. `conforms: true` alone does not mean the metadata was checked. If no shape in the profile targets the entry — usually because its `rdf:type` is missing or wrong — the report conforms with nothing in it. `summary.targetedShapes` counts the shapes that had something to check; `0` means nothing was. Read `outcome` first: `validated` or `invalid` means the metadata was checked, anything else that nothing was. With `profile=custom` shapes follow the entry's configured type (`configuredType`). Authentication is optional. Public entries can be validated without authentication. Authenticated requests may validate additional non-public entries.

/contact/{context_id}/{entry_id}/validate

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/contact/{context_id}/{entry_id}/validate?entrystore_host=dev.entryscape.com/store/&profile=dcat-ap-3.0"

var api = new Entryscape.ContactApi();
api.validateContact('1', '100', Entryscape.ValidationProfile['dcat-ap-3.0'], function(error, data) {
  if (!error) {
    console.log('Conforms:', data.conforms);
    console.log('Profile:', data.profile);
    console.log('Violations:', data.summary.violations);
    console.log('Warnings:', data.summary.warnings);
    data.results.forEach(function(r) {
      console.log(r.severity + ': ' + r.message);
    });
  }
});

const api = new ContactApi(config);
const response = await api.validateContact({
  contextId: '1',
  entryId: '100',
  profile: ValidationProfile.DcatAp30,
});
console.log('Conforms:', response.conforms);
console.log('Profile:', response.profile);
console.log('Violations:', response.summary.violations);
console.log('Warnings:', response.summary.warnings);
response.results.forEach((r) => {
  console.log(`${r.severity}: ${r.message}`);
});

api_instance = entryscape_client.ContactApi()
response = api_instance.validate_contact(
    context_id='1', entry_id='100',
    profile=ValidationProfile.DCAT_MINUS_AP_MINUS_3_DOT_0
)
print(f'Conforms: {response.conforms}')
print(f'Profile: {response.profile}')
print(f'Violations: {response.summary.violations}')
print(f'Warnings: {response.summary.warnings}')
for r in response.results:
    print(f'{r.severity}: {r.message}')

var apiInstance = new ContactApi();
var response = apiInstance.ValidateContact(
    contextId: "1", entryId: "100",
    profile: ValidationProfile.DcatAp30
);
Debug.WriteLine("Conforms: " + response.Conforms);
Debug.WriteLine("Profile: " + response.Profile);
Debug.WriteLine("Violations: " + response.Summary.Violations);
Debug.WriteLine("Warnings: " + response.Summary.Warnings);
foreach (var r in response.Results)
{
    Debug.WriteLine(r.Severity + ": " + r.Message);
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Creates a new data service in the specified context. The request body must contain valid DCAT-AP metadata in JSON-LD format. Requires authentication with write access to the target context.

/dataservice

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X POST \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/ld+json" \
 "https://api.entryscape.com/dataservice?entrystore_host=dev.entryscape.com/store/&context=1" \
 -d 'Custom MIME type example not yet supported: application/ld+json'

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.DataserviceApi();
var metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:DataService',
  'dct:title': [{ '@value': 'My Data Service', '@language': 'en' }],
  'dcat:endpointURL': { '@id': 'http://example.org/api/v1' }
};
api.createDataService('1', metadata, function(error, data) {
  if (!error) {
    console.log('Created:', data.context_id + '/' + data.entry_id);
    console.log('URI:', data.uri);
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new DataserviceApi(config);
const metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:DataService',
  'dct:title': [{ '@value': 'My Data Service', '@language': 'en' }],
  'dcat:endpointURL': { '@id': 'http://example.org/api/v1' },
};
const response = await api.createDataService({
  context: '1',
  body: metadata,
});
console.log(`Created: ${response.contextId}/${response.entryId}`);
console.log('URI:', response.uri);

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.DataserviceApi(
    entryscape_client.ApiClient(configuration)
)
metadata = {
    '@context': {'dcat': 'http://www.w3.org/ns/dcat#', 'dct': 'http://purl.org/dc/terms/'},
    '@type': 'dcat:DataService',
    'dct:title': [{'@value': 'My Data Service', '@language': 'en'}],
    'dcat:endpointURL': {'@id': 'http://example.org/api/v1'},
}
response = api_instance.create_data_service(context='1', body=metadata)
print(f'Created: {response.context_id}/{response.entry_id}')
print(f'URI: {response.uri}')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new DataserviceApi(config);
var metadata = new Dictionary<string, object>
{
    {"@context", new Dictionary<string, string> {{"dcat", "http://www.w3.org/ns/dcat#"}, {"dct", "http://purl.org/dc/terms/"}}},
    {"@type", "dcat:DataService"},
    {"dct:title", new List<object> {
        new Dictionary<string, string> {{"@value", "My Data Service"}, {"@language", "en"}}
    }},
    {"dcat:endpointURL", new Dictionary<string, string> {{"@id", "http://example.org/api/v1"}}}
};
var response = apiInstance.CreateDataService(context: "1", body: metadata);
Debug.WriteLine($"Created: {response.ContextId}/{response.EntryId}");
Debug.WriteLine("URI: " + response.Uri);

Scopes

Parameters

Responses

• Schema
• Response Example
• Headers

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Deletes a specific data service and its associated metadata. This operation is irreversible. Requires authentication with write access to the entry's context.

/dataservice/{context_id}/{entry_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X DELETE \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/dataservice/{context_id}/{entry_id}?entrystore_host=dev.entryscape.com/store/"

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.DataserviceApi();
api.deleteDataService('1', '100', function(error) {
  if (!error) {
    console.log('Data service deleted successfully');
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new DataserviceApi(config);
await api.deleteDataService({
  contextId: '1',
  entryId: '100',
});
console.log('Data service deleted successfully');

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.DataserviceApi(
    entryscape_client.ApiClient(configuration)
)
api_instance.delete_data_service(context_id='1', entry_id='100')
print('Data service deleted successfully')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new DataserviceApi(config);
apiInstance.DeleteDataService(contextId: "1", entryId: "100");
Debug.WriteLine("Data service deleted successfully");

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns basic reference information for a specific data service. Use the /metadata sub-endpoint to retrieve the full DCAT-AP metadata. Authentication is optional. Public entries are accessible without authentication. Authenticated requests may access additional non-public entries.

/dataservice/{context_id}/{entry_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/dataservice/{context_id}/{entry_id}?entrystore_host=dev.entryscape.com/store/"

var api = new Entryscape.DataserviceApi();
api.getDataService('1', '100', function(error, data) {
  if (!error) {
    console.log('Context ID:', data.context_id);
    console.log('Entry ID:', data.entry_id);
    console.log('URI:', data.uri);
    console.log('Entity Type:', data.entity_type);
    console.log('Created:', data.created);
  }
});

const api = new DataserviceApi(config);
const response = await api.getDataService({
  contextId: '1',
  entryId: '100',
});
console.log('Context ID:', response.contextId);
console.log('Entry ID:', response.entryId);
console.log('URI:', response.uri);
console.log('Entity Type:', response.entityType);
console.log('Created:', response.created);

api_instance = entryscape_client.DataserviceApi()
response = api_instance.get_data_service(
    context_id='1', entry_id='100'
)
print(f'Context ID: {response.context_id}')
print(f'Entry ID: {response.entry_id}')
print(f'URI: {response.uri}')
print(f'Entity Type: {response.entity_type}')
print(f'Created: {response.created}')

var apiInstance = new DataserviceApi();
var response = apiInstance.GetDataService(
    contextId: "1", entryId: "100"
);
Debug.WriteLine("Context ID: " + response.ContextId);
Debug.WriteLine("Entry ID: " + response.EntryId);
Debug.WriteLine("URI: " + response.Uri);
Debug.WriteLine("Entity Type: " + response.EntityType);
Debug.WriteLine("Created: " + response.Created);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns raw DCAT-AP metadata for a specific data service. The response format can be specified using the `format` query parameter. Authentication is optional. Public entries are accessible without authentication. Authenticated requests may access additional non-public entries.

/dataservice/{context_id}/{entry_id}/metadata

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/ld+json,application/rdf+json,text/turtle,application/n-triples,application/rdf+xml,application/json" \
 "https://api.entryscape.com/dataservice/{context_id}/{entry_id}/metadata?entrystore_host=dev.entryscape.com/store/&format=json-ld"

var api = new Entryscape.DataserviceApi();
api.getDataServiceMetadata('1', '100', function(error, data) {
  if (!error) {
    var entity = data['@graph'] ? data['@graph'][0] : data;
    var titleValue = entity['dcterms:title'] || entity['dct:title'];
    var title = Array.isArray(titleValue)
      ? (titleValue.find(function(v) { return v['@language'] === 'en'; }) || titleValue[0] || {})['@value']
      : (titleValue && typeof titleValue === 'object') ? titleValue['@value'] : titleValue;
    console.log('Title:', title);
    console.log('Full response:', data);
  }
});

const api = new DataserviceApi(config);
const response = await api.getDataServiceMetadata({
  contextId: '1',
  entryId: '100',
});
const metadata = response as Record<string, unknown>;
const entity = '@graph' in metadata && Array.isArray(metadata['@graph'])
  ? metadata['@graph'][0] as Record<string, unknown>
  : metadata;
const titleValue = entity['dcterms:title'] || entity['dct:title'];
const title = Array.isArray(titleValue)
  ? titleValue.find((v: any) => v['@language'] === 'en')?.['@value'] || titleValue[0]?.['@value']
  : typeof titleValue === 'object' ? (titleValue as any)['@value'] : titleValue;
console.log('Title:', title);
console.log('Full response:', response);

api_instance = entryscape_client.DataserviceApi()
response = api_instance.get_data_service_metadata(
    context_id='1', entry_id='100'
)
metadata = response if isinstance(response, dict) else response.to_dict()
entity = metadata.get('@graph', [{}])[0] if '@graph' in metadata else metadata
title_value = entity.get('dcterms:title') or entity.get('dct:title')
if isinstance(title_value, list):
    title = next((v.get('@value') for v in title_value if v.get('@language') == 'en'),
                 title_value[0].get('@value') if title_value else None)
elif isinstance(title_value, dict):
    title = title_value.get('@value')
else:
    title = title_value
print(f'Title: {title}')

var apiInstance = new DataserviceApi();
var response = apiInstance.GetDataServiceMetadata(
    contextId: "1", entryId: "100"
);
var metadata = response as Dictionary<string, object>;
if (metadata != null && metadata.ContainsKey("@graph"))
{
    var graph = metadata["@graph"] as List<object>;
    var entity = graph?[0] as Dictionary<string, object>;
    object titleValue;
    entity?.TryGetValue("dcterms:title", out titleValue);
    Debug.WriteLine("Title: " + titleValue);
}
Debug.WriteLine(response);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns a paginated list of all data services. Data services are APIs that provide access to one or more datasets. Authentication is optional. Without authentication, only publicly available entries are returned. Authenticated requests may return additional non-public entries. Answered from an asynchronously updated index: an entry created moments ago may be missing here while reading it by id already returns it. The alpha `configured_type` filter narrows existing route membership without changing legacy `entity_type`. Matching and authorization occur before pagination and counts; see the parameter for details.

/dataservice

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/dataservice?entrystore_host=dev.entryscape.com/store/&limit=56&offset=56&cursor=AoE/EGVudHJ5OjEvMTAw&query=open data&sort=title+asc,modified+desc&context=1&rdf_type=http://www.w3.org/ns/dcat#Dataset&public=true&created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z&modified_after=2024-01-01T00:00:00Z&modified_before=2024-12-31T23:59:59Z&entry_type=Local&graph_type=List&resource_type=Information&configured_type=https://example.org/store/entitytypes/resource/example_geo"

var api = new Entryscape.DataserviceApi();
var opts = {
  'entrystoreHost': "dev.entryscape.com/store/"
};
api.listDataServices(opts, function(error, data) {
  if (!error) {
    console.log('Total results:', data.results);
    data.items.forEach(function(item) {
      console.log('- [' + item.context_id + '/' + item.entry_id + '] ' + item.entity_type);
    });
  }
});

const api = new DataserviceApi(config);
const response = await api.listDataServices({
  entrystoreHost: "dev.entryscape.com/store/",
});
console.log('Total results:', response.results);
for (const item of response.items) {
  console.log(`- [${item.contextId}/${item.entryId}] ${item.entityType}`);
}

api_instance = entryscape_client.DataserviceApi()
response = api_instance.list_data_services(
    entrystore_host="dev.entryscape.com/store/"
)
print(f'Total results: {response.results}')
for item in response.items:
    print(f'- [{item.context_id}/{item.entry_id}] {item.entity_type}')

var apiInstance = new DataserviceApi();
var response = apiInstance.ListDataServices(
    entrystoreHost: "dev.entryscape.com/store/"
);
Debug.WriteLine("Total results: " + response.Results);
foreach (var item in response.Items)
{
    Debug.WriteLine($"- [{item.ContextId}/{item.EntryId}] {item.EntityType}");
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Replaces the DCAT-AP metadata for a specific data service. The request body is forwarded directly to EntryStore without structural transformation; use the Content-Type header to select the RDF serialization (application/ld+json, text/turtle, application/rdf+xml, application/n-triples, or application/rdf+json). This is a full replacement, not a partial update. Requires authentication with write access to the entry's context.

/dataservice/{context_id}/{entry_id}/metadata

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X PUT \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/ld+json,application/json" \
 -H "Content-Type: application/ld+json" \
 "https://api.entryscape.com/dataservice/{context_id}/{entry_id}/metadata?entrystore_host=dev.entryscape.com/store/" \
 -d 'Custom MIME type example not yet supported: application/ld+json'

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.DataserviceApi();
var metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:DataService',
  'dct:title': [{ '@value': 'Updated Data Service Title', '@language': 'en' }],
  'dcat:endpointURL': { '@id': 'http://example.org/api/v2' }
};
api.updateDataServiceMetadata('1', '100', metadata, function(error, data) {
  if (!error) {
    console.log('Metadata updated successfully');
    console.log('Response:', data);
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new DataserviceApi(config);
const metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:DataService',
  'dct:title': [{ '@value': 'Updated Data Service Title', '@language': 'en' }],
  'dcat:endpointURL': { '@id': 'http://example.org/api/v2' },
};
const response = await api.updateDataServiceMetadata({
  contextId: '1',
  entryId: '100',
  body: metadata,
});
console.log('Metadata updated successfully');
console.log('Response:', response);

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.DataserviceApi(
    entryscape_client.ApiClient(configuration)
)
metadata = {
    '@context': {'dcat': 'http://www.w3.org/ns/dcat#', 'dct': 'http://purl.org/dc/terms/'},
    '@type': 'dcat:DataService',
    'dct:title': [{'@value': 'Updated Data Service Title', '@language': 'en'}],
    'dcat:endpointURL': {'@id': 'http://example.org/api/v2'},
}
response = api_instance.update_data_service_metadata(
    context_id='1', entry_id='100', body=metadata
)
print('Metadata updated successfully')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new DataserviceApi(config);
var metadata = new Dictionary<string, object>
{
    {"@context", new Dictionary<string, string> {{"dcat", "http://www.w3.org/ns/dcat#"}, {"dct", "http://purl.org/dc/terms/"}}},
    {"@type", "dcat:DataService"},
    {"dct:title", new List<object> {
        new Dictionary<string, string> {{"@value", "Updated Data Service Title"}, {"@language", "en"}}
    }},
    {"dcat:endpointURL", new Dictionary<string, string> {{"@id", "http://example.org/api/v2"}}}
};
var response = apiInstance.UpdateDataServiceMetadata(
    contextId: "1", entryId: "100", body: metadata
);
Debug.WriteLine("Metadata updated successfully");

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Retrieves the stored metadata for this data service entry from EntryStore and validates it against the SHACL shapes for the requested profile (a DCAT-AP profile, or the domain's custom shapes with profile=custom). No request body is needed — the endpoint operates on the entry's existing metadata, similar to how the `/metadata` endpoint returns it. Returns a detailed report with any violations, warnings, or informational findings. A 200 response with `conforms: false` is expected when the metadata has issues — it means validation completed successfully. `conforms: true` alone does not mean the metadata was checked. If no shape in the profile targets the entry — usually because its `rdf:type` is missing or wrong — the report conforms with nothing in it. `summary.targetedShapes` counts the shapes that had something to check; `0` means nothing was. Read `outcome` first: `validated` or `invalid` means the metadata was checked, anything else that nothing was. With `profile=custom` shapes follow the entry's configured type (`configuredType`). Authentication is optional. Public entries can be validated without authentication. Authenticated requests may validate additional non-public entries.

/dataservice/{context_id}/{entry_id}/validate

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/dataservice/{context_id}/{entry_id}/validate?entrystore_host=dev.entryscape.com/store/&profile=dcat-ap-3.0"

var api = new Entryscape.DataserviceApi();
api.validateDataService('1', '100', Entryscape.ValidationProfile['dcat-ap-3.0'], function(error, data) {
  if (!error) {
    console.log('Conforms:', data.conforms);
    console.log('Profile:', data.profile);
    console.log('Violations:', data.summary.violations);
    console.log('Warnings:', data.summary.warnings);
    data.results.forEach(function(r) {
      console.log(r.severity + ': ' + r.message);
    });
  }
});

const api = new DataserviceApi(config);
const response = await api.validateDataService({
  contextId: '1',
  entryId: '100',
  profile: ValidationProfile.DcatAp30,
});
console.log('Conforms:', response.conforms);
console.log('Profile:', response.profile);
console.log('Violations:', response.summary.violations);
console.log('Warnings:', response.summary.warnings);
response.results.forEach((r) => {
  console.log(`${r.severity}: ${r.message}`);
});

api_instance = entryscape_client.DataserviceApi()
response = api_instance.validate_data_service(
    context_id='1', entry_id='100',
    profile=ValidationProfile.DCAT_MINUS_AP_MINUS_3_DOT_0
)
print(f'Conforms: {response.conforms}')
print(f'Profile: {response.profile}')
print(f'Violations: {response.summary.violations}')
print(f'Warnings: {response.summary.warnings}')
for r in response.results:
    print(f'{r.severity}: {r.message}')

var apiInstance = new DataserviceApi();
var response = apiInstance.ValidateDataService(
    contextId: "1", entryId: "100",
    profile: ValidationProfile.DcatAp30
);
Debug.WriteLine("Conforms: " + response.Conforms);
Debug.WriteLine("Profile: " + response.Profile);
Debug.WriteLine("Violations: " + response.Summary.Violations);
Debug.WriteLine("Warnings: " + response.Summary.Warnings);
foreach (var r in response.Results)
{
    Debug.WriteLine(r.Severity + ": " + r.Message);
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Creates a new dataset in the specified context. The request body must contain valid DCAT-AP metadata in JSON-LD format. Requires authentication with write access to the target context.

/dataset

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X POST \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/ld+json" \
 "https://api.entryscape.com/dataset?entrystore_host=dev.entryscape.com/store/&context=1" \
 -d 'Custom MIME type example not yet supported: application/ld+json'

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.DatasetApi();
var metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:Dataset',
  'dct:title': [{ '@value': 'My Dataset', '@language': 'en' }],
  'dct:description': [{ '@value': 'A new dataset', '@language': 'en' }]
};
api.createDataset('1', metadata, function(error, data) {
  if (!error) {
    console.log('Created:', data.context_id + '/' + data.entry_id);
    console.log('URI:', data.uri);
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new DatasetApi(config);
const metadata = {
  '@context': { dcat: 'http://www.w3.org/ns/dcat#', dct: 'http://purl.org/dc/terms/' },
  '@type': 'dcat:Dataset',
  'dct:title': [{ '@value': 'My Dataset', '@language': 'en' }],
  'dct:description': [{ '@value': 'A new dataset', '@language': 'en' }],
};
const response = await api.createDataset({
  context: '1',
  body: metadata,
});
console.log(`Created: ${response.contextId}/${response.entryId}`);
console.log('URI:', response.uri);

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.DatasetApi(
    entryscape_client.ApiClient(configuration)
)
metadata = {
    '@context': {'dcat': 'http://www.w3.org/ns/dcat#', 'dct': 'http://purl.org/dc/terms/'},
    '@type': 'dcat:Dataset',
    'dct:title': [{'@value': 'My Dataset', '@language': 'en'}],
    'dct:description': [{'@value': 'A new dataset', '@language': 'en'}],
}
response = api_instance.create_dataset(context='1', body=metadata)
print(f'Created: {response.context_id}/{response.entry_id}')
print(f'URI: {response.uri}')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new DatasetApi(config);
var metadata = new Dictionary<string, object>
{
    {"@context", new Dictionary<string, string> {{"dcat", "http://www.w3.org/ns/dcat#"}, {"dct", "http://purl.org/dc/terms/"}}},
    {"@type", "dcat:Dataset"},
    {"dct:title", new List<object> {
        new Dictionary<string, string> {{"@value", "My Dataset"}, {"@language", "en"}}
    }}
};
var response = apiInstance.CreateDataset(context: "1", body: metadata);
Debug.WriteLine($"Created: {response.ContextId}/{response.EntryId}");
Debug.WriteLine("URI: " + response.Uri);

Scopes

Parameters

Responses

• Schema
• Response Example
• Headers

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Deletes a specific dataset and its associated metadata. This operation is irreversible. Requires authentication with write access to the entry's context.

/dataset/{context_id}/{entry_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X DELETE \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/dataset/{context_id}/{entry_id}?entrystore_host=dev.entryscape.com/store/"

var client = Entryscape.ApiClient.instance;
client.authentications['auth_header'].apiKey = 'YOUR_TOKEN';
var api = new Entryscape.DatasetApi();
api.deleteDataset('1', '100', function(error) {
  if (!error) {
    console.log('Dataset deleted successfully');
  }
});

const config = new Configuration({
  apiKey: { 'X-Auth-Token': 'YOUR_TOKEN' },
});
const api = new DatasetApi(config);
await api.deleteDataset({
  contextId: '1',
  entryId: '100',
});
console.log('Dataset deleted successfully');

configuration = entryscape_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_TOKEN'
api_instance = entryscape_client.DatasetApi(
    entryscape_client.ApiClient(configuration)
)
api_instance.delete_dataset(context_id='1', entry_id='100')
print('Dataset deleted successfully')

var config = new Configuration();
config.ApiKey.Add("X-Auth-Token", "YOUR_TOKEN");
var apiInstance = new DatasetApi(config);
apiInstance.DeleteDataset(contextId: "1", entryId: "100");
Debug.WriteLine("Dataset deleted successfully");

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns basic reference information for a specific dataset. Use the /metadata sub-endpoint to retrieve the full DCAT-AP metadata. Authentication is optional. Public entries are accessible without authentication. Authenticated requests may access additional non-public entries.

/dataset/{context_id}/{entry_id}

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/dataset/{context_id}/{entry_id}?entrystore_host=dev.entryscape.com/store/"

var api = new Entryscape.DatasetApi();
api.getDataset('1', '100', function(error, data) {
  if (!error) {
    console.log('Context ID:', data.context_id);
    console.log('Entry ID:', data.entry_id);
    console.log('URI:', data.uri);
    console.log('Entity Type:', data.entity_type);
    console.log('Created:', data.created);
  }
});

const api = new DatasetApi(config);
const response = await api.getDataset({
  contextId: '1',
  entryId: '100',
});
console.log('Context ID:', response.contextId);
console.log('Entry ID:', response.entryId);
console.log('URI:', response.uri);
console.log('Entity Type:', response.entityType);
console.log('Created:', response.created);

api_instance = entryscape_client.DatasetApi()
response = api_instance.get_dataset(
    context_id='1', entry_id='100'
)
print(f'Context ID: {response.context_id}')
print(f'Entry ID: {response.entry_id}')
print(f'URI: {response.uri}')
print(f'Entity Type: {response.entity_type}')
print(f'Created: {response.created}')

var apiInstance = new DatasetApi();
var response = apiInstance.GetDataset(
    contextId: "1", entryId: "100"
);
Debug.WriteLine("Context ID: " + response.ContextId);
Debug.WriteLine("Entry ID: " + response.EntryId);
Debug.WriteLine("URI: " + response.Uri);
Debug.WriteLine("Entity Type: " + response.EntityType);
Debug.WriteLine("Created: " + response.Created);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns the raw DCAT-AP metadata for a specific dataset. The response format can be specified using the `format` query parameter. Authentication is optional. Public entries are accessible without authentication. Authenticated requests may access additional non-public entries.

/dataset/{context_id}/{entry_id}/metadata

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/ld+json,application/rdf+json,text/turtle,application/n-triples,application/rdf+xml,application/json" \
 "https://api.entryscape.com/dataset/{context_id}/{entry_id}/metadata?entrystore_host=dev.entryscape.com/store/&format=json-ld"

var api = new Entryscape.DatasetApi();
api.getDatasetMetadata('1', '100', function(error, data) {
  if (!error) {
    var entity = data['@graph'] ? data['@graph'][0] : data;
    var titleValue = entity['dcterms:title'] || entity['dct:title'];
    var title = Array.isArray(titleValue)
      ? (titleValue.find(function(v) { return v['@language'] === 'en'; }) || titleValue[0] || {})['@value']
      : (titleValue && typeof titleValue === 'object') ? titleValue['@value'] : titleValue;
    console.log('Title:', title);
    console.log('Full response:', data);
  }
});

const api = new DatasetApi(config);
const response = await api.getDatasetMetadata({
  contextId: '1',
  entryId: '100',
});
const metadata = response as Record<string, unknown>;
const entity = '@graph' in metadata && Array.isArray(metadata['@graph'])
  ? metadata['@graph'][0] as Record<string, unknown>
  : metadata;
const titleValue = entity['dcterms:title'] || entity['dct:title'];
const title = Array.isArray(titleValue)
  ? titleValue.find((v: any) => v['@language'] === 'en')?.['@value'] || titleValue[0]?.['@value']
  : typeof titleValue === 'object' ? (titleValue as any)['@value'] : titleValue;
console.log('Title:', title);
console.log('Full response:', response);

api_instance = entryscape_client.DatasetApi()
response = api_instance.get_dataset_metadata(
    context_id='1', entry_id='100'
)
metadata = response if isinstance(response, dict) else response.to_dict()
entity = metadata.get('@graph', [{}])[0] if '@graph' in metadata else metadata
title_value = entity.get('dcterms:title') or entity.get('dct:title')
if isinstance(title_value, list):
    title = next((v.get('@value') for v in title_value if v.get('@language') == 'en'),
                 title_value[0].get('@value') if title_value else None)
elif isinstance(title_value, dict):
    title = title_value.get('@value')
else:
    title = title_value
print(f'Title: {title}')

var apiInstance = new DatasetApi();
var response = apiInstance.GetDatasetMetadata(
    contextId: "1", entryId: "100"
);
var metadata = response as Dictionary<string, object>;
if (metadata != null && metadata.ContainsKey("@graph"))
{
    var graph = metadata["@graph"] as List<object>;
    var entity = graph?[0] as Dictionary<string, object>;
    object titleValue;
    entity?.TryGetValue("dcterms:title", out titleValue);
    Debug.WriteLine("Title: " + titleValue);
}
Debug.WriteLine(response);

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns a paginated list of the distributions this dataset links with `dcat:distribution`. Membership is the link, not the context: a distribution the dataset does not link is not listed here, and a dataset that links none answers with zero results. Authentication is optional. Without authentication, only publicly available entries are returned. Authenticated requests may return additional non-public entries. Answered from an asynchronously updated index: an entry created moments ago may be missing here while reading it by id already returns it. The alpha `configured_type` filter narrows existing route membership without changing legacy `entity_type`. Matching and authorization occur before pagination and counts; see the parameter for details.

/dataset/{context_id}/{entry_id}/distributions

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/dataset/{context_id}/{entry_id}/distributions?entrystore_host=dev.entryscape.com/store/&limit=56&offset=56&cursor=AoE/EGVudHJ5OjEvMTAw&query=open data&sort=title+asc,modified+desc&public=true&created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z&modified_after=2024-01-01T00:00:00Z&modified_before=2024-12-31T23:59:59Z&configured_type=https://example.org/store/entitytypes/resource/example_geo"

var api = new Entryscape.DatasetApi();
var opts = {
  'query': 'csv'
};
api.listDatasetDistributions('1', '100', opts, function(error, data) {
  if (!error) {
    console.log('Total results:', data.results);
    data.items.forEach(function(item) {
      console.log('- [' + item.context_id + '/' + item.entry_id + '] ' + item.entity_type);
    });
  }
});

const api = new DatasetApi(config);
const response = await api.listDatasetDistributions({
  contextId: '1',
  entryId: '100',
  query: 'csv',
});
console.log('Total results:', response.results);
for (const item of response.items) {
  console.log(`- [${item.contextId}/${item.entryId}] ${item.entityType}`);
}

api_instance = entryscape_client.DatasetApi()
response = api_instance.list_dataset_distributions(
    context_id='1', entry_id='100',
    query='csv'
)
print(f'Total results: {response.results}')
for item in response.items:
    print(f'- [{item.context_id}/{item.entry_id}] {item.entity_type}')

var apiInstance = new DatasetApi();
var response = apiInstance.ListDatasetDistributions(
    contextId: "1", entryId: "100",
    query: "csv"
);
Debug.WriteLine("Total results: " + response.Results);
foreach (var item in response.Items)
{
    Debug.WriteLine($"- [{item.ContextId}/{item.EntryId}] {item.EntityType}");
}

Scopes

Parameters

Responses

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

• Schema
• Response Example

Returns a paginated list of all datasets. Datasets are collections of data published or curated by a single agent. Authentication is optional. Without authentication, only publicly available entries are returned. Authenticated requests may return additional non-public entries. Answered from an asynchronously updated index: an entry created moments ago may be missing here while reading it by id already returns it. The alpha `configured_type` filter narrows existing route membership without changing legacy `entity_type`. Matching and authorization occur before pagination and counts; see the parameter for details.

/dataset

Usage and SDK Samples

• Curl
• JavaScript
• TypeScript
• Python
• C#

curl -X GET \
 \
-H "X-Auth-Token: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.entryscape.com/dataset?entrystore_host=dev.entryscape.com/store/&limit=56&offset=56&cursor=AoE/EGVudHJ5OjEvMTAw&query=open data&sort=title+asc,modified+desc&context=1&rdf_type=http://www.w3.org/ns/dcat#Dataset&public=true&created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z&modified_after=2024-01-01T00:00:00Z&modified_before=2024-12-31T23:59:59Z&entry_type=Local&graph_type=List&resource_type=Information&configured_type=https://example.org/store/entitytypes/resource/example_geo"

var api = new Entryscape.DatasetApi();
var opts = {
  'entrystoreHost': "dev.entryscape.com/store/"
};
api.listDatasets(opts, function(error, data) {
  if (!error) {
    console.log('Total results:', data.results);
    data.items.forEach(function(item) {
      console.log('- [' + item.context_id + '/' + item.entry_id + '] ' + item.entity_type);
    });
  }
});

const api = new DatasetApi(config);
const response = await api.listDatasets({
  entrystoreHost: "dev.entryscape.com/store/",
});
console.log('Total results:', response.results);
for (const item of response.items) {
  console.log(`- [${item.contextId}/${item.entryId}] ${item.entityType}`);
}

api_instance = entryscape_client.DatasetApi()
response = api_instance.list_datasets(
    entrystore_host="dev.entryscape.com/store/"
)
print(f'Total results: {response.results}')
for item in response.items:
    print(f'- [{item.context_id}/{item.entry_id}] {item.entity_type}')

var apiInstance = new DatasetApi();
var response = apiInstance.ListDatasets(
    entrystoreHost: "dev.entryscape.com/store/"
);
Debug.WriteLine("Total results: " + response.Results);
foreach (var item in response.Items)
{
    Debug.WriteLine($"- [{item.ContextId}/{item.EntryId}] {item.EntityType}");
}

Scopes

Parameters