API v1 - Notice

The Notice API endpoint can be used to create and retrieve the data associated with the notices available in your Matillion ETL instance.

Notices are stored in the tabs at the bottom-right of your Matillion ETL instance. The 'Notices' tab will display any important messages regarding your instance, and can be automatically populated by Matillion ETL where problems are found.

Prerequisites

To use Matillion ETL API services, you must know how to make REST API calls, either by employing a REST API GUI client such as Postman, or employing a command line interface (CLI) like cURL.
If you are new to Matillion ETL's API, read our Matillion API introduction and explore the v1 API map.
Matillion ETL API endpoints require authorization to make any REST API call, so ensure a username and password for the Matillion ETL instance is configured before making any API call.

Using the API

Returns the notices in your Matillion ETL instance by making a GET call with the form:

<InstanceAddress>/rest/v1/notice/<endpoint>

Note

<InstanceAddress>/rest/v1/notice/ is the base URI for the Notice API endpoints. Add the specific <endpoint> information for each function, documented in the below sections.

Where:

<InstanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.
<endpoint> is the name of the API endpoint that accomplishes the task you want to perform. These endpoints are documented in the following sections.

GET notice

Returns the list of notice IDs in your Matillion ETL instance.

To return the notices, make the following GET call:

<InstanceAddress>/rest/v1/notice/

Where <InstanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.

A successful GET call to the endpoint will return the following response from the server, in JSON format:

{
    "mtln-cdc-queue-error",
    "123453",
    "mtln-sqs-error",
    "12345",
    "12343",
    "12346"
}

POST notice create

Creates a server-side notice in your Matillion ETL instance.

To create a notice, make the following POST call:

<InstanceAddress>/rest/v1/notice/create

Where <InstanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.

The POST body should contain the following, in JSON format:

{
   "title":"MyNoticeTitle",
   "details": "YourNoticeMessage",
   "id": "12345",
   "level":"INFO",
   "dismissable":true
}

<title>: The title of the created notice.
<details>: The notice message.
<id>: The unique, numeric ID associated with the notice.
<level>: The type of notice you want to send. It can either be "INFO" or "WARNING".
<dismissable>: This can be true or false.

A successful POST call to the endpoint will return the following response from the server, in JSON format:

{
  "success": true,
  "msg": "Successfully created a new Notice with the ID [12345].",
  "id": 0
}

GET notice ID

Retrieve notice information using the associated ID.

To retrieve notice information via the id, make the following GET call:

<InstanceAddress>/rest/v1/notice/id/<id>/get

Where:

<InstanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.
<id> is the unique, numeric ID associated with the notice. The ID is returned by GET notice.

A successful GET call to the endpoint will return the following response from the server, in JSON format:

{
  "noticeID": "12345",
  "origin": "SERVER",
  "level": "INFO",
  "title": "MyNoticeTitle",
  "issuedTime": 1592561202824,
  "details": "YourNoticeMessage",
  "dismissable": true
}

POST notice ID delete

Delete the intended notice using the associated ID.

To delete the notice, make the following POST call:

<InstanceAddress>/rest/v1/notice/id/<id>/delete

Where:

<InstanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.
<id> is the unique, numeric ID associated with the notice.

A successful POST call to the endpoint will return the following response from the server, in JSON format:

{
  "success": true,
  "msg": "Successfully deleted the Notice with the ID [12345].",
  "id": 0
}

Note

You can also use the following DELETE call http://<InstanceAddress>/rest/v1/notice/id/<id> to remove a notice using its associated ID from your Matillion ETL instance.