通知の操作

logo cloud active logo hybrid disabled logo server disabled logo pcf disabled

このドキュメントでは、CloudHub API のコールについて説明します。Runtime Manager UI を使用してこれと同じタスクをより容易に実行する手順については、CloudHub とその下位ページを参照してください。

通知 API では、通知をリストしたり、作成したり、既読としてマークしたりできます。種別を返すか受け入れるすべてのリソースまたはメソッドでは、アプリケーション JSON 種別が使用されます (特に注意書きがある場合を除く)。例として、通知リソースからどのような結果が返されるのかを以下に示します。

アラートと通知は、現在 CloudHub ワーカーにデプロイされたアプリケーションでのみ使用可能な機能です。Runtime Manager からローカルサーバにデプロイするアプリケーションでは使用できません。詳細は、「デプロイ戦略」を参照してください。
{
"data":
  [
    {
      "domain" : "myapp",
      "username" : "joecloud",
      "priority" : "INFO",
      "message" : "Something happened",
      "createdAt" : "2015-05-10T23:42:53.010Z",
      "read" : false,
      "readOn" : "2015-02-12T19:51:34.428Z",
      "href" : "https://prod.anypoint.mulesoft.com/cloudhub/api/notifications/518d85fde4b00795a6ec3394"},
      "transactionId": "2a097804-f0d5-11e2-b4d2-9dd46521a02d",
      "properties": {
         "recordId" : "1234"
      }
  ],
  "total": 1
}

通知オブジェクトのプロパティ

アプリケーションのプロパティには、次のものがあります。

プロパティ 説明

createdAt

通知が作成された ISO8601 形式の時刻。

ドメイン

通知が関連付けられているアプリケーション (ある場合)。

href

通知の URL。これは、通知の状況を更新するための URL として使用できます。

メッセージ

通知メッセージ。

priority (優先度)

優先度 - INFO (情報)、WARN (警告)、ERROR (エラー)

properties

この通知に関連付けられているカスタムプロパティのマップ。これらは、通知を作成するときにアプリケーションによって指定されます。

read

通知が既読になったかどうか。

readOn

通知が既読になった ISO8601 形式の時刻。

tenantId

通知に関連付けられているテナントの ID。

transactionId

この通知に関連付けられているトランザクションの ID。

username (ユーザ名)

通知を作成したユーザ。

通知の操作

通知関連の操作の概要を次に示します。

操作 リソース 説明

GET

/api/notifications

すべてのアプリケーションの通知をリストします。

/api/notifications

新しい通知を作成します。

PUT

/api/notifications

すべての通知を既読としてマークします。

PUT

/api/notifications/{id}

通知の状況を更新します。

サポートされているすべてのリソース、メソッド、必須プロパティ、想定される応答の対話型リファレンスを参照するには、CloudHub API の API Portal を確認してください。

API Portal で、他の Mule API の中から CloudHub API を検索し、その最新バージョンにアクセスします。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub