Link Search Menu Expand Document

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" : "e9e9a57b-918f-46bb-b66f-d498506650fa",
  "name" : "SITChannel",
  "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@support+integrationtests+a7o91bel"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2022-11-04T15:17:37.097525",
  "lastModified" : "2022-11-04T15:17:37.097525",
  "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/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/scope/workspace"
    }
  }
}

Requests

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/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/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/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/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" : "a9bf6eb8-6a1a-4879-b42c-8f92441e8398",
  "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
  "created" : "2022-11-04T15:17:41.111560139",
  "lastModified" : "2022-11-04T15:17:41.111560739",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "create channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398"
    }
  }
}

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/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa' -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/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"

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" : "e9e9a57b-918f-46bb-b66f-d498506650fa",
  "name" : "SITChannel",
  "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@support+integrationtests+a7o91bel"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2022-11-04T15:17:37.097525",
  "lastModified" : "2022-11-04T15:17:37.097525",
  "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/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/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/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa' -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/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"

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" : "e9e9a57b-918f-46bb-b66f-d498506650fa",
  "name" : "SITChannel",
  "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@support+integrationtests+a7o91bel"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2022-11-04T15:17:37.097525",
  "lastModified" : "2022-11-04T15:17:37.097525",
  "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/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/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/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/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/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/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" : "e9e9a57b-918f-46bb-b66f-d498506650fa",
      "name" : "SITChannel",
      "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "scope" : "PROFILE",
      "type" : "SOURCE",
      "created" : "2022-11-04T15:17:37.097525",
      "lastModified" : "2022-11-04T15:17:37.097525",
      "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/e9e9a57b-918f-46bb-b66f-d498506650fa"
        },
        "datasets" : {
          "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/datasets",
          "type" : "GET"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/subscriptions"
        },
        "update channel" : {
          "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
        },
        "delete channel" : {
          "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
        },
        "add workspace-scope" : {
          "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/scope/workspace"
        }
      }
    }, {
      "id" : "2ff2fd88-10a2-43bd-92e9-2ce54282e8af",
      "name" : "SITChannelTwo",
      "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "scope" : "PROFILE",
      "type" : "SOURCE",
      "created" : "2022-11-04T15:17:37.380247",
      "lastModified" : "2022-11-04T15:17:37.380248",
      "description" : "SITChannelTwo",
      "datasetCount" : 0,
      "containsDataset" : false,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/channels/2ff2fd88-10a2-43bd-92e9-2ce54282e8af"
        },
        "datasets" : {
          "href" : "https://catalog.matatika.com/api/channels/2ff2fd88-10a2-43bd-92e9-2ce54282e8af/datasets",
          "type" : "GET"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/channels/2ff2fd88-10a2-43bd-92e9-2ce54282e8af/subscriptions"
        },
        "update channel" : {
          "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/2ff2fd88-10a2-43bd-92e9-2ce54282e8af"
        },
        "delete channel" : {
          "href" : "https://catalog.matatika.com/api/channels/2ff2fd88-10a2-43bd-92e9-2ce54282e8af"
        },
        "add workspace-scope" : {
          "href" : "https://catalog.matatika.com/api/channels/2ff2fd88-10a2-43bd-92e9-2ce54282e8af/scope/workspace"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/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/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/e9e9a57b-918f-46bb-b66f-d498506650fa' -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/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"

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" : "e9e9a57b-918f-46bb-b66f-d498506650fa",
  "name" : "SITChannel",
  "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@support+integrationtests+a7o91bel"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2022-11-04T15:17:37.097524792",
  "lastModified" : "2022-11-04T15:17:37.097525292",
  "description" : "SITChannel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa/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/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa' -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/api/channels/e9e9a57b-918f-46bb-b66f-d498506650fa"

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/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/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/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/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" : "f7200ead-116a-45c8-a5d4-3509af175886",
      "name" : "SITChannel",
      "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "scope" : "WORKSPACE",
      "type" : "SOURCE",
      "created" : "2022-11-04T15:17:39.549961",
      "lastModified" : "2022-11-04T15:17:39.549961",
      "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/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/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/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/datasets/5db0d671-8f1f-44fc-9870-d24d5712b81d' -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/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/datasets/5db0d671-8f1f-44fc-9870-d24d5712b81d"

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/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/datasets/5db0d671-8f1f-44fc-9870-d24d5712b81d' -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/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/datasets/5db0d671-8f1f-44fc-9870-d24d5712b81d"

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/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/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/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/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" : "a9bf6eb8-6a1a-4879-b42c-8f92441e8398",
  "name" : "mylist",
  "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@support+integrationtests+a7o91bel"
  },
  "scope" : "WORKSPACE",
  "type" : "LIST",
  "created" : "2022-11-04T15:17:41.29206",
  "lastModified" : "2022-11-04T15:17:41.29206",
  "description" : "mylist channel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398"
    },
    "withdraw workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/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/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/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/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/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" : "a9bf6eb8-6a1a-4879-b42c-8f92441e8398",
  "name" : "mylist",
  "workspaceId" : "4d965b55-028b-406c-b0a9-f0b95fdaf0e8",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@support+integrationtests+a7o91bel"
  },
  "scope" : "PROFILE",
  "type" : "LIST",
  "created" : "2022-11-04T15:17:41.29206",
  "lastModified" : "2022-11-04T15:17:41.29206",
  "description" : "mylist channel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398"
    },
    "datasets" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/subscriptions"
    },
    "update channel" : {
      "href" : "https://catalog.matatika.com/api/workspaces/4d965b55-028b-406c-b0a9-f0b95fdaf0e8/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398"
    },
    "delete channel" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398"
    },
    "add workspace-scope" : {
      "href" : "https://catalog.matatika.com/api/channels/a9bf6eb8-6a1a-4879-b42c-8f92441e8398/scope/workspace"
    }
  }
}