アラート

現在認証されているユーザーのアプリ内アラート通知を取得します。

API エンドポイント

GET {accessURL}/{organizationName}/notificationservice_/notificationserviceapi/odata/v1/Alerts

すべてのエンドポイント パスの {accessURL} は、ご使用のクラウド プラットフォームのベース URL に置き換えてください。

Cloud Platform	アクセス URL
Test Cloud	https://cloud.uipath.com/
Test Cloud (公共部門向け)	https://govcloud.uipath.us/
Test Cloud (専有型)	https://{customURL}.dedicated.uipath.com/

要求ヘッダー

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

クエリ パラメーター

エンドポイントは、アラート コレクションで標準の OData クエリ オプションをサポートしています。

1. $filter: アラートをフィルター処理します。

   例: ?$filter=Severity eq 'High'

2. $orderby: アラートを並べ替えます。

   例: ?$orderby=CreationTime desc

3. $top: 返される結果の数を制限します。

   例: ?$top=50

4. $skip: いくつかの結果 (ページング) をスキップします。

   例: ?$skip=50&$top=50

5. $count: 項目の合計数を要求します。

   注:

   有効なブール リテラル ( "true" または "false") である必要があります。

フィルター例

次のフィルターの例をご覧ください。

1. コンポーネント別: ?$filter=component eq 'Process'

2. 既読ステート (未読のみ): ?$filter=component eq 'Process' and state eq 'Unread'。

3. 重大度別: severity フィールドは列挙型です。severityでの等価比較のみがサポートされています。以下に例を示します。

   • severity eq 'Warning'
   • severity in ('Info','Warning')

   severityでの不等式 (ne) と範囲比較 (gt、ge、 の lt、le) はサポートされていないため、$filter式では使用できません。

   例: ?$filter=component eq 'Process' and severity eq 'Warning'

4. 時間範囲別: ?$filter=component eq 'Process' and creationTime ge 2025-01-01T00:00:00Z and creationTime lt 2025-02-01T00:00:00Z

5. アラート メッセージまたはコンテキスト内の検索 (data): ?$filter=component eq 'Process' and contains(data,'Timeout')

応答

200 OK

認証されたユーザーのアプリ内アラート通知が正常に取得されました。

400 Bad Request

• 無効な OData クエリ、特に無効な $count 値 (ブール値以外) です。
• 応答本文は標準の JSON エラー オブジェクトであり、invalid count クエリ オプションを示すメッセージが表示されます。

401 未承認

ベアラー トークンが見つからないか、無効です。

403 Forbidden

トークンは有効ですが、 UserContext ポリシーまたは必要な権限を満たしていません。

5xxサーバーエラー

予期しないサーバー側の障害。

要求の例

要求:

curl --location --request GET \
  'https://cloud.uipath.com/{organizationName}/notificationservice_/notificationserviceapi/odata/v1/Alerts?$top=50&$skip=0&$orderby=creationTime desc&$count=true' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Accept: application/json'

応答:

{
  "value": [
    {
      "id": "<identifier>",
      "notificationName": "Robot.StatusChanged.NotResponding",
      "data": "{\"robotId\": 123, \"machineName\": \"<machineName>\"}",
      "component": "Orchestrator",
      "severity": "Warning",
      "creationTime": "2025-01-01T12:34:56Z",
      "state": "Unread",
      "userNotificationId": "<userNotificationId>",
      "deepLinkRelativeUrl": "/alerts/deeplink/robot-not-responding?robotId=123"
    }
  ],
  "@odata.count": 1
}