Datasets
Datasets are modules of data that can be published to workspaces. Datasets are visualised in the Matatika app following the Chart.js specifications.
Objects
Dataset
Path | Type | Format | Description |
---|---|---|---|
id |
String |
Version 4 UUID | The dataset ID |
published |
String |
ISO 8601 timestamp | The instant the dataset was published |
alias |
String |
The dataset alias | |
workspaceId |
String |
Version 4 UUID | The workspace ID of the published dataset |
source |
String |
The channel ID where the dataset was initially published to | |
title |
String |
The dataset title | |
description |
String |
The dataset description (may contain markdown) | |
questions |
String |
The dataset questions | |
rawData |
String |
JSON | The dataset raw data |
visualisation |
String |
JSON | The dataset visualisation metadata. More Info |
metadata |
String |
JSON | The dataset metadata. More Info |
query |
String |
SQL statement | The dataset query. More Info |
likeCount |
Integer |
The number of likes the dataset has received | |
likedByProfiles |
Array of Member |
The members that have liked the dataset | |
commentCount |
Integer |
The number of comments the dataset has received | |
viewCount |
Integer |
The number of views the dataset has received | |
created |
String |
ISO 8601 timestamp | The instant the dataset was create |
score |
Float |
The dataset score used to determine its position in the workspace Feed |
{
"id" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"published" : "2023-09-20T10:47:14.949555",
"alias" : "sit-generated-dataset",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:14.949554",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel"
}
}
}
Dataset Message
Path | Type | Format | Description |
---|---|---|---|
id |
String |
Version 4 UUID | The dataset message ID (shared with the resulting notification) |
recipientId |
String |
The recipient profile ID | |
message |
String |
The dataset message content | |
datasetId |
String |
Version 4 UUID | The message subject dataset ID |
{
"id" : "d366fbb3-cd1c-433a-8163-13a49655da76",
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2023-09-20T11:47:18.851435]",
"datasetId" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"_links" : {
"notification" : {
"href" : "https://catalog.matatika.com/api/notifications/d366fbb3-cd1c-433a-8163-13a49655da76"
}
}
}
Requests
- View all datasets in a workspace
- View all liked datasets in a workspace
- View datasets by channel
- View a dataset
- View a dataset in a workspace
- View the data of a dataset
- Publish a dataset to a workspace
- Edit a dataset
- Record a view of a dataset
- Record a like of a dataset
- Remove a like from a dataset
- Initialise a new dataset message
- Create or update a dataset message
- Delete a dataset
See Also
- View all comments on a dataset
- Search for datasets in a workspace by free text
- Search for datasets in a workspace by channel name
- Search for datasets in a workspace by tag name
- Subscribe to a dataset
View all datasets in a workspace
GET
/api/workspaces/{workspace-id}/datasets
Returns all datasets in the workspace {workspace-id}
.
Prerequisites
- The user must be a member of the workspace
{workspace-id}
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/datasets' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/datasets"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset collection with HAL links.
{
"_embedded" : {
"datasets" : [ {
"id" : "dfdd8248-e9cf-4829-b85b-c59fbd66970f",
"published" : "2023-09-20T10:47:20.163446",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:20.163446",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
}, {
"id" : "cdae74ff-8a25-4084-a98f-775bde0a1f8a",
"published" : "2023-09-20T10:47:19.777644",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:19.777644",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
}, {
"id" : "f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f",
"published" : "2023-09-20T10:47:19.98149",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:19.98149",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/datasets?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 3,
"totalPages" : 1,
"number" : 0
}
}
View all liked datasets in a workspace
GET
/api/workspaces/{workspace-id}/liked
Returns all datasets in the workspace {workspace-id}
liked by the authenticated profile.
Prerequisites
- The user must be a member of the workspace
{workspace-id}
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/liked' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/liked"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset collection with HAL links.
{
"_embedded" : {
"datasets" : [ {
"id" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"published" : "2023-09-20T10:47:17.153409",
"alias" : "sit-generated-dataset",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:17.056248]",
"description" : "This dataset was edited during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 1,
"likedByProfiles" : [ {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
} ],
"commentCount" : 0,
"viewCount" : 1,
"created" : "2023-09-20T10:47:14.949554",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/comments",
"type" : "POST"
},
"remove like" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like",
"type" : "DELETE"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/liked?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
}
View datasets by channel
GET
/api/channels/{channel-id}/datasets
Returns datasets by the channel {channel-id}
.
Prerequisites
- Channel
{channel-id}
must exist
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515/datasets' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515/datasets"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset collection with HAL links.
{
"_embedded" : {
"datasets" : [ {
"id" : "dfdd8248-e9cf-4829-b85b-c59fbd66970f",
"published" : "2023-09-20T10:47:20.163446",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:20.163446",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/dfdd8248-e9cf-4829-b85b-c59fbd66970f/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
}, {
"id" : "cdae74ff-8a25-4084-a98f-775bde0a1f8a",
"published" : "2023-09-20T10:47:19.777644",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:19.777644",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/cdae74ff-8a25-4084-a98f-775bde0a1f8a/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
}, {
"id" : "f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f",
"published" : "2023-09-20T10:47:19.98149",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:19.98149",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/f9fe1c7e-4dbb-4cd9-b66d-bc8d129f275f/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515/datasets?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 3,
"totalPages" : 1,
"number" : 0
}
}
View a dataset
GET
/api/datasets/{dataset-id}
Returns the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset with HAL links.
{
"id" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"published" : "2023-09-20T10:47:14.949555",
"alias" : "sit-generated-dataset",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:14.949554",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel"
}
}
}
View a dataset in a workspace
GET
/api/workspaces/{workspace-id}/datasets/{dataset-id-or-alias}
Returns the dataset {dataset-id-or-alias}
in the workspace {workspace-id}
.
Prerequisites
- The user must be a member of the workspace
{workspace-id}
- Dataset
{dataset-id-or-alias}
must exist within the workspace{workspace-id}
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/datasets/sit-generated-dataset' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/datasets/sit-generated-dataset"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset with HAL links.
{
"id" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"published" : "2023-09-20T10:47:14.949555",
"alias" : "sit-generated-dataset",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:14.949554",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel"
}
}
}
View the data of a dataset
GET
/api/datasets/{dataset-id}/data
Returns the data of the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Headers
Accept
Media Type(s) | Description |
---|---|
application/json */* |
Sets the response content type format to JSON |
text/csv |
Sets the response content type format to CSV |
Defaults to application/json
(given Accept */*
or no Accept
header).
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/50e11291-d1cf-4dcf-bd88-c4d0e414236d/data' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/50e11291-d1cf-4dcf-bd88-c4d0e414236d/data"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200
: The dataset data (defaults to JSON format).
[ {
"gitflixusers.name" : "John",
"gitflixusers.age" : "23"
}, {
"gitflixusers.name" : "George",
"gitflixusers.age" : "42"
}, {
"gitflixusers.name" : "Mary",
"gitflixusers.age" : "19"
}, {
"gitflixusers.name" : "Kate",
"gitflixusers.age" : "52"
}, {
"gitflixusers.name" : "Bill",
"gitflixusers.age" : "35"
}, {
"gitflixusers.name" : "Fiona",
"gitflixusers.age" : "63"
} ]
204
: No response body provided.
Publish a dataset to a workspace
POST
/api/workspaces/{workspace-id}/datasets
Publishes a dataset to the workspace {workspace-id}
.
Prerequisites
- The user must be a member of the workspace
{workspace-id}
Request
Making the request with an existing id
or alias
will result in the respective dataset being overwritten.
Dataset resource.
{
"alias" : "sit-generated-dataset",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;"
}
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/datasets' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/hal+json; charset=ISO-8859-1' \
-d '{
"alias" : "sit-generated-dataset",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;"
}'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491/datasets"
data = {
"alias" : "sit-generated-dataset",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK / 201 Created
Dataset with HAL links.
{
"id" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"published" : "2023-09-20T10:47:14.949554519",
"alias" : "sit-generated-dataset",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:14.809398]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:14.949554319",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel"
}
}
}
Edit a dataset
PATCH
/api/datasets/{dataset-id}
Edits the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Body
This request can update one or more of the dataset fields at once. With a single request, it is possible to - for example - edit the dataset title
only, or both title
and description
(shown below).
{
"title" : "SIT-Generated Dataset [2023-09-20T11:47:17.056248]",
"description" : "This dataset was edited during a SIT run."
}
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a' -i -X PATCH \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/hal+json; charset=ISO-8859-1' \
-d '{
"title" : "SIT-Generated Dataset [2023-09-20T11:47:17.056248]",
"description" : "This dataset was edited during a SIT run."
}'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
data = {
"title" : "SIT-Generated Dataset [2023-09-20T11:47:17.056248]",
"description" : "This dataset was edited during a SIT run."
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PATCH", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
Dataset with HAL links.
{
"id" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"published" : "2023-09-20T10:47:17.153408583",
"alias" : "sit-generated-dataset",
"workspaceId" : "848c90a4-5aa3-40e7-9ebc-f8cb5c4fd491",
"source" : "@support+integrationtests+a7o91bel",
"title" : "SIT-Generated Dataset [2023-09-20T11:47:17.056248]",
"description" : "This dataset was edited during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2023-09-20T10:47:14.949554",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/72cc4095-839f-4834-bbe2-fc9255a4b515",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@support+integrationtests+a7o91bel",
"description" : "[email protected] Channel"
}
}
}
Record a view of a dataset
PUT
/api/datasets/{dataset-id}/view
“Adds a view to the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/view' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/view"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
No response body provided.
Record a like of a dataset
PUT
/api/datasets/{dataset-id}/like
Records a like of the dataset {dataset-id}
from the authenticated user profile.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
No response body provided.
Remove a like from a dataset
DELETE
/api/datasets/{dataset-id}/like
Removes a like of the dataset {dataset-id}
from the authenticated user profile.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like' -i -X DELETE \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/like"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.
Initialise a new dataset message
POST
/api/datasets/{dataset-id}/messages
Initialises a new dataset message for the dataset {dataset-id}
Prerequisites
- Dataset
{dataset-id}
must exist
Requests
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset Message with HAL links.
{
"id" : "d366fbb3-cd1c-433a-8163-13a49655da76",
"datasetId" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"_links" : {
"create message" : {
"href" : "https://catalog.matatika.com/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages/d366fbb3-cd1c-433a-8163-13a49655da76"
}
}
}
Create or update a dataset message
PUT
/api/datasets/{dataset-id}/messages/{message-id}
Creates or updates the dataset message {message-id}
for the dataset {dataset-id}
. This appears as DATASET_MESSAGE
notification for the recipient.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Body
Dataset Message resource.
{
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2023-09-20T11:47:18.851435]"
}
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages/d366fbb3-cd1c-433a-8163-13a49655da76' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/hal+json; charset=ISO-8859-1' \
-d '{
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2023-09-20T11:47:18.851435]"
}'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a/messages/d366fbb3-cd1c-433a-8163-13a49655da76"
data = {
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2023-09-20T11:47:18.851435]"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK / 201 Created
Dataset Message with HAL links.
{
"id" : "d366fbb3-cd1c-433a-8163-13a49655da76",
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2023-09-20T11:47:18.851435]",
"datasetId" : "02f7ed52-89cd-4b08-8393-1fc6ad39a77a",
"_links" : {
"notification" : {
"href" : "https://catalog.matatika.com/api/notifications/d366fbb3-cd1c-433a-8163-13a49655da76"
}
}
}
Delete a dataset
DELETE
/api/datasets/{dataset-id}
Deletes the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a' -i -X DELETE \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/datasets/02f7ed52-89cd-4b08-8393-1fc6ad39a77a"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.
Further Reading: