Channels
Channels enable datasets to be categorised or grouped together. A single workspace can have multiple channels.
Objects
Channel
Path | Type | Format | Description |
---|---|---|---|
id |
String |
Version 4 UUID | The channel ID |
creator |
Member |
The channel creator | |
workspace |
Workspace |
The channel workspace | |
created |
String |
ISO 8601 timestamp | The channel created at timestamp |
lastModified |
String |
ISO 8601 timestamp | The channel last modified timestamp |
name |
String |
The channel name | |
description |
String |
The channel description | |
picture |
String |
URL | The channel picture metadata |
{
"id" : "9b7fb407-351a-4634-abfe-2491b1c8145e",
"name" : "SITChannel",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "PROFILE",
"type" : "SOURCE",
"created" : "2023-09-20T10:49:28.527156",
"lastModified" : "2023-09-20T10:49:28.527157",
"description" : "SITChannel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"datasets" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/datasets",
"type" : "GET"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/subscriptions"
},
"update channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"delete channel" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"add workspace-scope" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/scope/workspace"
}
}
}
Requests
- Initialise a channel
- View a channel
- View a channel in a workspace
- View all channels in a workspace
- Create or Update a channel in a workspace
- Delete a channel
- View all channels in your workspace news
- Add a dataset to a list channel
- Remove a dataset from a list channel
- Add workspace scope to a channel
- Withdraw workspace scope from a channel
See Also
Initialise a channel
POST
/api/channels/{channel-id}
Initialise a channel.
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{ }'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels"
data = { }
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
Channel with HAL links.
{
"id" : "269a6385-0bab-4c52-ba23-996aebbc56fc",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"created" : "2023-09-20T10:49:31.149082119",
"lastModified" : "2023-09-20T10:49:31.149082719",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"create channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/269a6385-0bab-4c52-ba23-996aebbc56fc"
}
}
}
View a channel
GET
/api/channels/{channel-id}
Returns 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/9b7fb407-351a-4634-abfe-2491b1c8145e' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{ }'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
data = { }
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
Channel with HAL links.
{
"id" : "9b7fb407-351a-4634-abfe-2491b1c8145e",
"name" : "SITChannel",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "PROFILE",
"type" : "SOURCE",
"created" : "2023-09-20T10:49:28.527156",
"lastModified" : "2023-09-20T10:49:28.527157",
"description" : "SITChannel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"datasets" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/datasets",
"type" : "GET"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/subscriptions"
},
"update channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"delete channel" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"add workspace-scope" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/scope/workspace"
}
}
}
View a channel in a workspace
GET
/api/workspaces/{workspace-id}/channels/{channel-id}
Returns a channel in the workspace {workspace-id}
.
Prerequisites
- Workspace
{workspace-id}
must exist - 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/channels/9b7fb407-351a-4634-abfe-2491b1c8145e' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{ }'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
data = { }
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
Channel with HAL links.
{
"id" : "9b7fb407-351a-4634-abfe-2491b1c8145e",
"name" : "SITChannel",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "PROFILE",
"type" : "SOURCE",
"created" : "2023-09-20T10:49:28.527156",
"lastModified" : "2023-09-20T10:49:28.527157",
"description" : "SITChannel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"datasets" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/datasets",
"type" : "GET"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/subscriptions"
},
"update channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"delete channel" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"add workspace-scope" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/scope/workspace"
}
}
}
View all channels in a workspace
GET
/api/workspaces/{workspace-id}/channels/{channel-id}?type={type}&source={source}&containsDataset={datasetId}
Returns all channels in the workspace {workspace-id}
.
Request
Query Parameters
Parameter | Required | Format | Default Value | Description |
---|---|---|---|---|
type |
No | string | None | Return channels by types: list or source |
source |
No | string | None | Return channels by source: profile or workspace |
containsDataset |
No | string | None | Adds a containsDataset boolean field to all channels returning if it contains the dataset |
Prerequisites
- Workspace
{workspace-id}
must exist - 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/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{ }'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels"
data = { }
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
Channel collection with HAL links.
{
"_embedded" : {
"channels" : [ {
"id" : "9b7fb407-351a-4634-abfe-2491b1c8145e",
"name" : "SITChannel",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "PROFILE",
"type" : "SOURCE",
"created" : "2023-09-20T10:49:28.527156",
"lastModified" : "2023-09-20T10:49:28.527157",
"description" : "SITChannel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"datasets" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/datasets",
"type" : "GET"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/subscriptions"
},
"update channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"delete channel" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"add workspace-scope" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/scope/workspace"
}
}
}, {
"id" : "f64d6eed-7fcc-457e-a04c-0f339999c843",
"name" : "SITChannelTwo",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "PROFILE",
"type" : "SOURCE",
"created" : "2023-09-20T10:49:28.898787",
"lastModified" : "2023-09-20T10:49:28.898788",
"description" : "SITChannelTwo",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/f64d6eed-7fcc-457e-a04c-0f339999c843"
},
"datasets" : {
"href" : "https://catalog.matatika.com/api/channels/f64d6eed-7fcc-457e-a04c-0f339999c843/datasets",
"type" : "GET"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/channels/f64d6eed-7fcc-457e-a04c-0f339999c843/subscriptions"
},
"update channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/f64d6eed-7fcc-457e-a04c-0f339999c843"
},
"delete channel" : {
"href" : "https://catalog.matatika.com/api/channels/f64d6eed-7fcc-457e-a04c-0f339999c843"
},
"add workspace-scope" : {
"href" : "https://catalog.matatika.com/api/channels/f64d6eed-7fcc-457e-a04c-0f339999c843/scope/workspace"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels?page=0&size=10&sort=name,asc"
}
},
"page" : {
"size" : 10,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Create or Update a channel in a workspace
PUT
/api/workspaces/{workspace-id}/channels/{channel-id}
Creates or Updates a channel in the workspace {workspace-id}
.
This endpoint takes a {channel-id}
(UUID) and based on the supplied value and the channels that already exist in the workspace, will update or create a channel accordingly.
Prerequisites
- Workspace
{workspace-id}
must exist - The user must be a admin in the workspace
{workspace-id}
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/9b7fb407-351a-4634-abfe-2491b1c8145e' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{
"name" : "SITChannel",
"description" : "SITChannel"
}'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
data = {
"name" : "SITChannel",
"description" : "SITChannel"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK / 201 Created
Channel with HAL links.
{
"id" : "9b7fb407-351a-4634-abfe-2491b1c8145e",
"name" : "SITChannel",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "PROFILE",
"type" : "SOURCE",
"created" : "2023-09-20T10:49:28.527155843",
"lastModified" : "2023-09-20T10:49:28.527156543",
"description" : "SITChannel",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"datasets" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/datasets",
"type" : "GET"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/subscriptions"
},
"update channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"delete channel" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
},
"add workspace-scope" : {
"href" : "https://catalog.matatika.com/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e/scope/workspace"
}
}
}
Delete a channel
DELETE
/api/channels/{channel-id}
Delete a channel.
Prerequisites
- The user must be a admin of the workspace the channel is in.
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e' -i -X DELETE \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{ }'
- Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/channels/9b7fb407-351a-4634-abfe-2491b1c8145e"
data = { }
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.
View all channels in your workspace news
GET
/api/channels/{channel-id}
Returns all channels in your news for the workspace.
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/news/channels' -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/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/news/channels"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Channels in your workspace news.
{
"_embedded" : {
"channels" : [ {
"id" : "a351468d-fcd0-471a-89e9-465423582bfe",
"name" : "SITChannel",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "WORKSPACE",
"type" : "SOURCE",
"created" : "2023-09-20T10:49:30.110199",
"lastModified" : "2023-09-20T10:49:30.110199",
"description" : "SITChannel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"search" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/news?q=in:SITChannel"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels"
}
}
}
Add a dataset to a list channel
PUT
/api/channels/{channel-id}/datasets/{dataset-id}
Adds a dataset to a channel with type list.
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/datasets/bd92882b-fe9a-47e6-8214-90e5b041c65c' -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/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/datasets/bd92882b-fe9a-47e6-8214-90e5b041c65c"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
201 Created
No response body provided.
Remove a dataset from a list channel
DELETE
/api/channels/{channel-id}/datasets/{dataset-id}
Removes a dataset from a channel with type list.
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/datasets/bd92882b-fe9a-47e6-8214-90e5b041c65c' -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/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/datasets/bd92882b-fe9a-47e6-8214-90e5b041c65c"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.
Add workspace scope to a channel
PUT
/api/channels/{channel-id}/scope/workspace
Add workspace scope to a channel.
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/scope/workspace' -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/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/scope/workspace"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Channel with HAL links.
{
"id" : "269a6385-0bab-4c52-ba23-996aebbc56fc",
"name" : "mylist",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "WORKSPACE",
"type" : "LIST",
"created" : "2023-09-20T10:49:31.32318",
"lastModified" : "2023-09-20T10:49:31.323181",
"description" : "mylist channel",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc"
},
"datasets" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/datasets",
"type" : "GET"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/subscriptions"
},
"update channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/269a6385-0bab-4c52-ba23-996aebbc56fc"
},
"delete channel" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc"
},
"withdraw workspace-scope" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/scope/profile"
}
}
}
Withdraw workspace scope from a channel
PUT
/api/channels/{channel-id}/scope/profile
Withdraw workspace scope from a channel.
Request
Example Snippets
- cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/scope/profile' -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/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/scope/profile"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Channel with HAL links.
{
"id" : "269a6385-0bab-4c52-ba23-996aebbc56fc",
"name" : "mylist",
"workspaceId" : "aaa489d4-6cf1-4d46-bcd0-2981a3891fe5",
"creator" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@support+integrationtests+a7o91bel"
},
"scope" : "PROFILE",
"type" : "LIST",
"created" : "2023-09-20T10:49:31.32318",
"lastModified" : "2023-09-20T10:49:31.323181",
"description" : "mylist channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png",
"datasetCount" : 0,
"containsDataset" : false,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc"
},
"datasets" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/datasets",
"type" : "GET"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/subscriptions"
},
"update channel" : {
"href" : "https://catalog.matatika.com/api/workspaces/aaa489d4-6cf1-4d46-bcd0-2981a3891fe5/channels/269a6385-0bab-4c52-ba23-996aebbc56fc"
},
"delete channel" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc"
},
"add workspace-scope" : {
"href" : "https://catalog.matatika.com/api/channels/269a6385-0bab-4c52-ba23-996aebbc56fc/scope/workspace"
}
}
}