5.4.8.3. 画面構成

5.4.8.3.1. インテグレーション

../../_images/user_guide-webhook-structure-top.jpg

図 5.740 インテグレーション画面

以下の各画面に遷移することができます。

5.4.8.3.2. アクション

アクション定義の一覧表示/詳細表示/新規作成/編集/削除を行う画面群です。

アクション定義が持つプロパティ項目は以下のとおりです。

項目

指定内容

省略

ActionID

アクション定義のID

〈自動〉

CreateTimestamp

定義の作成日時

〈自動〉

UpdateTimestamp

定義の更新日時

〈自動〉

Name

定義の表示名

不可

Comment

定義の説明

可

UserID

定義を作成したユーザー名

〈自動〉

WebAPI URI

HTTPリクエスト先URL

不可

WebAPI Method

HTTPメソッド

不可

WebAPI Token

HTTPリクエストに含めるWeb APIのトークン文字列

可

画面ごとに以下の操作を行うことができます。

  • 一覧画面

    リンク/ボタン

    操作内容

    Export

    定義ファイルをダウンロードする。

    Import

    定義ファイルをアップロードして追加登録する。

    Create New

    新規作成画面に遷移する。

    一覧の行クリック

    参照画面に遷移する。

  • 参照画面

    ボタン

    操作内容

    Back

    一覧画面に遷移する。

    Edit

    編集画面に遷移する。

    Copy

    表示中の情報が入力済みの新規作成画面に遷移する。

    Delete

    定義データを削除する。

  • 新規作成画面

    ボタン

    操作内容

    Back to list

    一覧画面に遷移する。

    Save

    入力した情報で定義を作成する。

  • 編集画面

    ボタン

    操作内容

    Back to list

    一覧画面に遷移する。

    Save

    入力した情報で定義を更新する。

画面例)

  • 一覧画面
    ../../_images/user_guide-webhook-structure-action-list.jpg

    図 5.741 アクション一覧画面

  • 新規作成画面
    ../../_images/user_guide-webhook-structure-action-createnew.jpg

    図 5.742 アクション新規作成画面

  • 参照画面
    ../../_images/user_guide-webhook-structure-action-details.jpg

    図 5.743 アクション参照画面

  • 編集画面
    ../../_images/user_guide-webhook-structure-action-edit.jpg

    図 5.744 アクション編集画面

参考

  • 定義データのアップロードによる追加登録処理結果(成功または失敗)は、アクション一覧画面の上部にメッセージ表示されます。

参考

  • 当該定義がエンドポイント定義に関連付けられている場合、削除画面下部に警告および関連定義のID一覧が表示されます。

5.4.8.3.3. スクリプト

スクリプト定義の一覧表示/詳細表示/新規作成/編集/削除を行う画面群です。

スクリプト定義が持つプロパティ項目は以下のとおりです。

項目

指定内容

省略

ScriptID

スクリプト定義のID

〈自動〉

CreateTimestamp

定義の作成日時

〈自動〉

UpdateTimestamp

定義の更新日時

〈自動〉

Name

定義の表示名

不可

Comment

定義の説明

可

UserID

定義を作成したユーザー名

〈自動〉

ScriptType

スクリプトの言語種類

不可

Script

データ書式変換処理内容

可

画面ごとに以下の操作を行うことができます。

  • 一覧画面

    リンク/ボタン

    操作内容

    Export

    定義ファイルをダウンロードする。

    Import

    定義ファイルをアップロードして追加登録する。

    Create New

    新規作成画面に遷移する。

    一覧の行クリック

    参照画面に遷移する。

  • 参照画面

    ボタン

    操作内容

    Back

    一覧画面に遷移する。

    Edit

    編集画面に遷移する。

    Copy

    表示中の情報が入力済みの新規作成画面に遷移する。

    Delete

    定義データを削除する。

  • 新規作成画面

    ボタン

    操作内容

    Back to list

    一覧画面に遷移する。

    Test

    InputJson 入力したJSON文字列に対してスクリプト処理をテストする。

    Save

    入力した情報で定義を作成する。

  • 編集画面

    ボタン

    操作内容

    Back to list

    一覧画面に遷移する。

    Test

    InputJson 入力したJSON文字列に対してスクリプト処理をテストする。

    Save

    入力した情報で定義を更新する。

画面例)

  • 一覧画面
    ../../_images/user_guide-webhook-structure-script-list.jpg

    図 5.745 スクリプト一覧画面

  • 新規作成画面
    ../../_images/user_guide-webhook-structure-script-createnew.jpg

    図 5.746 スクリプト新規作成画面

  • 参照画面
    ../../_images/user_guide-webhook-structure-script-details.jpg

    図 5.747 スクリプト参照画面

  • 編集画面
    ../../_images/user_guide-webhook-structure-script-edit.jpg

    図 5.748 スクリプト編集画面

参考

定義データのアップロードによる追加登録処理結果(成功または失敗)は、アクション一覧画面の上部にメッセージ表示されます。

参考

当該定義がエンドポイント定義に関連付けられている場合、削除画面下部に警告および関連定義のID一覧が表示されます。

5.4.8.3.4. エンドポイント

エンドポイント定義の一覧表示/詳細表示/新規作成/編集/削除を行う画面群です。

エンドポイント定義が持つプロパティ項目は以下のとおりです。

項目

指定内容

省略

EndpointID

エンドポイント定義のID

〈自動〉

Comment

定義の説明

可

Status

エンドポイントの有効化フラグ

〈自動〉

CreateTimestamp

定義の作成日時

〈自動〉

UpdateTimestamp

定義の更新日時

〈自動〉

TokenVersion

トークンの版番号

〈自動〉

TokenCreateTimestamp

トークンの作成/更新日時

〈自動〉

Token

イベント連携の受け付けに必要なトークン文字列

〈自動〉

UserID

定義を作成したユーザー名

〈自動〉

ActionID

使用するアクション定義のID

不可

ScriptID

使用するスクリプト定義のID

不可

画面ごとに以下の操作を行うことができます。

  • 一覧画面

    リンク/ボタン

    操作内容

    Export

    定義ファイルをダウンロードする。

    Import

    定義ファイルをアップロードして追加登録する。

    Create New

    新規作成画面に遷移する。

    一覧の行クリック

    参照画面に遷移する。

  • 参照画面

    ボタン

    操作内容

    Back

    一覧画面に遷移する。

    Edit

    編集画面に遷移する。

    Copy

    表示中の情報が入力済みの新規作成画面に遷移する。

    Delete

    定義データを削除する。

  • 新規作成画面

    ボタン

    操作内容

    Back to list

    一覧画面に遷移する。

    Save

    入力した情報で定義を作成する。

  • 編集画面

    ボタン

    操作内容

    Back to list

    一覧画面に遷移する。

    NewToken

    トークンを再発行する。

    Save

    入力した情報で定義を更新する。

画面例)

  • 一覧画面
    ../../_images/user_guide-webhook-structure-endpoint-list.jpg

    図 5.749 エンドポイント一覧画面

  • 新規作成画面
    ../../_images/user_guide-webhook-structure-endpoint-createnew.jpg

    図 5.750 エンドポイント新規作成画面

  • 参照画面
    ../../_images/user_guide-webhook-structure-endpoint-details.jpg

    図 5.751 エンドポイント参照画面

  • 編集画面
    ../../_images/user_guide-webhook-structure-endpoint-edit.jpg

    図 5.752 エンドポイント編集画面

注釈

定義データのアップロードによる追加登録処理結果(成功または失敗)は、アクション一覧画面の上部にメッセージ表示されます。

5.4.8.3.5. チケット

Webhookによるイベント連携の受付履歴および動作状態や結果を表示する画面群です。

チケットが持つプロパティ項目は以下のとおりです。

項目

指定内容

TicketID

チケットのID

CreateTimestamp

チケット情報の作成日時

UpdateTimestamp

チケット情報の更新日時

EndpointID

イベント連携を受け付けたエンドポイント定義のID

UserID

イベント連携を受け付けたエンドポイント定義を作成したユーザー名

BodyJsonStr

受け付けたイベント内容(HTTPリクエストBody)

JobID

イベント連携処理のID

Status

イベント連携処理の動作状態または結果
0:実行前 / 1:アクション実行中 / 2:終了 /
11:内部処理開始失敗 / 12:スクリプト実行失敗 / 13:アクション実行失敗

HttpPostJsonStr

アクション実行のHTTPリクエストBody(スクリプト実行結果)

HttpResponseCode

アクション実行結果のHTTPステータスコード

HttpResponseStr

アクション実行結果のHTTPレスポンスBody

ここで Status 項目の値が持つ意味は以下のとおりです。

項目

指定内容

0

実行前

1

実行中

2

正常終了

11

処理開始失敗

12

スクリプト実行失敗

13

アクション実行失敗

画面ごとに以下の操作を行うことができます。

  • 一覧画面

    リンク

    操作内容

    一覧の行クリック

    参照画面に遷移する。

  • 参照画面

    ボタン

    操作内容

    Back

    一覧画面に遷移する。

画面例)

  • 一覧画面
    ../../_images/user_guide-webhook-structure-ticket-list.jpg

    図 5.753 チケット一覧画面

  • 参照画面
    ../../_images/user_guide-webhook-structure-ticket-details.jpg

    図 5.754 チケット参照画面