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" : "d5bba647-27e9-4224-8bba-afcb69ae87d6",
  "name" : "SITChannel",
  "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2024-04-10T14:06:48.821291",
  "lastModified" : "2024-04-10T14:06:48.821291",
  "description" : "SITChannel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/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

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/d109d00f-feeb-4101-8155-1c649734ad38/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/d109d00f-feeb-4101-8155-1c649734ad38/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" : "b382ce47-e902-4a6a-bcbe-a10f301d757d",
  "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
  "created" : "2024-04-10T14:06:56.107713672",
  "lastModified" : "2024-04-10T14:06:56.107714272",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "create channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d"
    }
  }
}

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/d5bba647-27e9-4224-8bba-afcb69ae87d6' -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/d5bba647-27e9-4224-8bba-afcb69ae87d6"

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" : "d5bba647-27e9-4224-8bba-afcb69ae87d6",
  "name" : "SITChannel",
  "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2024-04-10T14:06:48.821291",
  "lastModified" : "2024-04-10T14:06:48.821291",
  "description" : "SITChannel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/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/d5bba647-27e9-4224-8bba-afcb69ae87d6' -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/d5bba647-27e9-4224-8bba-afcb69ae87d6"

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" : "d5bba647-27e9-4224-8bba-afcb69ae87d6",
  "name" : "SITChannel",
  "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2024-04-10T14:06:48.821291",
  "lastModified" : "2024-04-10T14:06:48.821291",
  "description" : "SITChannel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/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/d109d00f-feeb-4101-8155-1c649734ad38/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/d109d00f-feeb-4101-8155-1c649734ad38/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" : "d5bba647-27e9-4224-8bba-afcb69ae87d6",
      "name" : "SITChannel",
      "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "scope" : "PROFILE",
      "type" : "SOURCE",
      "created" : "2024-04-10T14:06:48.821291",
      "lastModified" : "2024-04-10T14:06:48.821291",
      "description" : "SITChannel",
      "datasetCount" : 0,
      "containsDataset" : false,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
        },
        "datasets" : {
          "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/datasets",
          "type" : "GET"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/subscriptions"
        },
        "update channel" : {
          "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
        },
        "delete channel" : {
          "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
        },
        "add workspace-scope" : {
          "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/scope/workspace"
        }
      }
    }, {
      "id" : "2d58e6d5-b8d3-4aa3-8363-701c0bbce705",
      "name" : "SITChannelTwo",
      "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "scope" : "PROFILE",
      "type" : "SOURCE",
      "created" : "2024-04-10T14:06:49.013965",
      "lastModified" : "2024-04-10T14:06:49.013965",
      "description" : "SITChannelTwo",
      "datasetCount" : 0,
      "containsDataset" : false,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/channels/2d58e6d5-b8d3-4aa3-8363-701c0bbce705"
        },
        "datasets" : {
          "href" : "https://catalog.matatika.com/api/channels/2d58e6d5-b8d3-4aa3-8363-701c0bbce705/datasets",
          "type" : "GET"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/channels/2d58e6d5-b8d3-4aa3-8363-701c0bbce705/subscriptions"
        },
        "update channel" : {
          "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/2d58e6d5-b8d3-4aa3-8363-701c0bbce705"
        },
        "delete channel" : {
          "href" : "https://catalog.matatika.com/api/channels/2d58e6d5-b8d3-4aa3-8363-701c0bbce705"
        },
        "add workspace-scope" : {
          "href" : "https://catalog.matatika.com/api/channels/2d58e6d5-b8d3-4aa3-8363-701c0bbce705/scope/workspace"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/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/d109d00f-feeb-4101-8155-1c649734ad38/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6' -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/d109d00f-feeb-4101-8155-1c649734ad38/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"

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" : "d5bba647-27e9-4224-8bba-afcb69ae87d6",
  "name" : "SITChannel",
  "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2024-04-10T14:06:48.821290951",
  "lastModified" : "2024-04-10T14:06:48.821291151",
  "description" : "SITChannel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/d5bba647-27e9-4224-8bba-afcb69ae87d6/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/d5bba647-27e9-4224-8bba-afcb69ae87d6' -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/d5bba647-27e9-4224-8bba-afcb69ae87d6"

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/d109d00f-feeb-4101-8155-1c649734ad38/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/d109d00f-feeb-4101-8155-1c649734ad38/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" : "036ccfd4-7ccb-443f-a4d8-7b36d8ae7cb9",
      "name" : "SITChannel",
      "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "scope" : "WORKSPACE",
      "type" : "SOURCE",
      "created" : "2024-04-10T14:06:50.083295",
      "lastModified" : "2024-04-10T14:06:50.083295",
      "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/d109d00f-feeb-4101-8155-1c649734ad38/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/b382ce47-e902-4a6a-bcbe-a10f301d757d/datasets/96f7855b-269c-4f4c-bfe3-75bbd6e7313c' -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/b382ce47-e902-4a6a-bcbe-a10f301d757d/datasets/96f7855b-269c-4f4c-bfe3-75bbd6e7313c"

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/b382ce47-e902-4a6a-bcbe-a10f301d757d/datasets/96f7855b-269c-4f4c-bfe3-75bbd6e7313c' -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/b382ce47-e902-4a6a-bcbe-a10f301d757d/datasets/96f7855b-269c-4f4c-bfe3-75bbd6e7313c"

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/b382ce47-e902-4a6a-bcbe-a10f301d757d/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/b382ce47-e902-4a6a-bcbe-a10f301d757d/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" : "b382ce47-e902-4a6a-bcbe-a10f301d757d",
  "name" : "mylist",
  "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "scope" : "WORKSPACE",
  "type" : "LIST",
  "created" : "2024-04-10T14:06:56.249131",
  "lastModified" : "2024-04-10T14:06:56.249132",
  "description" : "mylist channel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d"
    },
    "withdraw workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d/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/b382ce47-e902-4a6a-bcbe-a10f301d757d/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/b382ce47-e902-4a6a-bcbe-a10f301d757d/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" : "b382ce47-e902-4a6a-bcbe-a10f301d757d",
  "name" : "mylist",
  "workspaceId" : "d109d00f-feeb-4101-8155-1c649734ad38",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "scope" : "PROFILE",
  "type" : "LIST",
  "created" : "2024-04-10T14:06:56.249131",
  "lastModified" : "2024-04-10T14:06:56.249132",
  "description" : "mylist channel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/d109d00f-feeb-4101-8155-1c649734ad38/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/b382ce47-e902-4a6a-bcbe-a10f301d757d/scope/workspace"
    }
  }
}

Channels

Objects

Channel

Requests

See Also

Initialise a channel

Request

Example Snippets

Response

View a channel

Prerequisites

Request

Example Snippets

Response

View a channel in a workspace

Prerequisites

Request

Example Snippets

Response

View all channels in a workspace

Request

Query Parameters

Prerequisites

Request

Example Snippets

Response

Create or Update a channel in a workspace

Prerequisites

Request

Example Snippets

Response

Delete a channel

Prerequisites

Request

Example Snippets

Response

View all channels in your workspace news

Request

Example Snippets

Response

Add a dataset to a list channel

Request

Example Snippets

Response

Remove a dataset from a list channel

Request

Example Snippets

Response

Add workspace scope to a channel

Request

Example Snippets

Response

Withdraw workspace scope from a channel

Request

Example Snippets

Response