SIGNL4 - Mobile Alerting (プレビュー)

  • リファレンス

SIGNL4 は、重要なインフラストラクチャを運用するための重要なモバイル アラート、インシデント対応、サービス ディスパッチを提供します。 追跡、エスカレーション、コラボレーション、業務計画など、アプリのプッシュ、SMS テキストおよび音声通話を通じて継続的に警告します。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Derdack GmbH
[URL] https://www.signl4.com/feedback-we-love-hear-from-you/
メール success@signl4.com
Connector Metadata
発行者 Derdack
Web サイト https://www.signl4.com
プライバシー ポリシー https://www.signl4.com/privacy-policy/
カテゴリー IT オペレーション; コミュニケーション

SIGNL4 は、重要なインフラストラクチャを運用するための重要なアラート、インシデント対応、サービス ディスパッチを提供します。 追跡、エスカレーション、コラボレーション、業務計画など、アプリのプッシュ、SMS テキストおよび音声通話を通じて継続的に警告します。

SIGNL4 をフローに統合して、必要なときにいつでも信頼できるチーム アラートを送信できます。

前提条件

SIGNL4 のアカウントが必要です。 まだお持ちでない場合は、https://connect.signl4.com/ から入手できます 。 Google Playストア または Apple App Store からモバイル アプリを直接ダウンロードすることもできます。

資格情報の入手方法

このコネクタを使用するには、SIGNL4 API キーが必要です。 SIGNL4 Web ポータルで、「統合 -> APIキー」で API キーを取得します。 その後、API キーを使用して SIGNL4 コネクタを Power Automateで認証できます。

コネクタの使用を開始する

SIGNL4 API 関数の詳細な説明は、 こちら でご覧いただけます。 SIGNL4 コネクタを Power Automate フローに追加した後、 SIGNL4 API キーを取得する必要があります。 その後、それに応じて API 関数を使用できるようになります。 さらにご質問がある場合は、お気軽に SIGNL4 チームにお問い合わせください。

最も簡単な方法は、EventsSend アクションを使用してアラートを送信することです:

  • まず、SIGNL4 Web ポータルから SIGNL4 チーム シークレット / 統合シークレットを取得します。
  • チーム シークレット/統合シークレットを持っている場合、これを関数 EventsSend で使用して、チームにアラートを生成できるイベントをトリガーできます。 タイトルとメッセージを入力するだけです。 他のパラメータの説明は、インバウンド Webhook ドキュメント ページ でご覧いただけます。
  • これでイベントがトリガーされ、SIGNL4 でアラートを受信できます。

既知の問題と制限事項

SIGNL4 の Power Automate コネクタは、SIGNL4 REST API 2.0 全体をカプセル化します。 一部の機能は SIGNL4 プラン によって異なります。

一般的なエラーと解決策

N/A

よくあるご質問

SIGNL4 FAQ とオンライン ヘルプは こちら でご覧いただけます。 また、包括的な ビデオ ライブラリ も利用できます。

接続を作成する

このコネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
API キー securestring この API の API キー True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

1 つまたは複数のチームからイベントソースを取得する

1 つまたは複数のチームからイベントソースを取得します。
ID で Webhook を削除する

指定された Webhook を削除して、通知されなくなるようにします。
ID で Webhook を取得する

渡された ID で指定された Webhook の情報を返します。
ID で Webhook を更新する

指定された webhook を更新します。
ID でイベントソースを取得

ID でイベントソースを取得します。
ID でユーザーを取得する

メールアドレスや勤務先情報などの詳細を含むユーザー オブジェクトを返します。
ID によってインベントリ スクリプトを返す

渡されたスクリプト IDで 指定されたスクリプトを取得します。
SIGNL4 チームに新しいスクリプト インスタンスを作成する

リクエスト本文で指定されたスクリプトの新しいスクリプト インスタンスを作成します。
SIGNL4 チームのすべてのスクリプト インスタンスを返す

サブスクリプション内のすべてのスクリプト インスタンスを返します。
WebHook を有効にする機能

WebHook を有効にする機能です。
WebHook を無効にする機能

WebHook を無効にする機能です。
Webhooks の取得

システム内に定義されているアウトバウンド Webhook のコレクションを返します。
あるチームから別のチームへ休日をコピーする

あるチームから別のチームへ休日をコピーします。
すべてのアラート カテゴリの画像の名前を取得する

すべてのアラート カテゴリの画像の名前を取得します。 画像は account.signl4.com/images/alerts/categoryImageName.svg から入手できます。
すべてのインベントリ スクリプトを返す

すべてのインベントリ スクリプトを返します。
すべてのカテゴリの指標を取得する

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics
すべてのカテゴリを取得する

すべてのカテゴリを取得します。
すべてのカテゴリを取得する

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
すべてのチームの情報を取得

すべてのチームの情報を取得します。
すべてのユーザーの取得

メールアドレスや勤務先情報などの詳細を含むユーザー オブジェクトのリストを返します。 アクセス権のあるユーザーのみが返されます。
アクションの削除を返す

サンプル要求:

GET /RemoteActions/{actionId}
アラート タイムライン エントリを取得する

ID によってアラートのアラート タイムライン エントリを取得します。
アラート レポートの取得

さまざまな期間に発生したアラートの数に関する情報と、チーム メンバーの応答動作 (確認済みおよび未処理のアラート数) に関する情報を返します。
アラート レポートを返す

アラート レポートを返します。
アラートに注釈を付ける

指定された注釈情報によってアラートに注釈を付けます。
アラートののクローズを取り消す

このメソッドは、アラートのクローズを取り消しようとします。
アラートのトリガー

チームに新しいアラートをトリガーします。 勤務中のすべてのチーム メンバーはアラート通知を受け取ります。
アラートの取得

ID でアラートを取得する。
アラートの承認

アラートを承認します。
アラートの承認を取り消す

このメソッドは、アラートの確認を取り消しようとします。
アラートの添付ファイル情報を取得する

アラートの添付ファイルを ID で取得します。
アラートの詳細を取得する

アラートの詳細を取得します。
アラートをチームに手動でエスカレーションする

アラートをチームに手動でエスカレーションします。
アラート通知の取得

アラート ID によってすべてのユーザーの通知を取得します。
イベント パラメーターの取得

イベントのパラメータをidで取得します。
イベントの詳細を取得する

イベントの詳細を取得します。
イベントを送信する

イベントを送信します。
イベントソースの作成

イベント ソースを作成します。
イベントソースの削除

イベントソースを削除します。
イベント概要の取得

ID で概要イベントを取得します。
イベント配信の削除

イベント配信を削除します。
ウェブフックの作成

特定のイベントが発生したときに通知される新しい送信 Webhook を作成します。
カテゴリー購読の取得

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
カテゴリー購読の設定

サンプル要求:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
サブスクリプション プロファイルの更新

サブスクリプション プロファイルを更新します。
サブスクリプションから既存のコールアウト テンプレートを削除する

サブスクリプションから既存のコールアウト テンプレートを削除します。
サブスクリプションから既存のコールアウト テンプレートを更新する

サブスクリプションから既存のコールアウト テンプレートを更新します。
サブスクリプションのすべてのチームの情報を取得する

サブスクリプションのすべてのチームの情報を取得します。
サブスクリプションのチャンネル価格情報を返す

サブスクリプションのチャンネル価格情報を返します
サブスクリプションのユーザー ライセンスを取得する

サブスクリプションのユーザー ライセンスを取得します。
サブスクリプションの現在のプリペイド トランザクションを取得する

サブスクリプションの現在のプリペイド トランザクションを取得します。
サブスクリプションの現在のプリペイド トランザクションを取得する

サブスクリプションの現在のプリペイド トランザクションを取得します。
サブスクリプションの現在のプリペイド残高を取得する

サブスクリプションの現在のプリペイド残高を取得します。
サブスクリプションの現在のプリペイド残高を取得する

サブスクリプションの現在のプリペイド残高を取得します。
サブスクリプションの現在のプリペイド設定を取得する

サブスクリプションの現在のプリペイド設定を取得します。
サブスクリプションの現在のプリペイド設定を取得する

サブスクリプションの現在のプリペイド設定を取得します。
サブスクリプションの現在のプリペイド設定を更新する

サブスクリプションの現在のプリペイド設定を更新します。
サブスクリプションの現在のプリペイド設定を更新する

サブスクリプションの現在のプリペイド設定を更新します。
サブスクリプションの音声番号ライセンスを取得します

サブスクリプションの音声番号ライセンスを取得します。
サブスクリプション内のすべてのチームに関する公開情報を取得する

サブスクリプション内のすべてのチームに関する公開情報を取得します。
サブスクリプション用のすべてのコールアウト テンプレートを取得する

サブスクリプション用のすべてのコールアウト テンプレートを取得します。
サブスクリプション用の新しいコールアウト テンプレートを作成する

サブスクリプション用の新しいコールアウト テンプレートを作成します。
ジャーナルからページングされたリモートジョブを返す

サンプル要求:

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}
ジャーナルからリモート ジョブを返します

サンプル要求:

GET /remoteActions/journal/{jobId}
スクリプト インスタンスの削除

渡されたインスタンス ID で指定されたスクリプト インスタンスを取得します。
スクリプト インスタンスの有効化

スクリプト インスタンスを有効化します。
ダウンロード可能なアラート レポートに関する情報を取得する

ダウンロード可能なアラート レポートに関する情報を取得します。
チームからすべてのアラート パターンを取得する

チームからすべてのアラート パターンを取得します。
チームからユーザーまたは招待を削除する

チームからユーザーまたは招待を削除します
チームごとにチームメンバーシップを取得する

チームごとにチームメンバーシップを取得します。
チームのチームプライバシー設定の更新

チームのチームプライバシー設定を更新します。
チームのチームプライバシー設定を取得する

チームのチームプライバシー設定を取得します。
チームのチームプロフィールを更新します

チームのチームプロフィールを更新します。
チームの休暇を取得する

チームの休暇を取得します。
チームの休暇を確保する

チームの休暇を確保します。
チームの繰り返される休暇を保存する

チームの繰り返される休暇を保存します。
チームの職務アシスタント情報を取得する

チームの職務アシスタント情報を取得します。
パターンのタイムスロットを検証する

パターンのタイム スロットを、他のパターンの既存のすべてのタイム スロットと比較して検証します。
ページングされたアラートの取得

ページングされたアラートを取得します。
ページングされた概要イベントを取得する

ページングされた概要イベントを取得します。 さらに結果がある場合は、イベント フィルターに追加できる継続トークンも取得します。
ユーザー アカウントの削除

ユーザー アカウントを削除します。
ユーザーIDによる職務状況の取得

義務情報を含むオブジェクトを返します。
ユーザーからチームメンバーシップを取得する

ユーザーからチームメンバーシップを取得します。
ユーザーから連絡先アドレスを削除する

ユーザーから連絡先アドレスを削除します。
ユーザーが所属するすべてのチームを取得する

チーム オブジェクトのリストを、名前などの詳細とともに返します。 ユーザーがメンバーであるチームのみが返されます。
ユーザーが提供された権限を持っているかどうかを確認する

ユーザーが提供された権限を持っているかどうかを確認します。
ユーザーに対して以前に作成された電話番号を検証する

ユーザーに対して以前に作成された電話番号を検証します。
ユーザーのチームメンバーシップを更新する

ユーザーのチームメンバーシップを更新します。 ユーザーをサブスクリプション内の別のチームに移動したり、ユーザーのロールを変更したりできます。
ユーザーのパスワードを更新する

ユーザーのパスワードを更新します。
ユーザーのユーザープロファイルを更新する

ユーザーのユーザープロファイルを更新します。
ユーザーのロケール情報 (言語、タイムゾーンなど) の更新

ユーザーのロケール情報 (言語、タイムゾーンなど) を更新します。
ユーザーの所在地設定

ユーザーの所在地を設定します。
ユーザーの通知プロファイルを取得する

ユーザーの通知プロファイルを取得します。
ユーザーの通知プロファイルを設定

ユーザーの通知プロファイルを設定します。
ユーザーの電話番号を削除

ユーザーの電話番号を削除します。 別の電話番号を登録すると上書きされます。
ユーザーの電話番号を削除する

ユーザーの電話番号を削除します。
ユーザーをチームに招待する

ユーザーをチームに招待します。
ユーザーをチームに追加する

ユーザーをチームに追加します。
ユーザーをマネージャーとしてパンチインする

指定されたユーザーはマネージャーとして勤務します。
ユーザーを勤務終了に設定

指定されたユーザーが勤務終了に設定されます。
ユーザーを勤務開始に設定

指定されたユーザーが勤務開始に設定されます。
リモート アクションの削除

サンプル要求:

DELETE /eaRemoteActions/{actionId}
リモート アクションの更新

サンプル要求:

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}
リモートアクションを返す

サンプル要求:

GET /RemoteActions?externalId=12345
予定されているすべてのスケジュールに関する情報を返す

予定されているすべてのスケジュールに関する情報を返します。
休日の削除

休日を削除します。
個人ユーザー画像の削除

個人ユーザー画像を削除します。
個人ユーザー画像の取得

個人ユーザー画像を取得します。
利用可能なすべてのインベントリ スクリプトを返します

SIGNL4 サブスクリプションに追加できる、利用可能なすべてのインベントリ スクリプトを返します。
利用可能なすべての定義を取得する

利用可能なすべての定義を取得します。
利用可能なすべての管理対象サブスクリプションの情報を取得する

利用可能なすべての管理対象サブスクリプションの情報を取得します。
定義を取得する

定義を取得します。
招待が存在する場合に招待メールを再送信する

招待が存在する場合は招待メールを再度送信します。
指定された ID の勤務表情報を返す

指定された ID の勤務表情報を返します。
指定されたアラートの指定された添付ファイルを取得する

指定されたアラートの指定された添付ファイルを取得します。
指定されたサブスクリプションの機能を返す

指定されたサブスクリプションの機能を返します。
指定されたスクリプト インスタンスに関するすべての情報を返す

渡されたインスタンス ID で指定されたスクリプト インスタンスを取得します。
指定されたスクリプト インスタンスを更新する

指定されたスクリプト インスタンスを更新します。通常は、スクリプトの構成を更新するために使用されます。
指定されたスクリプト インスタンスを無効にする

指定されたスクリプト インスタンスを無効にします。
指定された勤務スケジュールを作成または更新する

指定された勤務スケジュールを作成または更新します。
指定したチームのすべてのユーザーを取得する

指定したチームのすべてのユーザーを取得します。
指定したチームのプロフィール画像のアップロード

指定したチームのプロフィール画像をアップロードします。
指定したチームの画像を取得する

指定したチームの画像を取得します。
指定したユーザーにメールを送信する

ユーザーのチームのすべてのイベント ソースの情報を含むメールを指定したユーザーに送信します。
指定したユーザーのプロフィール画像をアップロードする

指定したユーザーのプロフィール画像をアップロードします。
新しいアラート パターンを作成する

新しいアラート パターンを作成します。
新しいカテゴリを作成します

サンプル要求:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}
新しいリモート アクションを作成する

サンプル要求:

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}
新しいリモート ジョブを作成する

サンプル要求:

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}
既存のアラート パターンを更新する

既存のアラート パターンを更新します。
既存のイベント ソースを更新する

既存のイベント ソースを更新します。
既存のカテゴリの削除

サンプル要求:

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
既存のカテゴリの更新

サンプル要求:

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}
特定のアラート パターンを削除する

特定のアラート パターンを削除します。
特定のカテゴリのメトリクスを取得する

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics
特定のカテゴリを取得

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
特定のサブスクリプションの情報を取得する

特定のサブスクリプションの情報を取得します。
特定のチームのアラート設定

特定のチームのアラートを設定します。
特定のチームのアラート設定を取得する

特定のチームのアラート設定を取得します。
特定のチームのアラート設定を取得する

特定のチームのアラート設定を取得します。
特定のチームのイベント ソースを取得する

特定のチームのイベント ソースを取得します。
特定のチームのセットアップ進行状況を取得する

特定のチームのセットアップ進行状況を取得します。
特定のチームの情報を取得する

特定のチームの情報を取得します。
特定のファイル名で関税レポートをダウンロードする

特定のファイル名で関税レポートをダウンロードします。
特定のユーザーのセットアップ進行状況を取得する

特定のチームのセットアップ進行状況を取得します。
特定の職務を削除する

特定の職務を削除します。
現在のチームイメージを削除する

現在のチームイメージを削除します。
確認済みのアラートをすべて閉じる

このメソッドは、チームが現在持っているすべての確認済みのアラートを閉じます。
範囲内の勤務スケジュールを削除する

範囲内の勤務スケジュールを削除します。
表示されているすべてのアラートを確認します

このメソッドは、チームが現在持っている、特定のユーザーによる未処理のアラートをすべて確認します。
表示名 を含む、指定されたスクリプト インスタンスのカスタム データを更新する

指定されたスクリプト インスタンスを更新します。
複数のアラートの終了を取り消す

このメソッドは、複数のアラート閉鎖を元に戻そうとします。 操作はバックグラウンドで処理されます。
複数のアラートを承認する

このメソッドは、提供されたすべてのアラートを確認します。
複数のアラートを閉じる

このメソッドは、提供されたすべてのアラートを閉じます。
複数のスケジュールを保存

複数のスケジュールを保存します。 必要に応じて、既存のスケジュールを上書きできます。
複数のチームのチーム任務設定を取得する

複数のチームのチーム任務設定を取得します。
複数の確認応答をキューに取り消す

このメソッドは、キューを介して複数のアラートの確認の取り消をしようとします。 操作はバックグラウンドで処理されます。
通知を閉じる

通知を閉じます。

1 つまたは複数のチームからイベントソースを取得する

操作 ID:
EventSourcesGet

1 つまたは複数のチームからイベントソースを取得します。

パラメーター

名前 キー 必須 型 説明
チームの ID
 teamId array

イベント ソースの取得元のチーム ID です。 チームIDを追加しない場合は、サブスクリプションからアクセスできるイベント ソースを取得します。
内部を含む
 includeInternal boolean

true の場合、内部イベント ソース タイプ (システム、マニュアル、API) が結果に含まれます。
Language
 language integer

  • 0 = EN
  • 1 = DE

戻り値

Body
MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

ID で Webhook を削除する

操作 ID:
WebhooksDelete

指定された Webhook を削除して、通知されなくなるようにします。

パラメーター

名前 キー 必須 型 説明
送信 Webhook ID
 webhookId True string

削除される送信 webhook の ID です。

ID で Webhook を取得する

操作 ID:
WebhooksGet

渡された ID で指定された Webhook の情報を返します。

パラメーター

名前 キー 必須 型 説明
送信 Webhook ID
 webhookId True string

取得する送信 Webhook の ID です。

戻り値

Body
WebhookInfo

ID で Webhook を更新する

操作 ID:
WebhooksUpdate

指定された webhook を更新します。

パラメーター

名前 キー 必須 型 説明
送信 Webhook ID
 webhookId True string

更新する送信 Webhook の ID です。
description
 description string
extUrl
 extUrl True string
名称
 name True string
teamId
 teamId string

戻り値

Body
WebhookInfo

ID でイベントソースを取得

操作 ID:
EventSourcesGetById

ID でイベントソースを取得します。

パラメーター

名前 キー 必須 型 説明
イベント ソース ID
 eventSourceId True string

イベントソースの ID です。
Language
 language integer

  • 0 = EN
  • 1 = DE

戻り値

Body
EventSourceEndpointInfo

ID でユーザーを取得する

操作 ID:
UsersGet

メールアドレスや勤務先情報などの詳細を含むユーザー オブジェクトを返します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

取得するユーザーの識別子。 「Me」を使用して、現在ログインしているユーザーに関する情報を取得する。 API キーではこれは不可能です。 チーム内のユーザーのメール アドレス、または対応するユーザー オブジェクトの一意の ID にすることもできます。

戻り値

Body
V2.UserDetails

ID によってインベントリ スクリプトを返す

操作 ID:
ScriptsGet

渡されたスクリプト IDで 指定されたスクリプトを取得します。

パラメーター

名前 キー 必須 型 説明
スクリプト ID
 scriptId True string

返されるスクリプトの ID です。
Language
 language string

Language

戻り値

Body
ScriptInstanceDetails

SIGNL4 チームに新しいスクリプト インスタンスを作成する

操作 ID:
ScriptsCreate

リクエスト本文で指定されたスクリプトの新しいスクリプト インスタンスを作成します。

パラメーター

名前 キー 必須 型 説明
構成
 config
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
enabled
 enabled boolean
instanceId
 instanceId string
scriptId
 scriptId string
scriptName
 scriptName string
sharedTeams
 sharedTeams array of string
teamId
 teamId string

戻り値

Body
ScriptInstanceDetails

SIGNL4 チームのすべてのスクリプト インスタンスを返す

操作 ID:
ScriptsGetAll

サブスクリプション内のすべてのスクリプト インスタンスを返します。

パラメーター

名前 キー 必須 型 説明
チームの ID
 teamId array

チームの ID です。
変更日
 modifiedSince date-time

変更日です。

戻り値

返答
array of ScriptInstanceInfo

WebHook を有効にする機能

操作 ID:
WebhooksDisable

WebHook を有効にする機能です。

パラメーター

名前 キー 必須 型 説明
Webhook ID
 webhookId True string

無効にする必要がある Webhook の Webhook ID です。

戻り値

Body
WebhookInfo

WebHook を無効にする機能

操作 ID:
WebhooksEnable

WebHook を無効にする機能です。

パラメーター

名前 キー 必須 型 説明
Webhook ID
 webhookId True string

有効にする必要がある Webhook の Webhook ID です。

戻り値

Body
WebhookInfo

Webhooks の取得

操作 ID:
WebhooksGetAll

システム内に定義されているアウトバウンド Webhook のコレクションを返します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId string

チームの ID です。

戻り値

返答
array of WebhookInfo

あるチームから別のチームへ休日をコピーする

操作 ID:
TeamsCopyHolidays

あるチームから別のチームへ休日をコピーします。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

休日をコピーするチームのチーム ID
Year
 year True integer

コピーする年
チーム ID
 sourceTeamId True string

休日のコピー元のチームのチーム ID

戻り値

Body
V2.TeamHolidayDetails

すべてのアラート カテゴリの画像の名前を取得する

操作 ID:
CategoriesGetImageNames

すべてのアラート カテゴリの画像の名前を取得します。 画像は account.signl4.com/images/alerts/categoryImageName.svg から入手できます。

戻り値

名前 パス 型 説明
array of string

すべてのインベントリ スクリプトを返す

操作 ID:
ScriptsGetAll76

すべてのインベントリ スクリプトを返します。

パラメーター

名前 キー 必須 型 説明
Language
 language string

Language

戻り値

返答
array of InventoryScriptInfo

すべてのカテゴリの指標を取得する

操作 ID:
CategoriesGetAllMetrics

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID

戻り値

返答
array of CategoryMetrics

すべてのカテゴリを取得する

操作 ID:
CategoriesGetAll

すべてのカテゴリを取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId array

チームの ID です。

戻り値

Body
MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

すべてのカテゴリを取得する

操作 ID:
CategoriesGetAllOfTeam

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID

戻り値

返答
array of CategoryInfo

すべてのチームの情報を取得

操作 ID:
TeamsGetAllInfo

すべてのチームの情報を取得します。

パラメーター

名前 キー 必須 型 説明
チームの ID
 teamId array

チームの ID

戻り値

返答
array of TeamInfo

すべてのユーザーの取得

操作 ID:
UsersGettAll

メールアドレスや勤務先情報などの詳細を含むユーザー オブジェクトのリストを返します。 アクセス権のあるユーザーのみが返されます。

戻り値

返答
array of V2.UserDetails

アクションの削除を返す

操作 ID:
RemoteActionsGet

サンプル要求:

GET /RemoteActions/{actionId}

パラメーター

名前 キー 必須 型 説明
Action ID
 actionId True string

返すアクションの ID
Language
 language integer

  • 0 = EN
  • 1 = DE

戻り値

Body
V2.RemoteActionDetails

アラート タイムライン エントリを取得する

操作 ID:
AlertsGetTimeline

ID によってアラートのアラート タイムライン エントリを取得します。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

要求されたアラートの ID です。
User ID
 userId string

ユーザー ID。

戻り値

名前 パス 型 説明
array of

アラート レポートの取得

操作 ID:
AlertsGetReport

さまざまな期間に発生したアラートの数に関する情報と、チーム メンバーの応答動作 (確認済みおよび未処理のアラート数) に関する情報を返します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId string

レポートが必要なユーザーのユーザー ID です。
チームの ID
 teamId array

レポートが必要なチームのチームの ID です。 チームの ID を設定しない場合は、アクセスできるすべてのチームのすべてのリソースを取得します。

戻り値

Body
MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

アラート レポートを返す

操作 ID:
TeamsGetAlertReport

アラート レポートを返します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

勤務報告ファイルの情報を取得するチームの ID です。
File Name
 fileName True string

ダウンロードするファイルのファイル名です。

戻り値

返答
binary

アラートに注釈を付ける

操作 ID:
AlertsAnnotate

指定された注釈情報によってアラートに注釈を付けます。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

注釈を付けるアラートの ID です。
text
 text string
タイプ
 type integer

  • 0 = なし
  • 1 = テキスト
  • 2 = 画像
userId
 userId string

戻り値

Body
V2.AlertAnnotationDetails

アラートののクローズを取り消す

操作 ID:
AlertsUndoClose

このメソッドは、アラートのクローズを取り消しようとします。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

通知 ID です。
descr
 descr string
uid
 uid True string

戻り値

Body
V2.AlertInfo

アラートのトリガー

操作 ID:
AlertsTrigger

チームに新しいアラートをトリガーします。 勤務中のすべてのチーム メンバーはアラート通知を受け取ります。

パラメーター

名前 キー 必須 型 説明
名称
 name string
注文
 order integer
タイプ
 type integer

  • 0 = なし
  • 1 = オブジェクト
  • 2 = 配列
  • 3 = コンストラクター
  • 4 = プロパティ
  • 5 = コメント
  • 6 = 整数
  • 7 = 浮動小数
  • 8 = 文字列
  • 9 = ブール値
  • 10 = Null
  • 11 = 未定義
  • 12 = 日付
  • 13 = 未加工
  • 14 = バイト
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
価値
 value string
コンテント
 content string
contentType
 contentType string
encoding
 encoding integer

  • 0 = なし
  • 1 = Base64
id
 id string
名称
 name string
category
 category string
externalId
 externalId string
フラグ
 flags integer

  • 0 = なし
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
重要度
 severity integer

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大
teamId
 teamId True string
text
 text True string
肩書き
 title True string

戻り値

Body
V2.AlertDetails

アラートの取得

操作 ID:
AlertsGet

ID でアラートを取得する。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

要求されたアラートの ID です。
User ID
 userId string

ユーザー ID。

戻り値

Body
V2.AlertInfo

アラートの承認

操作 ID:
AlertsAcknowledge

アラートを承認します。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

アラートの承認二使用する ID です。
descr
 descr string
uid
 uid True string

戻り値

Body
V2.AlertInfo

アラートの承認を取り消す

操作 ID:
AlertsUndoAck

このメソッドは、アラートの確認を取り消しようとします。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

通知 ID です。
descr
 descr string
uid
 uid True string

戻り値

Body
V2.AlertInfo

アラートの添付ファイル情報を取得する

操作 ID:
AlertsGetAttachmentInfo

アラートの添付ファイルを ID で取得します。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

要求されたアラートの ID です。

戻り値

返答
array of V2.AlertAttachmentInfo

アラートの詳細を取得する

操作 ID:
AlertsGetDetails

アラートの詳細を取得します。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

取得するアラートです。
User ID
 userId string

API が呼び出される動作を行うユーザーのユーザー ID です。 これは、アラートに関するフィルタリングの目的で使用されます。

戻り値

Body
V2.AlertDetails

アラートをチームに手動でエスカレーションする

操作 ID:
AlertsEscalateToTeam

アラートをチームに手動でエスカレーションします。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

エスカレーションするアラートのアラート ID です。
targetTeamId
 targetTeamId string
userId
 userId string

戻り値

返答
string

アラート通知の取得

操作 ID:
AlertsGetNotifications

アラート ID によってすべてのユーザーの通知を取得します。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

要求されたアラートの ID です。

戻り値

返答
array of AlertNotificationInfo

イベント パラメーターの取得

操作 ID:
EventsGetParameters

イベントのパラメータをidで取得します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 eventId True string

要求されたアラートのイベント ID です。

戻り値

返答
array of EventParameterInfo

イベントの詳細を取得する

操作 ID:
EventsGetDetails

イベントの詳細を取得します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 eventId True string

取得したいイベントのイベント ID

戻り値

Body
V2.EventDetails

イベントを送信する

操作 ID:
EventsSend

イベントを送信します。

パラメーター

名前 キー 必須 型 説明
チームのシークレット
 teamSecret True string

チームのシークレットです。
肩書き
 Title True string
Message
 Message True string
X-S4-サービス
 X-S4-Service string

X-S4-Service: : 指定された名前のサービス/システム カテゴリに Signl を割り当てます。
X-S4-Location
 X-S4-Location string

X-S4-Location: イベントとともに位置情報 (緯度、経度) を送信し、モバイル アプリに地図を表示します。
X-S4-AlertingScenario
 X-S4-AlertingScenario string

X-S4-AlertingScenario: このイベントが Signl をトリガーした場合、 SIGNL4 チームへの通知方法を制御できます。 サポートされている値は、single_ack、multi_ack、emergency です。
X-S4-ExternalID
 X-S4-ExternalID string

X-S4-ExternalID: イベントがサードパーティ システムのレコードから発生した場合、このパラメータを使用してそのレコードの一意の ID を渡します。 この ID は、SIGNL4 からのアウトバウンド・ウェブフック通知で通知され、そのレコードと Signl の相関/同期に最適です。
X-S4-Status
 X-S4-Status string

X-S4-Status: 外部 ID (X-S4-ExternalID) によって既存の Signl を解決したい場合は、このステータス パラメーターを追加できます。 可能な値は、new、acknowledged、resolved の 3 つです。
X-S4-Filtering
 X-S4-Filtering boolean

X-S4-Filtering: このイベントにイベント フィルタリングを適用するかどうかを true または false のブール値で指定します。 true に設定すると、サービスおよびシステム カテゴリの 1 つからのキーワードが少なくとも 1 つ含まれている場合 (つまり、ホワイトリストに登録されている場合)、イベントはチームへの通知のみをトリガーします。
外部 ID パラメーター
 ExtIdParam string

外部 ID パラメーターです。
外部のステータス パラメーター
 ExtStatusParam string

外部のステータス パラメーターです。
新しいステータス
 NewStatus string

新しいステータスです。
解決済みステータス パラメーター
 ResolvedStatus string

解決済みステータス パラメーターです。
Ack ステータス
 AckStatus string

Ack のステータスです。

戻り値

Body
OverviewEvent

イベントソースの作成

操作 ID:
EventSourcesCreate

イベント ソースを作成します。

パラメーター

名前 キー 必須 型 説明
description
 description string
無効
 disabled boolean
language
 language integer

  • 0 = EN
  • 1 = DE
名称
 name string
sharedTeams
 sharedTeams array of string
teamId
 teamId string
タイプ
 type integer

  • 0 = なし
  • 1 = 電子メール
  • 2 = Webhook

戻り値

Body
EventSourceEndpointInfo

イベントソースの削除

操作 ID:
EventSourcesDelete

イベントソースを削除します。

パラメーター

名前 キー 必須 型 説明
イベント ソース ID
 eventSourceId True string

イベントソースの ID

イベント概要の取得

操作 ID:
EventsGetOverview

ID で概要イベントを取得します。

パラメーター

名前 キー 必須 型 説明
イベント ID
 eventId True string

取得するイベントの ID です。

戻り値

Body
OverviewEvent

イベント配信の削除

操作 ID:
EventDistributionDelete

イベント配信を削除します。

パラメーター

名前 キー 必須 型 説明
イベント ソース ID
 distributionId True string

イベントソースの ID

ウェブフックの作成

操作 ID:
WebhooksCreate

特定のイベントが発生したときに通知される新しい送信 Webhook を作成します。

パラメーター

名前 キー 必須 型 説明
description
 description string
extUrl
 extUrl True string
名称
 name True string
teamId
 teamId string

戻り値

返答
string

カテゴリー購読の取得

操作 ID:
CategoriesGetSubscription

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID
Category ID
 categoryId True string

購読申し込みカテゴリー

戻り値

返答
array of CategorySubscriptionInfo

カテゴリー購読の設定

操作 ID:
CategoriesSetSubscription

サンプル要求:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID
Category ID
 categoryId True string

更新するカテゴリ
ステータス
 status True integer

  • 0 = サブスクライブ済み
  • 1 = ミュート済み
  • 2 = 非表示
userId
 userId True string

戻り値

返答
array of CategorySubscriptionInfo

サブスクリプション プロファイルの更新

操作 ID:
SubscriptionsUpdateProfile

サブスクリプション プロファイルを更新します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

更新するサブスクリプションの ID
名称
 name string

戻り値

Body
SubscriptionInfo

サブスクリプションから既存のコールアウト テンプレートを削除する

操作 ID:
CalloutsDeleteTemplate

サブスクリプションから既存のコールアウト テンプレートを削除します。

パラメーター

名前 キー 必須 型 説明
テンプレート ID
 templateId True string

テンプレートの ID です。

サブスクリプションから既存のコールアウト テンプレートを更新する

操作 ID:
CalloutsUpdateTemplate

サブスクリプションから既存のコールアウト テンプレートを更新します。

パラメーター

名前 キー 必須 型 説明
テンプレート ID
 templateId True string

更新したいテンプレート ID
categoryId
 categoryId string
externalId
 externalId string
id
 id string
location
 location string
名称
 name string
subject
 subject string
targetAllTeams
 targetAllTeams boolean
targetTeamId
 targetTeamId string
text
 text string
workflowType
 workflowType integer

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

戻り値

返答
array of V2.CalloutTemplateDetails

サブスクリプションのすべてのチームの情報を取得する

操作 ID:
SubscriptionsGetAllTeamsInfo

サブスクリプションのすべてのチームの情報を取得します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

更新するサブスクリプションの ID

戻り値

返答
array of TeamInfo

サブスクリプションのチャンネル価格情報を返す

操作 ID:
SubscriptionsGetChannelPriceInfo

サブスクリプションのチャンネル価格情報を返します

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

取得が必要なサブスクリプションの ID です。

戻り値

Body
ChannelPriceInfo

サブスクリプションのユーザー ライセンスを取得する

操作 ID:
SubscriptionsGetUserLicenses

サブスクリプションのユーザー ライセンスを取得します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

サブスクリプションの ID

戻り値

Body
UserLicenseInfo

サブスクリプションの現在のプリペイド トランザクションを取得する

操作 ID:
SubscriptionsGetPrepaidTransactions

サブスクリプションの現在のプリペイド トランザクションを取得します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

トランザクションを取得するサブスクリプションの ID

戻り値

返答
array of PrepaidTransactionInfo

サブスクリプションの現在のプリペイド トランザクションを取得する

操作 ID:
PrepaidGetTransactions

サブスクリプションの現在のプリペイド トランザクションを取得します。

戻り値

返答
array of PrepaidTransactionInfo

サブスクリプションの現在のプリペイド残高を取得する

操作 ID:
SubscriptionsGetPrepaidBalance

サブスクリプションの現在のプリペイド残高を取得します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

サブスクリプションの ID

戻り値

Body
PrepaidBalanceInfo

サブスクリプションの現在のプリペイド残高を取得する

操作 ID:
PrepaidGetBalance

サブスクリプションの現在のプリペイド残高を取得します。

戻り値

Body
PrepaidBalanceInfo

サブスクリプションの現在のプリペイド設定を取得する

操作 ID:
PrepaidGetSettings84

サブスクリプションの現在のプリペイド設定を取得します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

サブスクリプションの ID

戻り値

Body
PrepaidSettingsInfo

サブスクリプションの現在のプリペイド設定を取得する

操作 ID:
PrepaidGetSettings

サブスクリプションの現在のプリペイド設定を取得します。

戻り値

Body
PrepaidSettingsInfo

サブスクリプションの現在のプリペイド設定を更新する

操作 ID:
PrepaidUpdateSettings55

サブスクリプションの現在のプリペイド設定を更新します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

サブスクリプションの ID
topUpAmount
 topUpAmount integer
topUpEnabled
 topUpEnabled boolean
topUpLimit
 topUpLimit integer

戻り値

Body
PrepaidSettingsInfo

サブスクリプションの現在のプリペイド設定を更新する

操作 ID:
PrepaidUpdateSettings

サブスクリプションの現在のプリペイド設定を更新します。

パラメーター

名前 キー 必須 型 説明
topUpAmount
 topUpAmount integer
topUpEnabled
 topUpEnabled boolean
topUpLimit
 topUpLimit integer

戻り値

Body
PrepaidSettingsInfo

サブスクリプションの音声番号ライセンスを取得します

操作 ID:
SubscriptionsGetVoiceNumberLicense

サブスクリプションの音声番号ライセンスを取得します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

サブスクリプションの ID

戻り値

Body
UserLicenseInfo

サブスクリプション内のすべてのチームに関する公開情報を取得する

操作 ID:
TeamsGetAllPublicInformation

サブスクリプション内のすべてのチームに関する公開情報を取得します。

戻り値

返答
array of V2.TeamPublicDetails

サブスクリプション用のすべてのコールアウト テンプレートを取得する

操作 ID:
CalloutsGetTemplates

サブスクリプション用のすべてのコールアウト テンプレートを取得します。

戻り値

返答
array of V2.CalloutTemplateDetails

サブスクリプション用の新しいコールアウト テンプレートを作成する

操作 ID:
CalloutsCreateTemplate

サブスクリプション用の新しいコールアウト テンプレートを作成します。

パラメーター

名前 キー 必須 型 説明
categoryId
 categoryId string
externalId
 externalId string
id
 id string
location
 location string
名称
 name string
subject
 subject string
targetAllTeams
 targetAllTeams boolean
targetTeamId
 targetTeamId string
text
 text string
workflowType
 workflowType integer

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

戻り値

返答
array of V2.CalloutTemplateDetails

ジャーナルからページングされたリモートジョブを返す

操作 ID:
RemoteActionsGetJobsPaged

サンプル要求:

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}

パラメーター

名前 キー 必須 型 説明
最大の結果
 maxResults integer

最大の結果
Language
 language integer

  • 0 = EN
  • 1 = DE
actionId
 actionId string
continuationToken
 continuationToken string
maxCreationDate
 maxCreationDate date-time
minCreationDate
 minCreationDate date-time
modifiedSince
 modifiedSince date-time
statusCodes
 statusCodes integer

  • 0 = なし
  • 1 = 保留中
  • 2 = 準備完了
  • 4 = 実行
  • 8 = 実行済み
  • 16 = エラー

戻り値

Body
PagedResultsPublic-1-V2.RemoteJob-

ジャーナルからリモート ジョブを返します

操作 ID:
RemoteActionsGetJob

サンプル要求:

GET /remoteActions/journal/{jobId}

パラメーター

名前 キー 必須 型 説明
ジョブ ID
 jobId True string

返すジョブの ID
Language
 language integer

  • 0 = EN
  • 1 = DE

戻り値

Body
V2.RemoteJob

スクリプト インスタンスの削除

操作 ID:
ScriptsDelete

渡されたインスタンス ID で指定されたスクリプト インスタンスを取得します。

パラメーター

名前 キー 必須 型 説明
スクリプト インスタンス ID
 instanceId True string

返されるスクリプト インスタンスのインスタンス ID です。

スクリプト インスタンスの有効化

操作 ID:
ScriptsEnable

スクリプト インスタンスを有効化します。

パラメーター

名前 キー 必須 型 説明
スクリプト インスタンス ID
 instanceId True string

有効にするインスタンスの ID です。

戻り値

Body
ScriptInstanceDetails

ダウンロード可能なアラート レポートに関する情報を取得する

操作 ID:
TeamsGetAlertReportsInfo

ダウンロード可能なアラート レポートに関する情報を取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

レポートをダウンロードするチームの ID です。

戻り値

返答
array of AlertAuditReportFileInfo

チームからすべてのアラート パターンを取得する

操作 ID:
TeamsGetAllAlertPatterns

チームからすべてのアラート パターンを取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

アクセスするチームのチーム ID

戻り値

返答
array of V2.AlertingPatternDetails

チームからユーザーまたは招待を削除する

操作 ID:
TeamsRemoveUser

チームからユーザーまたは招待を削除します

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

ユーザーを削除するチームの ID
User ID
 userId True string

削除すべきユーザーの ID
User ID
 requesterUserId string

他のユーザーを削除するユーザーのユーザー ID です。

チームごとにチームメンバーシップを取得する

操作 ID:
TeamsGetMemberships

チームごとにチームメンバーシップを取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

アクセスするチームのチーム ID です。

戻り値

返答
array of V2.TeamMembershipDetails

チームのチームプライバシー設定の更新

操作 ID:
TeamsUpdatePrivacySettings

チームのチームプライバシー設定を更新します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

チームのチーム ID
hideContactAddresses
 hideContactAddresses boolean
hideDutyData
 hideDutyData boolean
hideForEscalation
 hideForEscalation boolean

戻り値

Body
V2.TeamPrivacySettingsDetails

チームのチームプライバシー設定を取得する

操作 ID:
TeamsGetPrivacySettings

チームのチームプライバシー設定を取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

チームのチーム ID

戻り値

Body
V2.TeamPrivacySettingsDetails

チームのチームプロフィールを更新します

操作 ID:
TeamsUpdateProfile

チームのチームプロフィールを更新します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

更新する必要があるチームのチームの ID です。
名称
 name string

戻り値

Body
TeamInfo

チームの休暇を取得する

操作 ID:
TeamsGetHolidays

チームの休暇を取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

休日を取得するチームの ID

戻り値

Body
V2.TeamHolidayDetails

チームの休暇を確保する

操作 ID:
TeamsSaveHolidays

チームの休暇を確保します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

休日を保存するチームのチーム ID
Year
 year True integer

休日を保存する年
day
 day integer
month
 month integer

  • 0 = 設定解除
  • 1 = 1 月
  • 2 = 2 月
  • 3 = 3 月
  • 4 = 4 月
  • 5 = 5 月
  • 6 = 6 月
  • 7 = 7 月
  • 8 = 8 月
  • 9 = 9 月
  • 10 = 10 月
  • 11 = 11 月
  • 12 = 12 月

戻り値

Body
V2.TeamHolidayDetails

チームの繰り返される休暇を保存する

操作 ID:
TeamsSaveRepeatingHolidays

チームの繰り返される休暇を保存します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

休日を保存するチームのチーム ID
day
 day integer
month
 month integer

  • 0 = 設定解除
  • 1 = 1 月
  • 2 = 2 月
  • 3 = 3 月
  • 4 = 4 月
  • 5 = 5 月
  • 6 = 6 月
  • 7 = 7 月
  • 8 = 8 月
  • 9 = 9 月
  • 10 = 10 月
  • 11 = 11 月
  • 12 = 12 月

戻り値

Body
V2.TeamHolidayDetails

チームの職務アシスタント情報を取得する

操作 ID:
DutiesGetDutyAssistantInfo

チームの職務アシスタント情報を取得します。

パラメーター

名前 キー 必須 型 説明
チームの ID
 teamId array

サマリーを取得するチームの ID です。
最後の 2 つの職務
 lastTwoDuties boolean

すべての任務を希望するか、最後の 2 つの任務のみを希望するかを決定します。

戻り値

Body
MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

パターンのタイムスロットを検証する

操作 ID:
TeamsValidateAlertPattern

パターンのタイム スロットを、他のパターンの既存のすべてのタイム スロットと比較して検証します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

アラート パターンのチーム ID
パターン ID
 patternId string

タイム スロットを保存するパターンのアラート パターン ID です。 null を許可
カテゴリ ID
 categoryIds array

検証するパターンのカテゴリ ID です。 null 値を指定可能。
時間
 hour integer
分
 minutes integer
平日
 weekday integer

  • 0 = 休日
  • 1 = 月曜日
  • 2 = 火曜日
  • 3 = 水曜日
  • 4 = 木曜日
  • 5 = 金曜日
  • 6 = 土曜日
  • 7 = 日曜日
id
 id string

戻り値

返答
array of V2.TimeSlotValidationResultDetails

ページングされたアラートの取得

操作 ID:
AlertsGetPaged

ページングされたアラートを取得します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId string

アラートを受け取るユーザーのユーザー ID です。
アラート制限
 maxResults integer

リクエストごとに取得されるアラートの詳細の制限を定義します。 リクエストごとに 1 ～ 100 を指定できます。 フィルタリングするとアラートの数は少なくなる可能性がありますが、少なくとも 1 つです。
afterId
 afterId string
alertIds
 alertIds array of string
alertStatusCodes
 alertStatusCodes integer

  • 0 = なし
  • 1 = オープン
  • 2 = 確認済み
  • 4 = クローズ
  • 8 = 返信なし
  • 16 = 失敗
  • 32 = エラー
categoryIds
 categoryIds array of string
nextPartitionKey
 nextPartitionKey string
nextRowKey
 nextRowKey string
nextTableName
 nextTableName string
externalId
 externalId string
maxCreated
 maxCreated date-time
minCreated
 minCreated date-time
modifiedSince
 modifiedSince date-time
showPersonalHiddenCategories
 showPersonalHiddenCategories boolean
teamIds
 teamIds array of string
textToSearch
 textToSearch string

戻り値

Body
PagedResultsPublic-1-V2.AlertInfo-

ページングされた概要イベントを取得する

操作 ID:
EventsGetOverviewPaged

ページングされた概要イベントを取得します。 さらに結果がある場合は、イベント フィルターに追加できる継続トークンも取得します。

パラメーター

名前 キー 必須 型 説明
Limit
 maxResults integer

リクエストごとに取得されるアラートの詳細の制限を定義します。 リクエストごとに 1 ～ 100 を指定できます。 フィルタリングするとアラートの数は少なくなる可能性がありますが、少なくとも 1 つです。
nextPartitionKey
 nextPartitionKey string
nextRowKey
 nextRowKey string
nextTableName
 nextTableName string
eventSourceId
 eventSourceId string
eventStatusCode
 eventStatusCode integer

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = エラー
maxCreationDate
 maxCreationDate date-time
minCreationDate
 minCreationDate date-time
modifiedSince
 modifiedSince date-time
teamid
 teamid string
textToSearch
 textToSearch string

戻り値

Body
PagedResultsPublic-1-OverviewEvent-

ユーザー アカウントの削除

操作 ID:
UsersDelete

ユーザー アカウントを削除します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

削除するユーザーの ID です。

ユーザーIDによる職務状況の取得

操作 ID:
UsersGetDutyStatus

義務情報を含むオブジェクトを返します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

取得するユーザーの識別子。 「Me」を使用して、現在ログインしているユーザーに関する情報を取得する。 API キーではこれは不可能です。 チーム内のユーザーのメール アドレス、または対応するユーザー オブジェクトの一意の ID にすることもできます。
チーム ID
 teamId array

チームの ID。

戻り値

Body
MultiTeamResult-2-UserDutyInfo-V2.DutyError-

ユーザーからチームメンバーシップを取得する

操作 ID:
TeamsGetTeamMemberships

ユーザーからチームメンバーシップを取得します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

アクセスするユーザー ID です。

戻り値

返答
array of V2.TeamMembershipDetails

ユーザーから連絡先アドレスを削除する

操作 ID:
UsersDeleteContactAddress

ユーザーから連絡先アドレスを削除します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

アドレスを削除するユーザーのユーザー ID
住所 ID
 addressId True string

連絡先住所の ID

ユーザーが所属するすべてのチームを取得する

操作 ID:
UsersGetAllTeams

チーム オブジェクトのリストを、名前などの詳細とともに返します。 ユーザーがメンバーであるチームのみが返されます。

パラメーター

名前 キー 必須 型 説明
チーム ID
 userId True string

チームの ID です。

戻り値

返答
array of TeamInfo

ユーザーが提供された権限を持っているかどうかを確認する

操作 ID:
UsersCheckPermissions

ユーザーが提供された権限を持っているかどうかを確認します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

アクセス許可をチェックするユーザーの ID です。
permissions
 permissions array of string
teamIds
 teamIds array of string

戻り値

Body
MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

ユーザーに対して以前に作成された電話番号を検証する

操作 ID:
UsersValidatePhoneNumber

ユーザーに対して以前に作成された電話番号を検証します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

前回作成した電話番号を検証したいユーザーのユーザー ID
phoneNumber
 phoneNumber string
validationCode
 validationCode string

ユーザーのチームメンバーシップを更新する

操作 ID:
TeamsUpdateUserMembership

ユーザーのチームメンバーシップを更新します。 ユーザーをサブスクリプション内の別のチームに移動したり、ユーザーのロールを変更したりできます。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

更新したいユーザーが現在所属しているチームです。
User ID
 userId True string

更新するユーザーのユーザー ID です。
User ID
 requesterUserId string

ロールを変更するユーザーのユーザー ID です。 API キーを使用する場合は、これを指定する必要があります。 このユーザーは、ロール 管理者 (管理者 ロールの設定用) またはチーム 管理者 (権限の設定用) を持っている必要があります。
ユーザーを勤務中に設定する
 setUserOnDuty boolean

ユーザーが別のチームに移動した場合に、ユーザーの新しい職務ステータスを設定します。 既定ではユーザーは勤務中です。
isValid
 isValid boolean
roleId
 roleId string
teamId
 teamId string

戻り値

Body
UserInfo

ユーザーのパスワードを更新する

操作 ID:
UsersUpdatePassword

ユーザーのパスワードを更新します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

パスワードを変更するユーザーのユーザー ID です。
currentPassword
 currentPassword string
newPassword
 newPassword string

ユーザーのユーザープロファイルを更新する

操作 ID:
UsersUpdateProfile

ユーザーのユーザープロファイルを更新します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

更新するユーザーの ID です。
名称
 name string
timeZone
 timeZone string

戻り値

Body
UserInfo

ユーザーのロケール情報 (言語、タイムゾーンなど) の更新

操作 ID:
UsersUpdateLocaleInfo

ユーザーのロケール情報 (言語、タイムゾーンなど) を更新します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

更新したいユーザーのユーザーID、電子メール、または自分自身
language
 language string
timeZone
 timeZone string

戻り値

Body
V2.UserLocaleResponseDetails

ユーザーの所在地設定

操作 ID:
UsersSetLocation

ユーザーの所在地を設定します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

ユーザーの ID です。
緯度
 latitude double
緯度
 longitude double
timestamp
 timestamp date-time

戻り値

Body
LocationInfo

ユーザーの通知プロファイルを取得する

操作 ID:
UsersGetNotificationProfile

ユーザーの通知プロファイルを取得します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

通知プロファイルを取得したいユーザの ID です。

戻り値

返答
array of V2.NotificationProfileDetails

ユーザーの通知プロファイルを設定

操作 ID:
UsersSetNotificationProfile

ユーザーの通知プロファイルを設定します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

通知プロファイルを取得したいユーザの ID です。
channel
 channel integer

  • 0 = なし
  • 1 = プッシュ
  • 2 = 電子メール
  • 4 = ボット
  • 8 = 音声
  • 16 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean
options
 options integer
persistent
 persistent boolean

戻り値

返答
array of V2.NotificationProfileDetails

ユーザーの電話番号を削除

操作 ID:
UsersSetPhoneNumber

ユーザーの電話番号を削除します。 別の電話番号を登録すると上書きされます。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

電話番号を追加したいユーザーのユーザー ID
countryCode
 countryCode string
phoneNumber
 phoneNumber string
sendValidationCode
 sendValidationCode boolean
sendValidationCodeVia
 sendValidationCodeVia integer

  • 0 = なし
  • 1 = SMS
  • 2 = 音声

戻り値

Body
V2.UserPhoneNumberDetails

ユーザーの電話番号を削除する

操作 ID:
UsersDeletePhoneNumber

ユーザーの電話番号を削除します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

ユーザーの ID

ユーザーをチームに招待する

操作 ID:
TeamsInviteUser

ユーザーをチームに招待します。

パラメーター

名前 キー 必須 型 説明
inviterId
 inviterId string
メールアドレス
 email string
roleId
 roleId string
teamId
 teamId True string

戻り値

返答
array of V2.InvitationResult

ユーザーをチームに追加する

操作 ID:
TeamsAddUser

ユーザーをチームに追加します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

ユーザーを招待するチームの ID です。
User ID
 userId True string

チームに追加したいユーザーの ID です。
roleId
 roleId string
setUserOnDuty
 setUserOnDuty boolean

戻り値

Body
V2.TeamMembershipDetails

ユーザーをマネージャーとしてパンチインする

操作 ID:
DutiesUserPunchInAsManager

指定されたユーザーはマネージャーとして勤務します。

パラメーター

名前 キー 必須 型 説明
teamIds
 teamIds array of string
userId
 userId True string

戻り値

Body
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

ユーザーを勤務終了に設定

操作 ID:
DutiesUserPunchOut

指定されたユーザーが勤務終了に設定されます。

パラメーター

名前 キー 必須 型 説明
teamIds
 teamIds array of string
userId
 userId True string

戻り値

Body
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

ユーザーを勤務開始に設定

操作 ID:
DutiesUserPunchIn

指定されたユーザーが勤務開始に設定されます。

パラメーター

名前 キー 必須 型 説明
teamIds
 teamIds array of string
userId
 userId True string

戻り値

Body
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

リモート アクションの削除

操作 ID:
RemoteActionsDelete

サンプル要求:

DELETE /eaRemoteActions/{actionId}

パラメーター

名前 キー 必須 型 説明
Action ID
 actionId True string

削除するアクションの ID

リモート アクションの更新

操作 ID:
RemoteActionsUpdate

サンプル要求:

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

パラメーター

名前 キー 必須 型 説明
Action ID
 actionId True string

更新されるリモート アクションの ID
Action ID
 language integer

  • 0 = EN
  • 1 = DE
名称
 name True string
価値
 value string
canEdit
 canEdit boolean
canExecute
 canExecute boolean
teamId
 teamId string
definitionId
 definitionId string
description
 description string
enabled
 enabled boolean
名称
 name string
teamId
 teamId string

戻り値

Body
V2.RemoteActionDetails

リモートアクションを返す

操作 ID:
RemoteActionsGetActions

サンプル要求:

GET /RemoteActions?externalId=12345

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId string

チーム ID
External ID
 externalId string

外部 ID のオプションのフィルター
タイプ
 type integer

  • 0 = 不明
  • 1 = スクリプト
  • 2 = EnterpriseAlert
  • 3 = Webhook
Executor サービス
 executorService string

Executor サービス
Language
 language integer

  • 0 = EN
  • 1 = DE

戻り値

返答
array of V2.RemoteActionInfo

予定されているすべてのスケジュールに関する情報を返す

操作 ID:
SchedulesGetPlanned

予定されているすべてのスケジュールに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
制限
 limit integer
minDate
 minDate date-time
teamIds
 teamIds array of string
userId
 userId string

戻り値

返答
array of V2.ScheduleDetails

休日の削除

操作 ID:
TeamsDeleteHolidays

休日を削除します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

休日を削除するチームの ID
day
 day integer
month
 month integer

  • 0 = 設定解除
  • 1 = 1 月
  • 2 = 2 月
  • 3 = 3 月
  • 4 = 4 月
  • 5 = 5 月
  • 6 = 6 月
  • 7 = 7 月
  • 8 = 8 月
  • 9 = 9 月
  • 10 = 10 月
  • 11 = 11 月
  • 12 = 12 月
year
 year integer

個人ユーザー画像の削除

操作 ID:
UsersDeleteImage

個人ユーザー画像を削除します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

ユーザー ID または自分

個人ユーザー画像の取得

操作 ID:
UsersGetImage

個人ユーザー画像を取得します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

ユーザー ID
画像の高さ
 height integer

画像の高さ。
イメージの幅
 width integer

画像の幅。

戻り値

Body
UserImage

利用可能なすべてのインベントリ スクリプトを返します

操作 ID:
ScriptsGetAvailable

SIGNL4 サブスクリプションに追加できる、利用可能なすべてのインベントリ スクリプトを返します。

戻り値

返答
array of InventoryScriptInfo

利用可能なすべての定義を取得する

操作 ID:
RemoteActionsGetAvailableDefinitions

利用可能なすべての定義を取得します。

パラメーター

名前 キー 必須 型 説明
Language
 language integer

  • 0 = EN
  • 1 = DE

戻り値

返答
array of V2.RemoteActionDefinitionDetails

利用可能なすべての管理対象サブスクリプションの情報を取得する

操作 ID:
SubscriptionsGetAll

利用可能なすべての管理対象サブスクリプションの情報を取得します。

戻り値

返答
array of SubscriptionInfo

定義を取得する

操作 ID:
RemoteActionsGetDefinition

定義を取得します。

パラメーター

名前 キー 必須 型 説明
定義 ID
 definitionId True string

定義の ID
Language
 language integer

  • 0 = EN
  • 1 = DE

戻り値

Body
V2.RemoteActionDefinitionDetails

招待が存在する場合に招待メールを再送信する

操作 ID:
TeamsResendInvite

招待が存在する場合は招待メールを再度送信します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

招待されたユーザーがいるチームのチーム ID です。
inviterId
 inviterId string
userMail
 userMail True string

戻り値

返答
string

指定された ID の勤務表情報を返す

操作 ID:
DutiesGetInfo

指定された ID の勤務表情報を返します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

その職務が属するチームの ID です
職務のスケジュール ID
 scheduleId True string

要求された勤務スケジュールの ID です。

戻り値

Body
ScheduleInfo

指定されたアラートの指定された添付ファイルを取得する

操作 ID:
AlertsGetAttachment

指定されたアラートの指定された添付ファイルを取得します。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

必要な添付ファイルを含むアラートの ID です。
Attachment ID
 attachmentId True string

取得する添付ファイルの ID です。
イメージの幅
 width integer

取得する画像の必要な幅を定義するオプションのパラメータです。
画像の高さ
 height integer

取得する画像の必要な高さを定義するオプションのパラメータです。
スケール
 scale boolean

取得した画像を拡大縮小するかどうかを定義するオプションのパラメータです。 既定では true に設定されています。

戻り値

返答
binary

指定されたサブスクリプションの機能を返す

操作 ID:
SubscriptionsGetFeatures

指定されたサブスクリプションの機能を返します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

機能を取得する必要があるサブスクリプションの ID です。

戻り値

返答
array of SubscriptionFeature

指定されたスクリプト インスタンスに関するすべての情報を返す

操作 ID:
ScriptsGetInfo

渡されたインスタンス ID で指定されたスクリプト インスタンスを取得します。

パラメーター

名前 キー 必須 型 説明
スクリプト インスタンス ID
 instanceId True string

返されるスクリプト インスタンスのインスタンス ID です。

戻り値

Body
ScriptInstanceDetails

指定されたスクリプト インスタンスを更新する

操作 ID:
ScriptsUpdateConfig

指定されたスクリプト インスタンスを更新します。通常は、スクリプトの構成を更新するために使用されます。

パラメーター

名前 キー 必須 型 説明
スクリプト インスタンス ID
 instanceId True string

更新するスクリプトのインスタンス ID です。
構成
 config
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
enabled
 enabled boolean
teamId
 teamId string

戻り値

Body
ScriptInstanceDetails

指定されたスクリプト インスタンスを無効にする

操作 ID:
ScriptsDisable

指定されたスクリプト インスタンスを無効にします。

パラメーター

名前 キー 必須 型 説明
スクリプト インスタンス ID
 instanceId True string

無効にするインスタンスの ID です。

戻り値

Body
ScriptInstanceDetails

指定された勤務スケジュールを作成または更新する

操作 ID:
DutiesCreateOrUpdate

指定された勤務スケジュールを作成または更新します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

割り当てられるチームの ID です。
終了
 end date-time
id
 id string
options
 options integer
start
 start date-time
userId
 userId string

戻り値

Body
ScheduleInfo

指定したチームのすべてのユーザーを取得する

操作 ID:
TeamsGetAllUsers

指定したチームのすべてのユーザーを取得します。

パラメーター

名前 キー 必須 型 説明
チームの ID
 teamId array

リクエストするチームの ID です。 空の場合、アクセスできるすべてのチームのすべてのユーザーが取得されます。

戻り値

Body
MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

指定したチームのプロフィール画像のアップロード

操作 ID:
TeamsUploadImage

指定したチームのプロフィール画像をアップロードします。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

チーム イメージを設定するチームの ID です。

指定したチームの画像を取得する

操作 ID:
TeamsGetImage

指定したチームの画像を取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

画像を取得するチームの ID です。
画像の高さ
 height integer

取得する画像の必要な高さを定義するオプションのパラメータです。
イメージの幅
 width integer

取得する画像の必要な幅を定義するオプションのパラメータです。

戻り値

Body
V2.TeamImageDetails

指定したユーザーにメールを送信する

操作 ID:
UsersSendEventSourceInfoEmail

ユーザーのチームのすべてのイベント ソースの情報を含むメールを指定したユーザーに送信します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

ユーザー ID です。
チーム ID
 teamId string

ユーザーが エンドポイント 情報を取得する必要があるチームの ID です。

指定したユーザーのプロフィール画像をアップロードする

操作 ID:
UsersUploadImage

指定したユーザーのプロフィール画像をアップロードします。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

ユーザーの ID。

新しいアラート パターンを作成する

操作 ID:
TeamsCreateAlertPattern

新しいアラート パターンを作成します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

パターンを作成するチーム ID
categories
 categories array of string
enabled
 enabled boolean
mode
 mode integer

  • 0 = 管理者
  • 1 = チーム
referenceId
 referenceId string
id
 id string
名称
 name string
channel
 channel integer

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean
overrideEscalationSettings
 overrideEscalationSettings boolean
overrideNotificationProfiles
 overrideNotificationProfiles boolean
overrideResponseSettings
 overrideResponseSettings boolean
responseMode
 responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer
suppressSignl
 suppressSignl boolean
時間
 hour integer
分
 minutes integer
平日
 weekday integer

  • 0 = 休日
  • 1 = 月曜日
  • 2 = 火曜日
  • 3 = 水曜日
  • 4 = 木曜日
  • 5 = 金曜日
  • 6 = 土曜日
  • 7 = 日曜日
id
 id string

戻り値

Body
V2.AlertingPatternDetails

新しいカテゴリを作成します

操作 ID:
CategoriesCreate

サンプル要求:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID
enabled
 enabled boolean
id
 id string
名称
 name string
タイプ
 type True integer

  • 0 = パラメーター
  • 1 = 件名
  • 2 = テキスト
  • 3 = 場所
価値
 value string
color
 color True string
id
 id string
名称
 name string
タイプ
 type True integer

  • 0 = パラメーター
  • 1 = ハイパーリンク
価値
 value string
id
 id string
imageName
 imageName True string
isDefault
 isDefault boolean
keywordMatching
 keywordMatching True integer

  • 0 = いずれか
  • 1 = すべて
keywords
 keywords True array of string
keywordsExcluded
 keywordsExcluded array of string
名称
 name True string
options
 options integer

  • 0 = なし
  • 1 = 非表示
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
注文
 order integer
teamId
 teamId string

戻り値

Body
CategoryInfo

新しいリモート アクションを作成する

操作 ID:
RemoteActionsCreate

サンプル要求:

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

パラメーター

名前 キー 必須 型 説明
Language
 language integer

  • 0 = EN
  • 1 = DE
名称
 name True string
価値
 value string
canEdit
 canEdit boolean
canExecute
 canExecute boolean
teamId
 teamId string
definitionId
 definitionId string
description
 description string
enabled
 enabled boolean
名称
 name string
teamId
 teamId string

戻り値

Body
V2.RemoteActionDetails

新しいリモート ジョブを作成する

操作 ID:
RemoteActionsCreateJob

サンプル要求:

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}

パラメーター

名前 キー 必須 型 説明
Action ID
 actionId True string

Action ID
名称
 name True string
価値
 value string
alertId
 alertId string
options
 options integer

  • 0 = なし
remoteActionPin
 remoteActionPin string

戻り値

Body
V2.RemoteJob

既存のアラート パターンを更新する

操作 ID:
TeamsUpdateAlertPattern

既存のアラート パターンを更新します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

パターンを作成するチーム ID
パターン ID
 patternId True string

電話番号を追加するユーザーのユーザー ID
categories
 categories array of string
enabled
 enabled boolean
mode
 mode integer

  • 0 = 管理者
  • 1 = チーム
referenceId
 referenceId string
id
 id string
名称
 name string
channel
 channel integer

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean
overrideEscalationSettings
 overrideEscalationSettings boolean
overrideNotificationProfiles
 overrideNotificationProfiles boolean
overrideResponseSettings
 overrideResponseSettings boolean
responseMode
 responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer
suppressSignl
 suppressSignl boolean
時間
 hour integer
分
 minutes integer
平日
 weekday integer

  • 0 = 休日
  • 1 = 月曜日
  • 2 = 火曜日
  • 3 = 水曜日
  • 4 = 木曜日
  • 5 = 金曜日
  • 6 = 土曜日
  • 7 = 日曜日
id
 id string

戻り値

Body
V2.AlertingPatternDetails

既存のイベント ソースを更新する

操作 ID:
EventSourcesUpdate

既存のイベント ソースを更新します。

パラメーター

名前 キー 必須 型 説明
イベント ソース ID
 eventSourceId True string

イベントソースの ID
description
 description string
無効
 disabled boolean
名称
 name string
teamId
 teamId string

戻り値

Body
EventSourceEndpointInfo

既存のカテゴリの削除

操作 ID:
CategoriesDelete

サンプル要求:

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID
Category ID
 categoryId True string

削除するカテゴリの ID

既存のカテゴリの更新

操作 ID:
CategoriesUpdate

サンプル要求:

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID
Category ID
 categoryId True string

Category ID
enabled
 enabled boolean
id
 id string
名称
 name string
タイプ
 type True integer

  • 0 = パラメーター
  • 1 = 件名
  • 2 = テキスト
  • 3 = 場所
価値
 value string
color
 color True string
id
 id string
名称
 name string
タイプ
 type True integer

  • 0 = パラメーター
  • 1 = ハイパーリンク
価値
 value string
id
 id string
imageName
 imageName True string
isDefault
 isDefault boolean
keywordMatching
 keywordMatching True integer

  • 0 = いずれか
  • 1 = すべて
keywords
 keywords True array of string
keywordsExcluded
 keywordsExcluded array of string
名称
 name True string
options
 options integer

  • 0 = なし
  • 1 = 非表示
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
注文
 order integer
teamId
 teamId string

戻り値

Body
CategoryInfo

特定のアラート パターンを削除する

操作 ID:
TeamsDeleteAlertPattern

特定のアラート パターンを削除します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

アクセスしたいチームのチーム ID
パターン ID
 patternId True string

アクセスするパターンのパターン ID

特定のカテゴリのメトリクスを取得する

操作 ID:
CategoriesGetMetrics

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID
Category ID
 categoryId True string

取得するカテゴリの ID

戻り値

Body
CategoryMetrics

特定のカテゴリを取得

操作 ID:
CategoriesGet

サンプル要求:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

カテゴリーが属するチームの ID
Category ID
 categoryId True string

取得するカテゴリの ID

戻り値

Body
CategoryInfo

特定のサブスクリプションの情報を取得する

操作 ID:
SubscriptionsGetInfo

特定のサブスクリプションの情報を取得します。

パラメーター

名前 キー 必須 型 説明
Subscription ID
 subscriptionId True string

取得されるサブスクリプションの ID です。

戻り値

Body
SubscriptionInfo

特定のチームのアラート設定

操作 ID:
TeamsSetAlertSettings

特定のチームのアラートを設定します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

設定する必要があるチームの ID です。
escEnabled
 escEnabled boolean
escMode
 escMode integer

  • 0 = 管理者
  • 1 = チーム
escRefId
 escRefId string
filterAction
 filterAction integer

  • 0 = カット
  • 1 = 非表示
  • 2 = ミュート
filterMode
 filterMode integer

  • 0 = オフ
  • 1 = WhiteListAllCategories
channel
 channel integer

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
delay
 delay integer
enabled
 enabled boolean
optOut
 optOut integer

  • 0 = なし
  • 1 = 無効
  • 2 = パーソナル
overrideNotificationProfiles
 overrideNotificationProfiles boolean
persNotInterval
 persNotInterval integer
persNotMode
 persNotMode integer

  • 0 = オフ
  • 1 = 概要
responseMode
 responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer

戻り値

Body
AlertSettings

特定のチームのアラート設定を取得する

操作 ID:
TeamsGetAlertSettings

特定のチームのアラート設定を取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId array

チームの一意の ID です。

戻り値

Body
MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

特定のチームのアラート設定を取得する

操作 ID:
TeamsGetAlertSettings99

特定のチームのアラート設定を取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

設定を取得する必要があるチームの ID です。

戻り値

Body
AlertSettings

特定のチームのイベント ソースを取得する

操作 ID:
TeamsGetEventSources

特定のチームのイベント ソースを取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

ソースを取得する必要があるチームの ID です。

戻り値

返答
array of EventSourceEndpointInfo

特定のチームのセットアップ進行状況を取得する

操作 ID:
TeamsGetSetupProgress

特定のチームのセットアップ進行状況を取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

進捗を取得する必要があるチームの ID です。

戻り値

Body
TeamSetupProgress

特定のチームの情報を取得する

操作 ID:
TeamsGetInfo

特定のチームの情報を取得します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

取得する必要のあるチームです。

戻り値

Body
TeamInfo

特定のファイル名で関税レポートをダウンロードする

操作 ID:
TeamsGetDutyReport

特定のファイル名で関税レポートをダウンロードします。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

勤務報告をダウンロードするチームの ID です。
File Name
 fileName True string

ダウンロードする CSV のファイル名です。

戻り値

返答
binary

特定のユーザーのセットアップ進行状況を取得する

操作 ID:
UsersGetSetupProgress

特定のチームのセットアップ進行状況を取得します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId True string

進捗を取得する必要があるユーザーの ID です。

戻り値

Body
UserSetupProgress

特定の職務を削除する

操作 ID:
DutiesDelete

特定の職務を削除します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

その職務が属するチームの ID です。
職務のスケジュール ID
 dutyId True string

削除する職務の ID です。

現在のチームイメージを削除する

操作 ID:
TeamsDeleteImage

現在のチームイメージを削除します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

チーム画像を削除するチームの ID です。

確認済みのアラートをすべて閉じる

操作 ID:
AlertsCloseAll

このメソッドは、チームが現在持っているすべての確認済みのアラートを閉じます。

パラメーター

名前 キー 必須 型 説明
User ID
 userId string

アラームを閉じるために使用されるユーザーのユーザー ID です。
categoryIds
 categoryIds array of string
maxDate
 maxDate date-time
minDate
 minDate date-time
scope
 scope integer

  • 0 = 既定
  • 1 = AllTeams
  • 2 = SpecificTeams
teamIds
 teamIds array of string

範囲内の勤務スケジュールを削除する

操作 ID:
DutiesDeleteInRange

範囲内の勤務スケジュールを削除します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

削除するチーム ID
送信元
 from date-time
送信先
 to date-time

戻り値

返答
array of ScheduleInfo

表示されているすべてのアラートを確認します

操作 ID:
AlertsAcknowledgeAll

このメソッドは、チームが現在持っている、特定のユーザーによる未処理のアラートをすべて確認します。

パラメーター

名前 キー 必須 型 説明
User ID
 userId string

アラームの確認に使用するユーザーのユーザー ID です。
categoryIds
 categoryIds array of string
maxDate
 maxDate date-time
minDate
 minDate date-time
scope
 scope integer

  • 0 = 既定
  • 1 = AllTeams
  • 2 = SpecificTeams
teamIds
 teamIds array of string

表示名 を含む、指定されたスクリプト インスタンスのカスタム データを更新する

操作 ID:
ScriptsUpdateCustomData

指定されたスクリプト インスタンスを更新します。

パラメーター

名前 キー 必須 型 説明
スクリプト インスタンス ID
 instanceId True string

更新するスクリプトのインスタンス ID です。
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
instanceId
 instanceId string
scriptName
 scriptName string

戻り値

Body
ScriptInstanceDetails

複数のアラートの終了を取り消す

操作 ID:
AlertsUndoCloseMultiple

このメソッドは、複数のアラート閉鎖を元に戻そうとします。 操作はバックグラウンドで処理されます。

パラメーター

名前 キー 必須 型 説明
alertIds
 alertIds True array of string
descr
 descr string
uid
 uid True string

複数のアラートを承認する

操作 ID:
AlertsAcknowledgeMultiple

このメソッドは、提供されたすべてのアラートを確認します。

パラメーター

名前 キー 必須 型 説明
alertIds
 alertIds True array of string
descr
 descr string
uid
 uid True string

複数のアラートを閉じる

操作 ID:
AlertsCloseMultiple

このメソッドは、提供されたすべてのアラートを閉じます。

パラメーター

名前 キー 必須 型 説明
alertIds
 alertIds True array of string
descr
 descr string
uid
 uid True string

複数のスケジュールを保存

操作 ID:
DutiesSaveMultiple

複数のスケジュールを保存します。 必要に応じて、既存のスケジュールを上書きできます。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

設定するチームの ID
上書き
 overrideExisting boolean

true に設定された場合、既存のスケジュールを上書きまたはカットします。
終了
 end date-time
id
 id string
options
 options integer
start
 start date-time
userId
 userId string

戻り値

返答
array of ScheduleInfo

複数のチームのチーム任務設定を取得する

操作 ID:
TeamsGetDutySettings

複数のチームのチーム任務設定を取得します。

パラメーター

名前 キー 必須 型 説明
チームの ID
 teamId array

チームの ID です。

戻り値

Body
MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

複数の確認応答をキューに取り消す

操作 ID:
AlertsUndoAcknowledgeMultiple

このメソッドは、キューを介して複数のアラートの確認の取り消をしようとします。 操作はバックグラウンドで処理されます。

パラメーター

名前 キー 必須 型 説明
alertIds
 alertIds True array of string
descr
 descr string
uid
 uid True string

通知を閉じる

操作 ID:
AlertsClose

通知を閉じます。

パラメーター

名前 キー 必須 型 説明
アラート ID
 alertId True string

アラートの承認二使用する ID です。
descr
 descr string
uid
 uid True string

戻り値

Body
V2.AlertInfo

定義

AlertAuditReportFileInfo

名前 パス 型 説明
fileName
 fileName string
fileSizeInBytes
 fileSizeInBytes integer
lastRecord
 lastRecord date-time
lastUpdated
 lastUpdated date-time
month
 month integer
year
 year integer

AlertEscalationModes

  • 0 = 管理者
  • 1 = チーム

  • 0 = 管理者
  • 1 = チーム
integer

AlertFilterActions

  • 0 = カット
  • 1 = 非表示
  • 2 = ミュート

  • 0 = カット
  • 1 = 非表示
  • 2 = ミュート
integer

AlertFilterModes

  • 0 = オフ
  • 1 = WhiteListAllCategories

  • 0 = オフ
  • 1 = WhiteListAllCategories
integer

AlertNotificationInfo

名前 パス 型 説明
address
 address string
deviceName
 deviceName string
lastUpdate
 lastUpdate date-time
messageStatus
 messageStatus AlertNotificationInfoMessageStatus

  • 0 = なし
  • 1 = 却下済
  • 2 = 失敗
  • 3 = キュー登録済み
  • 4 = 送信済
  • 5 = バッファリング済み
  • 6 = 引き渡し済
  • 7 = 取り消し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 10 = 遅延
messageStatusErrorCode
 messageStatusErrorCode integer
notificationChannelType
 notificationChannelType AlertNotificationInfoChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 電子メール
  • 4 = ボット
  • 8 = 音声
  • 16 = SMS
userId
 userId string
userStatus
 userStatus AlertNotificationInfoUserStatus

  • 0 = なし
  • 1 = MessageCreated
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles

AlertNotificationInfoChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 電子メール
  • 4 = ボット
  • 8 = 音声
  • 16 = SMS

  • 0 = なし
  • 1 = プッシュ
  • 2 = 電子メール
  • 4 = ボット
  • 8 = 音声
  • 16 = SMS
integer

AlertNotificationInfoMessageStatus

  • 0 = なし
  • 1 = 却下済
  • 2 = 失敗
  • 3 = キュー登録済み
  • 4 = 送信済
  • 5 = バッファリング済み
  • 6 = 引き渡し済
  • 7 = 取り消し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 10 = 遅延

  • 0 = なし
  • 1 = 却下済
  • 2 = 失敗
  • 3 = キュー登録済み
  • 4 = 送信済
  • 5 = バッファリング済み
  • 6 = 引き渡し済
  • 7 = 取り消し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 10 = 遅延
integer

AlertNotificationInfoUserStatus

  • 0 = なし
  • 1 = MessageCreated
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles

  • 0 = なし
  • 1 = MessageCreated
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles
integer

AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
integer

AlertSettings

名前 パス 型 説明
escEnabled
 escEnabled boolean
escMode
 escMode AlertEscalationModes

  • 0 = 管理者
  • 1 = チーム
escRefId
 escRefId string
filterAction
 filterAction AlertFilterActions

  • 0 = カット
  • 1 = 非表示
  • 2 = ミュート
filterMode
 filterMode AlertFilterModes

  • 0 = オフ
  • 1 = WhiteListAllCategories
notificationProfileOverrides
 notificationProfileOverrides array of AlertSettingsNotificationProfile
optOut
 optOut TeamCategoryOptOutModes

  • 0 = なし
  • 1 = 無効
  • 2 = パーソナル
overrideNotificationProfiles
 overrideNotificationProfiles boolean
persNotInterval
 persNotInterval integer
persNotMode
 persNotMode PersistentNotificationModes

  • 0 = オフ
  • 1 = 概要
responseMode
 responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer

AlertSettingsChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
integer

AlertSettingsNotificationProfile

名前 パス 型 説明
channel
 channel AlertSettingsChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
delay
 delay integer
enabled
 enabled boolean

CategoryAugmentation

名前 パス 型 説明
enabled
 enabled boolean
id
 id string
名称
 name string
タイプ
 type CategoryAugmentationType

  • 0 = パラメーター
  • 1 = 件名
  • 2 = テキスト
  • 3 = 場所
価値
 value string

CategoryAugmentationType

  • 0 = パラメーター
  • 1 = 件名
  • 2 = テキスト
  • 3 = 場所

  • 0 = パラメーター
  • 1 = 件名
  • 2 = テキスト
  • 3 = 場所
integer

CategoryEnrichment

名前 パス 型 説明
id
 id string
名称
 name string
タイプ
 type CategoryEnrichmentType

  • 0 = パラメーター
  • 1 = ハイパーリンク
価値
 value string

CategoryEnrichmentType

  • 0 = パラメーター
  • 1 = ハイパーリンク

  • 0 = パラメーター
  • 1 = ハイパーリンク
integer

CategoryInfo

名前 パス 型 説明
augmentations
 augmentations array of CategoryAugmentation
color
 color string
enrichments
 enrichments array of CategoryEnrichment
id
 id string
imageName
 imageName string
isDefault
 isDefault boolean
keywordMatching
 keywordMatching KeywordMatchingType

  • 0 = いずれか
  • 1 = すべて
keywords
 keywords array of string
keywordsExcluded
 keywordsExcluded array of string
名称
 name string
options
 options CategoryInfoOptions

  • 0 = なし
  • 1 = 非表示
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
注文
 order integer
teamId
 teamId string

CategoryInfoOptions

  • 0 = なし
  • 1 = 非表示
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords

  • 0 = なし
  • 1 = 非表示
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
integer

CategoryMetrics

名前 パス 型 説明
categoryId
 categoryId string
last24h
 last24h integer
lastAlert
 lastAlert date-time
subscriberCount
 subscriberCount integer

CategorySubscriptionInfo

名前 パス 型 説明
ステータス
 status CategorySubscriptionStatus

  • 0 = サブスクライブ済み
  • 1 = ミュート済み
  • 2 = 非表示
userId
 userId string

CategorySubscriptionStatus

  • 0 = サブスクライブ済み
  • 1 = ミュート済み
  • 2 = 非表示

  • 0 = サブスクライブ済み
  • 1 = ミュート済み
  • 2 = 非表示
integer

ChannelPriceInfo

名前 パス 型 説明
sms
 sms integer
voicePerMinute
 voicePerMinute integer

DutySummaryInfo

名前 パス 型 説明
dutyEnd
 dutyEnd date-time
dutyId
 dutyId string
dutyStart
 dutyStart date-time

EventParameterInfo

名前 パス 型 説明
名称
 name string
注文
 order integer
タイプ
 type EventParameterTypes

  • 0 = なし
  • 1 = オブジェクト
  • 2 = 配列
  • 3 = コンストラクター
  • 4 = プロパティ
  • 5 = コメント
  • 6 = 整数
  • 7 = 浮動小数
  • 8 = 文字列
  • 9 = ブール値
  • 10 = Null
  • 11 = 未定義
  • 12 = 日付
  • 13 = 未加工
  • 14 = バイト
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
価値
 value string

EventParameterTypes

  • 0 = なし
  • 1 = オブジェクト
  • 2 = 配列
  • 3 = コンストラクター
  • 4 = プロパティ
  • 5 = コメント
  • 6 = 整数
  • 7 = 浮動小数
  • 8 = 文字列
  • 9 = ブール値
  • 10 = Null
  • 11 = 未定義
  • 12 = 日付
  • 13 = 未加工
  • 14 = バイト
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html

  • 0 = なし
  • 1 = オブジェクト
  • 2 = 配列
  • 3 = コンストラクター
  • 4 = プロパティ
  • 5 = コメント
  • 6 = 整数
  • 7 = 浮動小数
  • 8 = 文字列
  • 9 = ブール値
  • 10 = Null
  • 11 = 未定義
  • 12 = 日付
  • 13 = 未加工
  • 14 = バイト
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
integer

EventSeverities

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大
integer

EventSourceEndpointInfo

名前 パス 型 説明
address
 address string
description
 description string
無効
 disabled boolean
groupId
 groupId string
id
 id string
lastEvent
 lastEvent date-time
名称
 name string
SubType
 subType string
subscriptionId
 subscriptionId string
teamId
 teamId string
タイプ
 type EventSourceTypes

  • 0 = なし
  • 1 = 電子メール
  • 2 = WebHook
  • 3 = スクリプト
  • 4 = システム
  • 5 = 手動
  • 6 = 音声
  • 7 = Api

EventSourceTypes

  • 0 = なし
  • 1 = 電子メール
  • 2 = WebHook
  • 3 = スクリプト
  • 4 = システム
  • 5 = 手動
  • 6 = 音声
  • 7 = Api

  • 0 = なし
  • 1 = 電子メール
  • 2 = WebHook
  • 3 = スクリプト
  • 4 = システム
  • 5 = 手動
  • 6 = 音声
  • 7 = Api
integer

EventStatusCodes

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = エラー

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = エラー
integer

InventoryScriptInfo

名前 パス 型 説明
構成
 config
データ
 data ScriptDescriptionData
eventPattern
 eventPattern
localizationDetails
 localizationDetails array of ScriptLocalizationDetail
scriptId
 scriptId string
scriptName
 scriptName string
可視性
 visibility string

KeywordMatchingType

  • 0 = いずれか
  • 1 = すべて

  • 0 = いずれか
  • 1 = すべて
integer

LocationInfo

名前 パス 型 説明
緯度
 latitude double
緯度
 longitude double
timestamp
 timestamp date-time

MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

名前 パス 型 説明
データ
 data array of EventSourceEndpointInfo
errors
 errors array of V2.EventSourceEndpointError

MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

名前 パス 型 説明
データ
 data array of TeamDutySummaryInfo
errors
 errors array of V2.TeamDutySummaryError

MultiTeamResult-2-UserDutyInfo-V2.DutyError-

名前 パス 型 説明
データ
 data array of UserDutyInfo
errors
 errors array of V2.DutyError

MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

名前 パス 型 説明
データ
 data array of V2.AlertCountsDetails
errors
 errors array of V2.AlertReportError

MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

名前 パス 型 説明
データ
 data array of V2.AlertSettingsDetails
errors
 errors array of V2.AlertSettingsError

MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

名前 パス 型 説明
データ
 data array of V2.CategoryDetails
errors
 errors array of V2.CategoryError

MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

名前 パス 型 説明
データ
 data array of V2.TeamDutySettingsDetails
errors
 errors array of V2.TeamDutySettingsError

MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

名前 パス 型 説明
データ
 data array of V2.TeamPermissions
errors
 errors array of V2.PermissionError

MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

名前 パス 型 説明
データ
 data array of V2.UserDetails
errors
 errors array of V2.TeamUserError

MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

名前 パス 型 説明
データ
 data array of V2.UserDutyDetails
errors
 errors array of V2.DutyChangeError

OverviewEvent

名前 パス 型 説明
acknowledgedAlerts
 acknowledgedAlerts array of string
alertId
 alertId string
categoryId
 categoryId string
closedAlerts
 closedAlerts array of string
creationTime
 creationTime date-time
eventSourceGroupId
 eventSourceGroupId string
eventSourceId
 eventSourceId string
eventSourceTeamId
 eventSourceTeamId string
eventSourceType
 eventSourceType EventSourceTypes

  • 0 = なし
  • 1 = 電子メール
  • 2 = WebHook
  • 3 = スクリプト
  • 4 = システム
  • 5 = 手動
  • 6 = 音声
  • 7 = Api
eventStatus
 eventStatus EventStatusCodes

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = エラー
id
 id string
lastModified
 lastModified date-time
重要度
 severity EventSeverities

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大
teamId
 teamId string
text
 text string
肩書き
 title string

PagedResultsPublicContinuationToken

名前 パス 型 説明
nextPartitionKey
 nextPartitionKey string
nextRowKey
 nextRowKey string
nextTableName
 nextTableName string

PagedResultsPublic-1-OverviewEvent-

名前 パス 型 説明
continuationToken
 continuationToken PagedResultsPublicContinuationToken
hasMore
 hasMore boolean
results
 results array of OverviewEvent

PagedResultsPublic-1-V2.AlertInfo-

名前 パス 型 説明
continuationToken
 continuationToken PagedResultsPublicContinuationToken
hasMore
 hasMore boolean
results
 results array of V2.AlertInfo

PagedResultsPublic-1-V2.RemoteJob-

名前 パス 型 説明
continuationToken
 continuationToken PagedResultsPublicContinuationToken
hasMore
 hasMore boolean
results
 results array of V2.RemoteJob

PersistentNotificationModes

  • 0 = オフ
  • 1 = 概要

  • 0 = オフ
  • 1 = 概要
integer

PrepaidBalanceInfo

名前 パス 型 説明
残高
 balance integer
latestTopUp
 latestTopUp date-time
pendingTransactions
 pendingTransactions boolean

PrepaidSettingsInfo

名前 パス 型 説明
topUpAmount
 topUpAmount integer
topUpEnabled
 topUpEnabled boolean
topUpLimit
 topUpLimit integer

PrepaidTransactionInfo

名前 パス 型 説明
amount
 amount integer
autoTopUpId
 autoTopUpId string
created
 created date-time
createdBy
 createdBy string
通過
 currency string
修正日時
 modified date-time
packageCode
 packageCode string
ステータス
 status string
状態Code
 statusCode integer
subscriptionId
 subscriptionId string
transactionId
 transactionId string

ScheduleInfo

名前 パス 型 説明
終了
 end date-time
id
 id string
options
 options integer
start
 start date-time
userId
 userId string

ScriptDescriptionData

名前 パス 型 説明
description
 description string
名称
 name string
scriptType
 scriptType string
shortDescription
 shortDescription string

ScriptInstanceDetails

名前 パス 型 説明
構成
 config
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
enabled
 enabled boolean
eventPattern
 eventPattern
eventSourceId
 eventSourceId string
instanceId
 instanceId string
lastModified
 lastModified date-time
runtimeInformation
 runtimeInformation ScriptInstanceInfoRuntimeInformationModel
scriptId
 scriptId string
scriptName
 scriptName string
subscriptionId
 subscriptionId string
teamId
 teamId string
webhookUrl
 webhookUrl string

ScriptInstanceInfo

名前 パス 型 説明
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
enabled
 enabled boolean
eventPattern
 eventPattern
eventSourceId
 eventSourceId string
instanceId
 instanceId string
lastModified
 lastModified date-time
runtimeInformation
 runtimeInformation ScriptInstanceInfoRuntimeInformationModel
scriptId
 scriptId string
scriptName
 scriptName string
subscriptionId
 subscriptionId string
teamId
 teamId string

ScriptInstanceInfoRuntimeInformationModel

名前 パス 型 説明
runtimeStatus
 runtimeStatus ScriptInstanceInfoRuntimeStatus

  • 0 = 不明
  • 1 = 開始日
  • 2 = OK
  • 3 = 停止中
  • 4 = 停止済み
  • -1 = エラー
runtimeStatusMessage
 runtimeStatusMessage string

ScriptInstanceInfoRuntimeStatus

  • 0 = 不明
  • 1 = 開始日
  • 2 = OK
  • 3 = 停止中
  • 4 = 停止済み
  • -1 = エラー

  • 0 = 不明
  • 1 = 開始日
  • 2 = OK
  • 3 = 停止中
  • 4 = 停止済み
  • -1 = エラー
integer

ScriptLocalizationDetail

名前 パス 型 説明
構成
 config
データ
 data ScriptDescriptionData
language
 language string

SubscriptionFeature

名前 パス 型 説明
名称
 name string
タイプ
 type integer
価値
 value string

SubscriptionInfo

名前 パス 型 説明
branchId
 branchId string
国
 country string
通過
 currency string
externalAccountId
 externalAccountId string
id
 id string
名称
 name string
nextBilling
 nextBilling date-time
ownerId
 ownerId string
planCode
 planCode string
planState
 planState integer
referralEnabled
 referralEnabled boolean
ステータス
 status integer

TeamCategoryOptOutModes

  • 0 = なし
  • 1 = 無効
  • 2 = パーソナル

  • 0 = なし
  • 1 = 無効
  • 2 = パーソナル
integer

TeamDutySummaryInfo

名前 パス 型 説明
dutyAssistEnabled
 dutyAssistEnabled boolean
dutySummaries
 dutySummaries array of DutySummaryInfo
teamId
 teamId string

TeamInfo

名前 パス 型 説明
id
 id string
imageLastModified
 imageLastModified date-time
memberIds
 memberIds array of string
名称
 name string
setupProgressEnabled
 setupProgressEnabled boolean
subscriptionId
 subscriptionId string
タイムゾーン
 timezone string

TeamSetupProgress

名前 パス 型 説明
completedSteps
 completedSteps array of string
teamId
 teamId string
timestamp
 timestamp date-time

UserDutyInfo

名前 パス 型 説明
lastChange
 lastChange date-time
onDuty
 onDuty boolean
onManagerDuty
 onManagerDuty boolean
overdue
 overdue boolean
teamId
 teamId string
userId
 userId string

UserImage

名前 パス 型 説明
コンテント
 content byte
contentDispostion
 contentDispostion string
contentEncoding
 contentEncoding string
contentType
 contentType string
lastModified
 lastModified date-time
名称
 name string

ユーザー情報

名前 パス 型 説明
colorIndex
 colorIndex integer
contactAddresses
 contactAddresses array of
dutyInfos
 dutyInfos UserDutyInfo
externalAuthProvider
 externalAuthProvider string
id
 id string
isDeactivated
 isDeactivated boolean
isInvite
 isInvite boolean
isRemoteActionPinSet
 isRemoteActionPinSet boolean
lastSeen
 lastSeen date-time
メール
 mail string
名称
 name string
roleId
 roleId string
subscriptionId
 subscriptionId string
timeZone
 timeZone string
userImageLastModified
 userImageLastModified date-time

UserLicenseInfo

名前 パス 型 説明
currentUsers
 currentUsers integer
isFree
 isFree boolean
試用版です
 isTrial boolean
licensedUsers
 licensedUsers integer
planCode
 planCode string

UserPermission

名前 パス 型 説明
allowed
 allowed boolean
アクセス許可
 permission string

UserSetupProgress

名前 パス 型 説明
completedSteps
 completedSteps array of string
timestamp
 timestamp date-time
userId
 userId string

V2.AlertAnnotationDetails

名前 パス 型 説明
id
 id string
teamId
 teamId string
text
 text string
timestamp
 timestamp date-time
タイプ
 type V2.AlertAnnotationTypes

  • 0 = なし
  • 1 = テキスト
  • 2 = 画像
userId
 userId string

V2.AlertAnnotationTypes

  • 0 = なし
  • 1 = テキスト
  • 2 = 画像

  • 0 = なし
  • 1 = テキスト
  • 2 = 画像
integer

V2.AlertAttachmentInfo

名前 パス 型 説明
contentType
 contentType string
id
 id string
名称
 name string

V2.AlertCategoryCountsDetails

名前 パス 型 説明
acknowledged
 acknowledged integer
categoryId
 categoryId string
closed
 closed integer
unhandled
 unhandled integer

V2.AlertCountTypes

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours
integer

V2.AlertCountsDetails

名前 パス 型 説明
acknowledged
 acknowledged integer
categoryCounts
 categoryCounts array of V2.AlertCategoryCountsDetails
closed
 closed integer
終了
 end date-time
lastModified
 lastModified date-time
start
 start date-time
subscriptionId
 subscriptionId string
teamId
 teamId string
タイプ
 type V2.AlertCountTypes

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours
typeString
 typeString string
unhandled
 unhandled integer
userId
 userId string

V2.AlertDeliveryStatusCodes

  • 0 = なし
  • 1 = オープン
  • 2 = 失敗
  • 4 = 送信済
  • 6 = 引き渡し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 22 = PartlyFailed
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified

  • 0 = なし
  • 1 = オープン
  • 2 = 失敗
  • 4 = 送信済
  • 6 = 引き渡し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 22 = PartlyFailed
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified
integer

V2.AlertDeliveryStatusDetails

名前 パス 型 説明
alertId
 alertId string
状態Code
 statusCode V2.AlertDeliveryStatusCodes

  • 0 = なし
  • 1 = オープン
  • 2 = 失敗
  • 4 = 送信済
  • 6 = 引き渡し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 22 = PartlyFailed
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified
userDeliveryStatus
 userDeliveryStatus array of V2.UserDeliveryStatus

V2.AlertDetails

名前 パス 型 説明
parameters
 parameters array of V2.EventParameterDetails
attachments
 attachments array of V2.AlertAttachmentInfo
categoryId
 categoryId string
escalations
 escalations array of V2.AlertEscalationDetails
eventId
 eventId string
externalId
 externalId string
フラグ
 flags V2.AlertFlags

  • 0 = なし
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
history
 history V2.AlertHistoryInfo
id
 id string
lastModified
 lastModified date-time
requiredAcknowledgements
 requiredAcknowledgements integer
重要度
 severity V2.AlertSeverities

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大
ステータス
 status V2.AlertStatusDetails
subscriptionId
 subscriptionId string
teamId
 teamId string
text
 text string
timelineEntries
 timelineEntries array of
肩書き
 title string
workflowType
 workflowType V2.AlertWorkflowTypes

  • 0 = なし
  • 1 = User
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2.AlertEscalationDetails

名前 パス 型 説明
alertId
 alertId string
alertStatus
 alertStatus V2.AlertStatusCodes

  • 0 = なし
  • 1 = オープン
  • 2 = 確認済み
  • 4 = クローズ
  • 8 = 返信なし
  • 16 = 失敗
  • 32 = エラー
escType
 escType V2.AlertEscalationType

  • 0 = なし
  • 1 = 管理者
  • 2 = チーム
ステータス
 status V2.AlertEscalationStatus

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = フィルターされた
  • 5 = 非表示
teamId
 teamId string
teamName
 teamName string
timestamp
 timestamp date-time

V2.AlertEscalationStatus

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = フィルターされた
  • 5 = 非表示

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = フィルターされた
  • 5 = 非表示
integer

V2.AlertEscalationType

  • 0 = なし
  • 1 = 管理者
  • 2 = チーム

  • 0 = なし
  • 1 = 管理者
  • 2 = チーム
integer

V2.AlertFlags

  • 0 = なし
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation

  • 0 = なし
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
integer

V2.AlertHistoryInfo

名前 パス 型 説明
acknowledgedAt
 acknowledgedAt date-time
acknowledgements
 acknowledgements array of string
closedAt
 closedAt date-time
closedBy
 closedBy string
created
 created date-time

V2.AlertInfo

名前 パス 型 説明
categoryId
 categoryId string
eventId
 eventId string
externalId
 externalId string
フラグ
 flags V2.AlertFlags

  • 0 = なし
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
history
 history V2.AlertHistoryInfo
id
 id string
lastModified
 lastModified date-time
requiredAcknowledgements
 requiredAcknowledgements integer
重要度
 severity V2.AlertSeverities

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大
ステータス
 status V2.AlertStatusDetails
subscriptionId
 subscriptionId string
teamId
 teamId string
text
 text string
肩書き
 title string
workflowType
 workflowType V2.AlertWorkflowTypes

  • 0 = なし
  • 1 = User
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2.AlertReportError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.AlertSettingsChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
integer

V2.AlertSettingsDetails

名前 パス 型 説明
escEnabled
 escEnabled boolean
escMode
 escMode AlertEscalationModes

  • 0 = 管理者
  • 1 = チーム
escRefId
 escRefId string
filterAction
 filterAction AlertFilterActions

  • 0 = カット
  • 1 = 非表示
  • 2 = ミュート
filterMode
 filterMode AlertFilterModes

  • 0 = オフ
  • 1 = WhiteListAllCategories
notificationProfileOverrides
 notificationProfileOverrides array of V2.AlertSettingsNotificationProfileDetails
optOut
 optOut TeamCategoryOptOutModes

  • 0 = なし
  • 1 = 無効
  • 2 = パーソナル
overrideNotificationProfiles
 overrideNotificationProfiles boolean
persNotInterval
 persNotInterval integer
persNotMode
 persNotMode PersistentNotificationModes

  • 0 = オフ
  • 1 = 概要
responseMode
 responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer
teamId
 teamId string

V2.AlertSettingsError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.AlertSettingsNotificationProfileDetails

名前 パス 型 説明
channel
 channel V2.AlertSettingsChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean

V2.AlertSeverities

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大
integer

V2.AlertStatusCodes

  • 0 = なし
  • 1 = オープン
  • 2 = 確認済み
  • 4 = クローズ
  • 8 = 返信なし
  • 16 = 失敗
  • 32 = エラー

  • 0 = なし
  • 1 = オープン
  • 2 = 確認済み
  • 4 = クローズ
  • 8 = 返信なし
  • 16 = 失敗
  • 32 = エラー
integer

V2.AlertStatusDetails

名前 パス 型 説明
alertDeliveryStatus
 alertDeliveryStatus V2.AlertDeliveryStatusDetails
状態Code
 statusCode V2.AlertStatusCodes

  • 0 = なし
  • 1 = オープン
  • 2 = 確認済み
  • 4 = クローズ
  • 8 = 返信なし
  • 16 = 失敗
  • 32 = エラー

V2.AlertWorkflowTypes

  • 0 = なし
  • 1 = User
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

  • 0 = なし
  • 1 = User
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency
integer

V2.AlertingPatternChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
integer

V2.AlertingPatternDetails

名前 パス 型 説明
categories
 categories array of string
escalationSettings
 escalationSettings V2.AlertingPatternEscalationSettings
id
 id string
名称
 name string
notificationProfileOverrides
 notificationProfileOverrides array of V2.AlertingPatternNotificationProfileDetails
overrideEscalationSettings
 overrideEscalationSettings boolean
overrideNotificationProfiles
 overrideNotificationProfiles boolean
overrideResponseSettings
 overrideResponseSettings boolean
responseSettings
 responseSettings V2.AlertingPatternResponseSettings
suppressSignl
 suppressSignl boolean
timeSlots
 timeSlots array of V2.TimeSlotDetails

V2.AlertingPatternEscalationSettings

名前 パス 型 説明
enabled
 enabled boolean
mode
 mode AlertEscalationModes

  • 0 = 管理者
  • 1 = チーム
referenceId
 referenceId string

V2.AlertingPatternNotificationProfileDetails

名前 パス 型 説明
channel
 channel V2.AlertingPatternChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 音声
  • 3 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean

V2.AlertingPatternResponseSettings

名前 パス 型 説明
responseMode
 responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer

V2.CalloutTemplateDetails

名前 パス 型 説明
categoryId
 categoryId string
externalId
 externalId string
id
 id string
location
 location string
名称
 name string
subject
 subject string
targetAllTeams
 targetAllTeams boolean
targetTeamId
 targetTeamId string
text
 text string
workflowType
 workflowType V2.CalloutTemplateWorkflowType

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2.CalloutTemplateWorkflowType

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency
integer

V2.CategoryAugmentationDetails

名前 パス 型 説明
enabled
 enabled boolean
id
 id string
名称
 name string
タイプ
 type V2.CategoryAugmentationType

  • 0 = パラメーター
  • 1 = 件名
  • 2 = テキスト
  • 3 = 場所
価値
 value string

V2.CategoryAugmentationType

  • 0 = パラメーター
  • 1 = 件名
  • 2 = テキスト
  • 3 = 場所

  • 0 = パラメーター
  • 1 = 件名
  • 2 = テキスト
  • 3 = 場所
integer

V2.CategoryDetails

名前 パス 型 説明
augmentations
 augmentations array of V2.CategoryAugmentationDetails
color
 color string
enrichments
 enrichments array of V2.CategoryEnrichmentDetails
id
 id string
imageName
 imageName string
isDefault
 isDefault boolean
keywordMatching
 keywordMatching V2.KeywordMatchingType

  • 0 = いずれか
  • 1 = すべて
keywords
 keywords array of string
keywordsExcluded
 keywordsExcluded array of string
名称
 name string
options
 options V2.CategoryOptions

  • 0 = なし
  • 1 = 非表示
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
注文
 order integer
teamId
 teamId string

V2.CategoryEnrichmentDetails

名前 パス 型 説明
id
 id string
名称
 name string
タイプ
 type V2.CategoryEnrichmentType

  • 0 = パラメーター
  • 1 = ハイパーリンク
価値
 value string

V2.CategoryEnrichmentType

  • 0 = パラメーター
  • 1 = ハイパーリンク

  • 0 = パラメーター
  • 1 = ハイパーリンク
integer

V2.CategoryError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.CategoryOptions

  • 0 = なし
  • 1 = 非表示
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords

  • 0 = なし
  • 1 = 非表示
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
integer

V2.ChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 電子メール
  • 4 = ボット
  • 8 = 音声
  • 16 = SMS

  • 0 = なし
  • 1 = プッシュ
  • 2 = 電子メール
  • 4 = ボット
  • 8 = 音声
  • 16 = SMS
integer

V2.DutyChangeError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string
userId
 userId string

V2.DutyError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.DutyModes

  • 0 = なし
  • 1 = プライマリ
  • 100 = 管理者

  • 0 = なし
  • 1 = プライマリ
  • 100 = 管理者
integer

V2.EventDetails

名前 パス 型 説明
parameters
 parameters array of V2.EventParameterDetails
acknowledgedAlerts
 acknowledgedAlerts array of string
closedAlerts
 closedAlerts array of string
creationTime
 creationTime date-time
eventSourceGroupId
 eventSourceGroupId string
eventSourceId
 eventSourceId string
eventSourceTeamId
 eventSourceTeamId string
eventSourceType
 eventSourceType V2.EventSourceTypes

  • 0 = なし
  • 1 = 電子メール
  • 2 = WebHook
  • 3 = スクリプト
  • 4 = システム
  • 5 = 手動
  • 6 = 音声
  • 7 = Api
eventStatus
 eventStatus V2.EventStatusCodes

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = エラー
externalId
 externalId string
送信元
 from string
id
 id string
lastModified
 lastModified date-time
重要度
 severity V2.EventSeverities

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大
対象
 targets array of V2.EventTargetDetails
text
 text string
肩書き
 title string

V2.EventParameterDetails

名前 パス 型 説明
id
 id string
名称
 name string
options
 options V2.EventParameterOptions

  • 0 = なし
  • 1 = ExcludeFromCategorization
注文
 order integer
タイプ
 type V2.EventParameterTypes

  • 0 = なし
  • 1 = オブジェクト
  • 2 = 配列
  • 3 = コンストラクター
  • 4 = プロパティ
  • 5 = コメント
  • 6 = 整数
  • 7 = 浮動小数
  • 8 = 文字列
  • 9 = ブール値
  • 10 = Null
  • 11 = 未定義
  • 12 = 日付
  • 13 = 未加工
  • 14 = バイト
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
価値
 value string

V2.EventParameterOptions

  • 0 = なし
  • 1 = ExcludeFromCategorization

  • 0 = なし
  • 1 = ExcludeFromCategorization
integer

V2.EventParameterTypes

  • 0 = なし
  • 1 = オブジェクト
  • 2 = 配列
  • 3 = コンストラクター
  • 4 = プロパティ
  • 5 = コメント
  • 6 = 整数
  • 7 = 浮動小数
  • 8 = 文字列
  • 9 = ブール値
  • 10 = Null
  • 11 = 未定義
  • 12 = 日付
  • 13 = 未加工
  • 14 = バイト
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html

  • 0 = なし
  • 1 = オブジェクト
  • 2 = 配列
  • 3 = コンストラクター
  • 4 = プロパティ
  • 5 = コメント
  • 6 = 整数
  • 7 = 浮動小数
  • 8 = 文字列
  • 9 = ブール値
  • 10 = Null
  • 11 = 未定義
  • 12 = 日付
  • 13 = 未加工
  • 14 = バイト
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
integer

V2.EventSeverities

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大

  • 0 = 低
  • 1 = メジャー
  • 2 = 重大
integer

V2.EventSourceEndpointError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.EventSourceTypes

  • 0 = なし
  • 1 = 電子メール
  • 2 = WebHook
  • 3 = スクリプト
  • 4 = システム
  • 5 = 手動
  • 6 = 音声
  • 7 = Api

  • 0 = なし
  • 1 = 電子メール
  • 2 = WebHook
  • 3 = スクリプト
  • 4 = システム
  • 5 = 手動
  • 6 = 音声
  • 7 = Api
integer

V2.EventStatusCodes

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = エラー

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = エラー
integer

V2.EventTargetDetails

名前 パス 型 説明
alertId
 alertId string
categoryId
 categoryId string
creationTime
 creationTime date-time
distributionId
 distributionId string
eventId
 eventId string
eventTargetStatus
 eventTargetStatus V2.EventTargetStatusCode

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 1000 = エラー
id
 id string
lastModified
 lastModified date-time
teamId
 teamId string

V2.EventTargetStatusCode

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 1000 = エラー

  • 0 = なし
  • 1 = 処理中
  • 2 = 署名済み
  • 3 = フィルターされた
  • 4 = 解決済み
  • 5 = 廃棄済み
  • 6 = 確認済み
  • 7 = 非表示
  • 1000 = エラー
integer

V2.HolidayDetails

名前 パス 型 説明
day
 day integer
month
 month V2.Month

  • 0 = 設定解除
  • 1 = 1 月
  • 2 = 2 月
  • 3 = 3 月
  • 4 = 4 月
  • 5 = 5 月
  • 6 = 6 月
  • 7 = 7 月
  • 8 = 8 月
  • 9 = 9 月
  • 10 = 10 月
  • 11 = 11 月
  • 12 = 12 月
repeating
 repeating boolean
year
 year integer

V2.InvitationResult

名前 パス 型 説明
errorCode
 errorCode integer
errorMessage
 errorMessage string
invitedUser
 invitedUser V2.InvitedUserInfo
成功
 success boolean

V2.InvitedUserInfo

名前 パス 型 説明
mailAddress
 mailAddress string
roleId
 roleId string
ステータス
 status V2.UserStatus

  • 0 = なし
  • 1 = 削除済み
  • 2 = Invited
  • 3 = アクティブ
userId
 userId string

V2.KeywordMatchingType

  • 0 = いずれか
  • 1 = すべて

  • 0 = いずれか
  • 1 = すべて
integer

V2.Month

  • 0 = 設定解除
  • 1 = 1 月
  • 2 = 2 月
  • 3 = 3 月
  • 4 = 4 月
  • 5 = 5 月
  • 6 = 6 月
  • 7 = 7 月
  • 8 = 8 月
  • 9 = 9 月
  • 10 = 10 月
  • 11 = 11 月
  • 12 = 12 月

  • 0 = 設定解除
  • 1 = 1 月
  • 2 = 2 月
  • 3 = 3 月
  • 4 = 4 月
  • 5 = 5 月
  • 6 = 6 月
  • 7 = 7 月
  • 8 = 8 月
  • 9 = 9 月
  • 10 = 10 月
  • 11 = 11 月
  • 12 = 12 月
integer

V2.NotificationProfileDetails

名前 パス 型 説明
channel
 channel V2.ChannelType

  • 0 = なし
  • 1 = プッシュ
  • 2 = 電子メール
  • 4 = ボット
  • 8 = 音声
  • 16 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean
options
 options integer
persistent
 persistent boolean

V2.OverlappingTimeSlotsDetails

名前 パス 型 説明
refId
 refId string
timeSlots
 timeSlots array of V2.TimeSlotDetails

V2.PermissionError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.PhoneNumberValidationStatus

  • 0 = NotValidated
  • 1 = Validated
  • 2 = CountryNotSupported

  • 0 = NotValidated
  • 1 = Validated
  • 2 = CountryNotSupported
integer

V2.RemoteActionDefinitionDetails

名前 パス 型 説明
parameters
 parameters array of V2.RemoteActionDefinitionParameterDetails
createdAt
 createdAt date-time
description
 description string
executorService
 executorService string
externalId
 externalId string
id
 id string
名称
 name string
状態Code
 statusCode V2.RemoteActionDefinitionStatus

  • 0 = 無効
  • 1 = 有効
  • 2 = 無効
statusDescription
 statusDescription string
タイプ
 type V2.RemoteActionTypes

  • 0 = 不明
  • 1 = スクリプト
  • 2 = EnterpriseAlert
  • 3 = Webhook
version
 version integer

V2.RemoteActionDefinitionParameterDetails

名前 パス 型 説明
controlType
 controlType V2.RemoteActionParameterControlTypes

  • 0 = テキスト
  • 1 = MultiLineText
  • 2 = 整数
  • 3 = ダブル
  • 4 = ブール
  • 5 = 時刻
  • 6 = 日付
  • 7 = タイムゾーン
  • 8 = パスワード
  • 9 = PIN
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = 候補
defaultValue
 defaultValue string
description
 description string
displayName
 displayName string
名称
 name string
options
 options V2.RemoteActionParameterOptions

  • 0 = なし
  • 1 = 必須
  • 2 = ロック
  • 4 = 暗号化
注文
 order integer
values
 values array of string

V2.RemoteActionDefinitionStatus

  • 0 = 無効
  • 1 = 有効
  • 2 = 無効

  • 0 = 無効
  • 1 = 有効
  • 2 = 無効
integer

V2.RemoteActionDetails

名前 パス 型 説明
parameters
 parameters array of V2.RemoteActionParameter
アクセス
 access array of V2.RemoteActionTeamAccessDetails
createdAt
 createdAt date-time
currentPrincipal
 currentPrincipal V2.RemoteActionPrincipalAccessDetails
definitionId
 definitionId string
definitionVersion
 definitionVersion integer
description
 description string
enabled
 enabled boolean
executorService
 executorService string
externalId
 externalId string
id
 id string
名称
 name string
状態Code
 statusCode V2.RemoteActionStatus

  • 0 = 無効
  • 1 = 有効
  • 2 = 無効
  • 4 = ProviderDisabled
statusDescription
 statusDescription string
subscriptionId
 subscriptionId string
teamId
 teamId string
タイプ
 type V2.RemoteActionTypes

  • 0 = 不明
  • 1 = スクリプト
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2.RemoteActionInfo

名前 パス 型 説明
アクセス
 access array of V2.RemoteActionTeamAccessDetails
createdAt
 createdAt date-time
currentPrincipal
 currentPrincipal V2.RemoteActionPrincipalAccessDetails
definitionId
 definitionId string
description
 description string
enabled
 enabled boolean
id
 id string
名称
 name string
状態Code
 statusCode V2.RemoteActionStatus

  • 0 = 無効
  • 1 = 有効
  • 2 = 無効
  • 4 = ProviderDisabled
statusDescription
 statusDescription string
subscriptionId
 subscriptionId string
teamId
 teamId string
タイプ
 type V2.RemoteActionTypes

  • 0 = 不明
  • 1 = スクリプト
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2.RemoteActionParameter

名前 パス 型 説明
controlType
 controlType V2.RemoteActionParameterControlTypes

  • 0 = テキスト
  • 1 = MultiLineText
  • 2 = 整数
  • 3 = ダブル
  • 4 = ブール
  • 5 = 時刻
  • 6 = 日付
  • 7 = タイムゾーン
  • 8 = パスワード
  • 9 = PIN
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = 候補
displayName
 displayName string
名称
 name string
options
 options V2.RemoteActionParameterOptions

  • 0 = なし
  • 1 = 必須
  • 2 = ロック
  • 4 = 暗号化
注文
 order integer
価値
 value string
values
 values array of string

V2.RemoteActionParameterControlTypes

  • 0 = テキスト
  • 1 = MultiLineText
  • 2 = 整数
  • 3 = ダブル
  • 4 = ブール
  • 5 = 時刻
  • 6 = 日付
  • 7 = タイムゾーン
  • 8 = パスワード
  • 9 = PIN
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = 候補

  • 0 = テキスト
  • 1 = MultiLineText
  • 2 = 整数
  • 3 = ダブル
  • 4 = ブール
  • 5 = 時刻
  • 6 = 日付
  • 7 = タイムゾーン
  • 8 = パスワード
  • 9 = PIN
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = 候補
integer

V2.RemoteActionParameterOptions

  • 0 = なし
  • 1 = 必須
  • 2 = ロック
  • 4 = 暗号化

  • 0 = なし
  • 1 = 必須
  • 2 = ロック
  • 4 = 暗号化
integer

V2.RemoteActionPrincipalAccessDetails

名前 パス 型 説明
canEdit
 canEdit boolean
canExecute
 canExecute boolean

V2.RemoteActionStatus

  • 0 = 無効
  • 1 = 有効
  • 2 = 無効
  • 4 = ProviderDisabled

  • 0 = 無効
  • 1 = 有効
  • 2 = 無効
  • 4 = ProviderDisabled
integer

V2.RemoteActionTeamAccessDetails

名前 パス 型 説明
canEdit
 canEdit boolean
canExecute
 canExecute boolean
teamId
 teamId string

V2.RemoteActionTypes

  • 0 = 不明
  • 1 = スクリプト
  • 2 = EnterpriseAlert
  • 3 = Webhook

  • 0 = 不明
  • 1 = スクリプト
  • 2 = EnterpriseAlert
  • 3 = Webhook
integer

V2.RemoteJob

名前 パス 型 説明
parameters
 parameters array of V2.RemoteJobParameter
actionId
 actionId string
activatedAt
 activatedAt date-time
createdAt
 createdAt date-time
creatorInfo
 creatorInfo V2.RemoteJobCreatorDetails
definitionId
 definitionId string
externalId
 externalId string
id
 id string
lastUpdate
 lastUpdate date-time
options
 options V2.RemoteJobOptions

  • 0 = なし
startedAt
 startedAt date-time
状態Code
 statusCode V2.RemoteJobStatusCodes

  • 0 = なし
  • 1 = 保留中
  • 2 = 準備完了
  • 4 = 実行
  • 8 = 実行済み
  • 16 = エラー
statusDescription
 statusDescription string
statusDetails
 statusDetails string
タイプ
 type V2.RemoteActionTypes

  • 0 = 不明
  • 1 = スクリプト
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2.RemoteJobCreatorDetails

名前 パス 型 説明
referenceId
 referenceId string
referenceName
 referenceName string
タイプ
 type V2.RemoteJobCreatorType

  • 0 = なし
  • 1 = User
  • 2 = ApiKey
  • 3 = システム

V2.RemoteJobCreatorType

  • 0 = なし
  • 1 = User
  • 2 = ApiKey
  • 3 = システム

  • 0 = なし
  • 1 = User
  • 2 = ApiKey
  • 3 = システム
integer

V2.RemoteJobOptions

  • 0 = なし

  • 0 = なし
integer

V2.RemoteJobParameter

名前 パス 型 説明
名称
 name string
価値
 value string

V2.RemoteJobStatusCodes

  • 0 = なし
  • 1 = 保留中
  • 2 = 準備完了
  • 4 = 実行
  • 8 = 実行済み
  • 16 = エラー

  • 0 = なし
  • 1 = 保留中
  • 2 = 準備完了
  • 4 = 実行
  • 8 = 実行済み
  • 16 = エラー
integer

V2.ScheduleDetails

名前 パス 型 説明
終了
 end date-time
id
 id string
options
 options integer
start
 start date-time
teamId
 teamId string
userId
 userId string

V2.TeamDutySettingsDetails

名前 パス 型 説明
autosnapEnabled
 autosnapEnabled boolean
dutyAssistantEnabled
 dutyAssistantEnabled boolean
dutyChangeNotificationsEnabled
 dutyChangeNotificationsEnabled boolean
dutyLength
 dutyLength integer
handoverDate
 handoverDate date-time
handoverTime
 handoverTime integer
handoverWeekDay
 handoverWeekDay integer
minMemberOnDuty
 minMemberOnDuty integer
schedulingEnabled
 schedulingEnabled boolean
shiftReportCarbonCopyMail
 shiftReportCarbonCopyMail string
shiftReportEnabled
 shiftReportEnabled boolean
teamId
 teamId string
タイムゾーン
 timezone string

V2.TeamDutySettingsError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.TeamDutySummaryError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
userId
 userId string

V2.TeamHolidayDetails

名前 パス 型 説明
holidays
 holidays array of V2.HolidayDetails
teamId
 teamId string

V2.TeamImageDetails

名前 パス 型 説明
コンテント
 content byte
contentDispostion
 contentDispostion string
contentEncoding
 contentEncoding string
contentType
 contentType string
lastModified
 lastModified date-time
名称
 name string

V2.TeamMembershipDetails

名前 パス 型 説明
mailAddress
 mailAddress string
memberSince
 memberSince date-time
roleId
 roleId string
ステータス
 status V2.UserStatus

  • 0 = なし
  • 1 = 削除済み
  • 2 = Invited
  • 3 = アクティブ
teamId
 teamId string
userId
 userId string

V2.TeamPermissions

名前 パス 型 説明
permissions
 permissions array of UserPermission
teamId
 teamId string

V2.TeamPrivacySettingsDetails

名前 パス 型 説明
hideContactAddresses
 hideContactAddresses boolean
hideDutyData
 hideDutyData boolean
hideForEscalation
 hideForEscalation boolean
teamId
 teamId string

V2.TeamPublicDetails

名前 パス 型 説明
id
 id string
名称
 name string
privacySettings
 privacySettings V2.TeamPrivacySettingsDetails

V2.TeamUserError

名前 パス 型 説明
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.TimeSlotDetails

名前 パス 型 説明
終了
 end V2.WeekTimeDetails
id
 id string
start
 start V2.WeekTimeDetails

V2.TimeSlotValidationResultDetails

名前 パス 型 説明
isOverlapping
 isOverlapping boolean
item
 item V2.TimeSlotDetails
overlappingTimeSlots
 overlappingTimeSlots array of V2.OverlappingTimeSlotsDetails
有効
 valid boolean

V2.UserDeliveryStatus

名前 パス 型 説明
状態Code
 statusCode V2.UserDeliveryStatusCodes

  • 0 = なし
  • 1 = オープン
  • 2 = 失敗
  • 4 = 送信済
  • 6 = 引き渡し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent
userId
 userId string

V2.UserDeliveryStatusCodes

  • 0 = なし
  • 1 = オープン
  • 2 = 失敗
  • 4 = 送信済
  • 6 = 引き渡し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent

  • 0 = なし
  • 1 = オープン
  • 2 = 失敗
  • 4 = 送信済
  • 6 = 引き渡し済
  • 8 = 保護
  • 9 = AbuseProtected
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent
integer

V2.UserDetails

名前 パス 型 説明
colorIndex
 colorIndex integer
contactAddresses
 contactAddresses array of
dutyInfos
 dutyInfos array of V2.UserDutyDetails
externalAuthProvider
 externalAuthProvider string
id
 id string
isDeactivated
 isDeactivated boolean
isInvite
 isInvite boolean
lastSeen
 lastSeen date-time
メール
 mail string
名称
 name string
remoteActionPinSet
 remoteActionPinSet boolean
subscriptionId
 subscriptionId string
timeZone
 timeZone string
userImageLastModified
 userImageLastModified date-time

V2.UserDutyDetails

名前 パス 型 説明
dutyMode
 dutyMode V2.DutyModes

  • 0 = なし
  • 1 = プライマリ
  • 100 = 管理者
lastChange
 lastChange date-time
onDutyTime
 onDutyTime integer
overdue
 overdue boolean
teamId
 teamId string
userId
 userId string

V2.UserLocaleResponseDetails

名前 パス 型 説明
id
 id string
language
 language string
timeZone
 timeZone string

V2.UserPhoneNumberDetails

名前 パス 型 説明
countryCode
 countryCode string
phoneNumber
 phoneNumber string
validationStatus
 validationStatus V2.PhoneNumberValidationStatus

  • 0 = NotValidated
  • 1 = Validated
  • 2 = CountryNotSupported

V2.UserStatus

  • 0 = なし
  • 1 = 削除済み
  • 2 = Invited
  • 3 = アクティブ

  • 0 = なし
  • 1 = 削除済み
  • 2 = Invited
  • 3 = アクティブ
integer

V2.WeekTimeDetails

名前 パス 型 説明
時間
 hour integer
分
 minutes integer
平日
 weekday V2.Weekday

  • 0 = 休日
  • 1 = 月曜日
  • 2 = 火曜日
  • 3 = 水曜日
  • 4 = 木曜日
  • 5 = 金曜日
  • 6 = 土曜日
  • 7 = 日曜日

V2.Weekday

  • 0 = 休日
  • 1 = 月曜日
  • 2 = 火曜日
  • 3 = 水曜日
  • 4 = 木曜日
  • 5 = 金曜日
  • 6 = 土曜日
  • 7 = 日曜日

  • 0 = 休日
  • 1 = 月曜日
  • 2 = 火曜日
  • 3 = 水曜日
  • 4 = 木曜日
  • 5 = 金曜日
  • 6 = 土曜日
  • 7 = 日曜日
integer

WebhookInfo

名前 パス 型 説明
description
 description string
enabled
 enabled boolean
extUrl
 extUrl string
id
 id string
名称
 name string
subId
 subId string
teamId
 teamId string

string

これは基本的なデータ型 '文字列' です。

binary

これは基本的なデータ型 'バイナリ' です。