Link Search Menu Expand Document

Subscriptions

Subscriptions are a declaration of interest in a particular resource, allowing a user to receive notifications when certain events occur. The events that trigger notifications are controlled by the type of subscription.

Objects

Subscription

Path Type Format Description
id String Version 4 UUID The subscription ID
created String ISO 8601 timestamp The instant the subscription was created at
lastModified String ISO 8601 timestamp The instant the subscription was last modified at
type String Subscription Type The type of subscription 
{
  "id" : "2a3a2bc3-65b3-4190-aecc-413c882801da",
  "created" : "2023-03-23T21:55:08.575179",
  "lastModified" : "2023-03-23T21:55:08.575179",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da"
    },
    "delete subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://catalog.matatika.com/api/channels/776f1b0a-eda0-415e-83be-4284cabc9350"
    }
  }
}

Formats

Subscription Type

String

Value Description
ALL Triggers notifications for all resource events
ALERTS Triggers notifications for resource alert events only
NONE Does not trigger any notifications

Requests

View all subscriptions

GET

/api/subscriptions

Returns all subscriptions for the authenticated user profile.

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/subscriptions' -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/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription collection with HAL links.

{
  "_embedded" : {
    "subscriptions" : [ {
      "id" : "2a3a2bc3-65b3-4190-aecc-413c882801da",
      "created" : "2023-03-23T21:55:08.575179",
      "lastModified" : "2023-03-23T21:55:08.884051",
      "type" : "ALERTS",
      "_embedded" : {
        "channel" : {
          "name" : "matatika-limited",
          "description" : "Matatika Limited",
          "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
        },
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da"
        },
        "delete subscription" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
          "type" : "PUT"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/776f1b0a-eda0-415e-83be-4284cabc9350"
        }
      }
    }, {
      "id" : "01eb2b56-8b71-4f6b-891b-ea7d8f962d1c",
      "created" : "2023-03-23T21:55:09.584798",
      "lastModified" : "2023-03-23T21:55:09.584798",
      "type" : "ALL",
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "dataset" : {
          "id" : "c1d20c15-d387-419b-ae98-43905f0051cc",
          "published" : "2023-03-23T21:55:07.662305",
          "alias" : "simple-bar-chart",
          "workspaceId" : "8810dae9-41f9-4dd1-87ac-56a097f1caa4",
          "source" : "matatika-limited",
          "title" : "How many people have visited our website?",
          "description" : "# Some Markdown\n- point 1\n- point 2\n- point 3\n",
          "questions" : "[''This is my question'', ''this is second question'']",
          "visualisation" : "{\"google-chart\": {\"chartType\": \"BarChart\",\"options\": {\"title\": \"Website visitors\"}}}",
          "query" : "SELECT to_char(date(report_date),'YYYYMM') as year_month, SUM(sessions) \n   FROM\n     \"google_analytics_website_overview\"\n   WHERE\n     \"google_analytics_website_overview\".\"report_date\" >= DATE(NOW()) - INTERVAL '365 DAY'\n   GROUP BY year_month\n   ORDER BY year_month ASC;",
          "likeCount" : 0,
          "likedByProfiles" : [ ],
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2023-03-23T21:55:07.662305",
          "score" : 1.0
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/01eb2b56-8b71-4f6b-891b-ea7d8f962d1c"
        },
        "delete subscription" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/01eb2b56-8b71-4f6b-891b-ea7d8f962d1c",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/01eb2b56-8b71-4f6b-891b-ea7d8f962d1c",
          "type" : "PUT"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/c1d20c15-d387-419b-ae98-43905f0051cc"
        }
      }
    }, {
      "id" : "34d79d83-3de2-4574-b642-a0b671dd905f",
      "created" : "2023-03-23T21:55:15.914904",
      "lastModified" : "2023-03-23T21:55:15.914904",
      "type" : "ALL",
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "pipeline" : {
          "id" : "15aeadc9-626e-472d-a43c-1742e29c9e7f",
          "name" : "SIT-generated pipeline",
          "lastModified" : "2023-03-23T21:55:10.347777"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/34d79d83-3de2-4574-b642-a0b671dd905f"
        },
        "delete subscription" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/34d79d83-3de2-4574-b642-a0b671dd905f",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/34d79d83-3de2-4574-b642-a0b671dd905f",
          "type" : "PUT"
        },
        "pipeline" : {
          "href" : "https://catalog.matatika.com/api/pipelines/15aeadc9-626e-472d-a43c-1742e29c9e7f"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/subscriptions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

View all member subscriptions to a workspace

GET

/api/workspaces/{workspace-id}/members/subscriptions

Returns all member subscriptions to the workspace {workspace-id}.

Prerequisites

  • Workspace {workspace-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/8810dae9-41f9-4dd1-87ac-56a097f1caa4/members/subscriptions' -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/8810dae9-41f9-4dd1-87ac-56a097f1caa4/members/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription collection with HAL links.

{
  "_embedded" : {
    "subscriptions" : [ {
      "id" : "ea5a66d8-f00e-4b8e-aa56-15760d865f42",
      "created" : "2023-03-23T21:55:16.236193",
      "lastModified" : "2023-03-23T21:55:16.236193",
      "type" : "ALL",
      "_embedded" : {
        "subscriberWorkspace" : {
          "id" : "8810dae9-41f9-4dd1-87ac-56a097f1caa4",
          "name" : "Test Workspace [2023-03-23T21:55:04.502187545]"
        },
        "workspace" : {
          "id" : "8810dae9-41f9-4dd1-87ac-56a097f1caa4",
          "name" : "Test Workspace [2023-03-23T21:55:04.502187545]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/ea5a66d8-f00e-4b8e-aa56-15760d865f42"
        },
        "update subscription" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/ea5a66d8-f00e-4b8e-aa56-15760d865f42",
          "type" : "PUT"
        },
        "delete subscription" : {
          "href" : "https://catalog.matatika.com/api/subscriptions/ea5a66d8-f00e-4b8e-aa56-15760d865f42",
          "type" : "DELETE"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/8810dae9-41f9-4dd1-87ac-56a097f1caa4"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/8810dae9-41f9-4dd1-87ac-56a097f1caa4/members/subscriptions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

View a subscription

GET

/api/subscriptions/{subscription-id}

Returns the subscription {subscription-id}.

Prerequisites

  • Subscription {subscription-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da' -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/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "2a3a2bc3-65b3-4190-aecc-413c882801da",
  "created" : "2023-03-23T21:55:08.575179",
  "lastModified" : "2023-03-23T21:55:08.575179",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da"
    },
    "delete subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://catalog.matatika.com/api/channels/776f1b0a-eda0-415e-83be-4284cabc9350"
    }
  }
}

Subscribe to a workspace

POST

/api/workspaces/{workspace-id}/subscriptions

Subscribes the authenticated user profile to the workspace {workspace-id}.

By default, the subscription is configured for all workspace events (see Subscription Type for more information).

Prerequisites

  • Workspace {workspace-id} must exist

Request

Query Parameters

Parameter Required Format Default Value Description
allMembers No Boolean false Whether or not to subscribe the workspace to workspace events, in order to enable workspace-wide notifications for all members by default (applicable for the workspace owner only)

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/8810dae9-41f9-4dd1-87ac-56a097f1caa4/subscriptions?allMembers=true' -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/workspaces/8810dae9-41f9-4dd1-87ac-56a097f1caa4/subscriptions?allMembers=true"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "ea5a66d8-f00e-4b8e-aa56-15760d865f42",
  "created" : "2023-03-23T21:55:16.23619252",
  "lastModified" : "2023-03-23T21:55:16.23619312",
  "type" : "ALL",
  "_embedded" : {
    "subscriberWorkspace" : {
      "id" : "8810dae9-41f9-4dd1-87ac-56a097f1caa4",
      "name" : "Test Workspace [2023-03-23T21:55:04.502187545]"
    },
    "workspace" : {
      "id" : "8810dae9-41f9-4dd1-87ac-56a097f1caa4",
      "name" : "Test Workspace [2023-03-23T21:55:04.502187545]"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/ea5a66d8-f00e-4b8e-aa56-15760d865f42"
    },
    "update subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/ea5a66d8-f00e-4b8e-aa56-15760d865f42",
      "type" : "PUT"
    },
    "delete subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/ea5a66d8-f00e-4b8e-aa56-15760d865f42",
      "type" : "DELETE"
    },
    "workspace" : {
      "href" : "https://catalog.matatika.com/api/workspaces/8810dae9-41f9-4dd1-87ac-56a097f1caa4"
    }
  }
}

Subscribe to a channel

POST

/api/channels/{channel-id}/subscriptions

Subscribes the authenticated user profile to the channel {channel-id}.

By default, the subscription is configured for all channel events (see Subscription Type for more information).

Prerequisites

  • Channel {channel-id} must exist

Request

Query Parameters

Parameter Required Format Default Value Description
allMembers No Boolean false Whether or not to subscribe the workspace to channel events, enabling notifications for all members by default (applicable for the workspace owner only)

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/channels/776f1b0a-eda0-415e-83be-4284cabc9350/subscriptions' -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/channels/776f1b0a-eda0-415e-83be-4284cabc9350/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "2a3a2bc3-65b3-4190-aecc-413c882801da",
  "created" : "2023-03-23T21:55:08.575178892",
  "lastModified" : "2023-03-23T21:55:08.575179392",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da"
    },
    "delete subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://catalog.matatika.com/api/channels/776f1b0a-eda0-415e-83be-4284cabc9350"
    }
  }
}

Subscribe to a dataset

POST

/api/datasets/{dataset-id}/subscriptions

Subscribes the authenticated user profile to the dataset {dataset-id}.

By default, the subscription is configured for all dataset events (see Subscription Type for more information).

Prerequisites

  • Dataset {dataset-id} must exist

Request

Query Parameters

Parameter Required Format Default Value Description
allMembers No Boolean false Whether or not to subscribe the workspace to dataset events, enabling notifications for all members by default (applicable for the workspace owner only)

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/c1d20c15-d387-419b-ae98-43905f0051cc/subscriptions' -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/c1d20c15-d387-419b-ae98-43905f0051cc/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "01eb2b56-8b71-4f6b-891b-ea7d8f962d1c",
  "created" : "2023-03-23T21:55:09.584797565",
  "lastModified" : "2023-03-23T21:55:09.584798065",
  "type" : "ALL",
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel"
    },
    "dataset" : {
      "id" : "c1d20c15-d387-419b-ae98-43905f0051cc",
      "published" : "2023-03-23T21:55:07.662305",
      "alias" : "simple-bar-chart",
      "workspaceId" : "8810dae9-41f9-4dd1-87ac-56a097f1caa4",
      "source" : "matatika-limited",
      "title" : "How many people have visited our website?",
      "description" : "# Some Markdown\n- point 1\n- point 2\n- point 3\n",
      "questions" : "[''This is my question'', ''this is second question'']",
      "visualisation" : "{\"google-chart\": {\"chartType\": \"BarChart\",\"options\": {\"title\": \"Website visitors\"}}}",
      "query" : "SELECT to_char(date(report_date),'YYYYMM') as year_month, SUM(sessions) \n   FROM\n     \"google_analytics_website_overview\"\n   WHERE\n     \"google_analytics_website_overview\".\"report_date\" >= DATE(NOW()) - INTERVAL '365 DAY'\n   GROUP BY year_month\n   ORDER BY year_month ASC;",
      "likeCount" : 0,
      "likedByProfiles" : [ ],
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2023-03-23T21:55:07.662305",
      "score" : 1.0
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/01eb2b56-8b71-4f6b-891b-ea7d8f962d1c"
    },
    "delete subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/01eb2b56-8b71-4f6b-891b-ea7d8f962d1c",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/01eb2b56-8b71-4f6b-891b-ea7d8f962d1c",
      "type" : "PUT"
    },
    "dataset" : {
      "href" : "https://catalog.matatika.com/api/datasets/c1d20c15-d387-419b-ae98-43905f0051cc"
    }
  }
}

Subscribe to a pipeline

POST

/api/pipelines/{pipeline-id}/subscriptions

Subscribes the authenticated user profile to the pipeline {pipeline-id}.

By default, the subscription is configured for all pipeline events (see Subscription Type for more information).

Prerequisites

  • Pipeline {pipeline-id} must exist

Request

Query Parameters

Parameter Required Format Default Value Description
allMembers No Boolean false Whether or not to subscribe the workspace to pipeline events, enabling notifications for all members by default (applicable for the workspace owner only)

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/pipelines/15aeadc9-626e-472d-a43c-1742e29c9e7f/subscriptions' -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/pipelines/15aeadc9-626e-472d-a43c-1742e29c9e7f/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "34d79d83-3de2-4574-b642-a0b671dd905f",
  "created" : "2023-03-23T21:55:15.914903588",
  "lastModified" : "2023-03-23T21:55:15.914904088",
  "type" : "ALL",
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel"
    },
    "pipeline" : {
      "id" : "15aeadc9-626e-472d-a43c-1742e29c9e7f",
      "name" : "SIT-generated pipeline",
      "lastModified" : "2023-03-23T21:55:10.347777"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/34d79d83-3de2-4574-b642-a0b671dd905f"
    },
    "delete subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/34d79d83-3de2-4574-b642-a0b671dd905f",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/34d79d83-3de2-4574-b642-a0b671dd905f",
      "type" : "PUT"
    },
    "pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/15aeadc9-626e-472d-a43c-1742e29c9e7f"
    }
  }
}

Update a subscription

PUT

/api/subscriptions/{subscription-id}

Updates the subscription {subscription-id}.

Prerequisites

  • Subscription {subscription-id} must exist

Request

Body

Path Type Format Description
type String Subscription Type The type of subscription 
{
  "type" : "ALERTS"
}

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/hal+json; charset=ISO-8859-1' \
    -d '{
  "type" : "ALERTS"
}'
  • Python (requests)
import requests

url = "https://catalog.matatika.com:443/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da"

data = {
  "type" : "ALERTS"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "2a3a2bc3-65b3-4190-aecc-413c882801da",
  "created" : "2023-03-23T21:55:08.575179",
  "lastModified" : "2023-03-23T21:55:08.884050956",
  "type" : "ALERTS",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da"
    },
    "delete subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://catalog.matatika.com/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://catalog.matatika.com/api/channels/776f1b0a-eda0-415e-83be-4284cabc9350"
    }
  }
}

Remove a subscription

DELETE

/api/subscriptions/{subscription-id}

Removes the subscription {subscription-id}.

Prerequisites

  • Subscription {subscription-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da' -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/subscriptions/2a3a2bc3-65b3-4190-aecc-413c882801da"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.