ServiceDesk プラス V3

統合バージョン: 3.0

Chronicle SOAR と連携するように ServiceDesk Plus V3 を構成する

API トークンを生成する方法

  1. 管理者ユーザー コンソールに移動します。

    ServiceDesk Plus V3 コンソール

  2. これをクリックし、[Generate API Key] をクリックします。

    ServiceDesk Plus V3 コンソールで API キーを生成する

  3. ダイアログに鍵生成ステータスが表示されます。

    • 鍵をすでに生成している場合は、安全な場所に保管してください。それ以外の場合は、再生成する必要があります。
    • そうでない場合は [キーを生成] をクリックすると、API キーがすぐに表示されます。

    ServiceDesk Plus V3 コンソールで API キーを再生成する

Chronicle SOAR で ServiceDesk Plus V3 の統合を構成する

Chronicle SOAR で統合を構成する方法について詳しくは、統合を構成するをご覧ください。

統合のパラメータ

次のパラメータを使用して統合を構成します。

パラメータの表示名 種類 デフォルト値 必須 説明
API ルート 文字列 http://{IP OR FQDN}:8080/api/v3/ ServiceDesk Plus の API ルート。
API トークン 文字列 なし ServiceDesk Plus の API トークン。(「技術者」キーとも呼ばれます)
SSL を確認 チェックボックス オフ 有効になっている場合は、ServiceDesk Plus サーバーへの接続用の SSL 証明書が有効であることを確認します。

アクション

Ping

説明

[Chronicle Marketplace] タブの統合構成ページで提供されるパラメータを使用して、ServiceDesk Plus V3 への接続をテストします。

パラメータ

なし

ユースケース

このアクションは、[Chronicle Marketplace] タブの統合構成ページで接続をテストするために使用されます。ハンドブックでは使用できず、手動アクションとして実行できます。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

成功した場合: 「指定された接続パラメータを使用して ServiceDesk Plus V3 に正常に接続しました。」

アクションが失敗し、ハンドブックの実行が停止します。

認証情報の誤りや接続の切断などの重大なエラーが報告された場合:

「Failed to connect to the ServiceDesk Plus V3! エラー: {0}".format(exception.stacktrace)

一般

メモを追加

説明

リクエストにメモを追加します。

パラメータ

パラメータの表示名 種類 デフォルト値 必須 説明
リクエスト ID 文字列 なし リクエストの ID。
文字列 なし メモの内容。
リクエスト元に表示 チェックボックス オフ いいえ リクエスト送信者にメモを表示するかどうかを指定します。
技術者に通知する チェックボックス オフ いいえ リクエスト送信者にメモを表示するかどうかを指定します。
最初の回答としてマーク チェックボックス オフ いいえ このメモを最初の回答としてマークするかどうかを指定します。
リンクされたリクエストに追加 チェックボックス オフ いいえ リンクされたリクエストにこのメモを追加するかどうかを指定します。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
JSON の結果
{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "request_note": {
        "created_time": {
            "display_value": "Nov 10, 2020 01:14 AM",
            "value": "1690499678XXX"
        },
        "request": {
            "subject": "New Subject Dropdown",
            "id": "00"
        },
        "show_to_requester": false,
        "description": "New Note",
        "id": "23",
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        }
    }
}
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

成功した場合: 「ServiceDesk Plus リクエストにメモが正常に追加されました。リクエスト ID: {ID}、メモ ID: {note.id}」

「リクエスト ID」パラメータが見つからない場合:

「ServiceDesk Plus で ID {ID} を指定してリクエストにメモを追加できませんでした。理由: ID {ID} のリクエストが見つかりません。」

アクションが失敗し、ハンドブックの実行が停止します。

不成功の場合: 「アクション「メモの追加」の実行中にエラーが発生しました。理由: {0}''.format(error.Stacktrace)

一般

リクエストを閉じる

説明

リクエストを閉じます。

パラメータ

パラメータの表示名 種類 デフォルト値 必須 説明
リクエスト ID 文字列 なし リクエストの ID。
コメント 文字列 なし 終了のコメント。
解決したこと チェックボックス オフ いいえ リクエストの解決が確認されたかどうか。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
JSON の結果
{
    "response_status": {
        "status_code": 2000,
        "messages": [
            {
                "status_code": 2000,
                "type": "success",
                "message": "Request(s) closed successfully."
            }
        ],
        "status": "success"
    }
}
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

正常に終了した場合:

「Successfully closed ServiceDesk Plus request with ID {ID}」を出力します。

リクエスト ID が見つからない場合:

「Action has't closed request with ID {ID} in ServiceDesk Plus.」を出力します。理由: ID {ID} のリクエストが見つかりません。」

アクションが失敗し、ハンドブックの実行が停止します。

不成功の場合:

「エラーの実行エラー」「リクエストを閉じる」を出力します。理由: {0}''.format(error.Stacktrace)

一般

メモを追加して返信を待つ

説明

リクエストにメモを追加します。

パラメータ

パラメータの表示名 種類 デフォルト値 必須 説明
リクエスト ID 文字列 なし リクエストの ID。
文字列 なし メモの内容。
リクエスト元に表示 チェックボックス オフ いいえ リクエスト送信者にメモを表示するかどうかを指定します。
技術者に通知する チェックボックス オフ いいえ リクエスト送信者にメモを表示するかどうかを指定します。
最初の回答としてマーク チェックボックス オフ いいえ このメモを最初の回答としてマークするかどうかを指定します。
リンクされたリクエストに追加 チェックボックス オフ いいえ リンクされたリクエストにこのメモを追加するかどうかを指定します。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
JSON の結果
{
    "response_status": {
        "status": "Success",
        "statuscode": "2000"
    },
    "request_note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "created_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "created_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        }
    }
}
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

成功した場合: 「ServiceDesk Plus リクエストにメモが正常に追加されました。リクエスト ID: {ID}、メモ ID: {note.id}」

「リクエスト ID」パラメータが見つからない場合:

「ServiceDesk Plus で ID {ID} を指定してリクエストにメモを追加できませんでした。理由: ID {ID} のリクエストが見つかりません。」

アクションが失敗し、ハンドブックの実行が停止します。

不成功の場合: 「アクション「メモの追加」の実行中にエラーが発生しました。理由: {0}''.format(error.Stacktrace)

一般

アラート リクエストを作成する

説明

Chronicle SOAR アラートに関連するリクエストを作成します。

パラメータ

パラメータの表示名 種類 デフォルト値 必須 説明
件名 文字列 なし リクエストの件名。
リクエスト元 文字列 API キーのユーザー リクエストのリクエスト元。指定しない場合、API キーのユーザーに設定します。
アセット 文字列 なし いいえ リクエストに関連付けられるアセットの名前。
ステータス 文字列 なし いいえ リクエストのステータス。
技術者 文字列 なし いいえ リクエストに割り当てられた技術者の名前。
優先度 文字列 なし いいえ リクエストの優先度。
緊急度 文字列 なし いいえ リクエストの緊急度。
カテゴリ 文字列 なし いいえ リクエストのカテゴリ。
リクエスト テンプレート 文字列 なし いいえ リクエストのテンプレート。
リクエストの種類 文字列 なし いいえ

リクエストの種類。

例: インシデント、サービス リクエスト

時間別(ミリ秒) 文字列 なし いいえ リクエストの期限(ミリ秒単位)。
モード 文字列 なし いいえ

このリクエストが作成されるモード。

例: E-メール

レベル 文字列 なし いいえ リクエストのレベル。
サイト 文字列 なし いいえ このリクエストが属するサイトを示します。
グループ 文字列 なし いいえ このリクエストが属するグループ。
影響 文字列 なし いいえ リクエストの影響

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
JSON の結果
{
    "request": {
        "ola_due_by_time": null,
        "subject": "Test request number 2",
        "resolution": {
            "submitted_on": {
                "display_value": "Oct 28, 2020 09:31 PM",
                "value": "1603945909120"
            },
            "submitted_by": {
                "email_id": null,
                "name": "administrator",
                "is_vipuser": false,
                "id": "4",
                "department": null
            },
            "resolution_attachments": [],
            "content": "Mail Fetching Server problem has been fixed"
        },
        "linked_to_request": null,
        "mode": null,
        "lifecycle": null,
        "reason_for_cancel": null,
        "assets": [
            {
                "name": "servicedesk.workgroup",
                "id": "24"
            }
        ],
        "is_trashed": false,
        "id": "6",
        "assigned_time": null,
        "group": null,
        "requester": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "cancel_requested_by": null,
        "email_to": [],
        "created_time": {
            "display_value": "Oct 28, 2020 09:31 PM",
            "value": "1603945909120"
        },
        "item": null,
        "level": null,
        "has_resolution_attachments": false,
        "approval_status": null,
        "impact": null,
        "service_category": null,
        "sla": null,
        "priority": null,
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "scheduled_end_time": null,
        "tags": [],
        "first_response_due_by_time": null,
        "last_updated_time": null,
        "has_notes": false,
        "impact_details": "Routine tasks are pending due to mail server problem",
        "subcategory": null,
        "email_cc": [],
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "2"
        },
        "scheduled_start_time": null,
        "template": {
            "is_service_template": false,
            "name": "Default Request",
            "id": "1"
        },
        "email_ids_to_notify": [],
        "request_type": {
            "name": "Incident",
            "id": "1"
        },
        "cancel_requested_time": null,
        "description": "I am unable to fetch mails from the mail server",
        "has_dependency": false,
        "has_conversation": false,
        "callback_url": null,
        "chat_type": 0,
        "is_service_request": false,
        "urgency": null,
        "is_shared": false,
        "cancel_requested": false,
        "has_request_initiated_change": false,
        "request_template_task_ids": [],
        "department": null,
        "is_reopened": false,
        "has_draft": false,
        "has_attachments": false,
        "has_linked_requests": false,
        "is_overdue": false,
        "technician": null,
        "has_request_caused_by_change": false,
        "has_problem": false,
        "due_by_time": null,
        "has_project": false,
        "is_first_response_overdue": false,
        "cancel_requested_is_pending": false,
        "category": null
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

成功した場合: 「ServiceDesk Plus リクエストが正常に作成されました」

アクションが失敗し、ハンドブックの実行が停止します。

不成功の場合: 「アクション「Create Alert Request action」の実行中にエラーが発生しました。理由: {0}''.format(error.Stacktrace)

一般

リクエストを作成

説明

新しいリクエストを作成。

パラメータ

パラメータ 種類 デフォルト値 必須 説明
件名 文字列 なし リクエストの件名。
リクエスト元 文字列 API キーのユーザー リクエストのリクエスト元。指定しない場合、API キーのユーザーに設定します。
説明 文字列 なし いいえ リクエストの説明。
アセット 文字列 なし いいえ リクエストに関連付けられるアセットの名前。
ステータス 文字列 なし いいえ リクエストのステータス。
技術者 文字列 なし いいえ リクエストに割り当てられた技術者の名前。
優先度 文字列 なし いいえ リクエストの優先度。
緊急度 文字列 なし いいえ リクエストの緊急度。
カテゴリ 文字列 なし いいえ リクエストのカテゴリ。
リクエスト テンプレート 文字列 なし いいえ リクエストのテンプレート。
リクエストの種類 文字列 なし いいえ

リクエストの種類。

例: インシデント、サービス リクエスト

時間別(ミリ秒) 文字列 なし いいえ リクエストの期限(ミリ秒単位)。
モード 文字列 なし いいえ

このリクエストが作成されるモード。

例: E-メール

レベル 文字列 なし いいえ リクエストのレベル。
サイト 文字列 なし いいえ このリクエストが属するサイトを示します。
グループ 文字列 なし いいえ このリクエストが属するグループ。
影響 文字列 なし いいえ リクエストの影響

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

成功した場合: 「ServiceDesk Plus リクエストが正常に作成されました」

アクションが失敗し、ハンドブックの実行が停止します。

不成功の場合: 「アクション「リクエスト アクションの作成」の実行中にエラーが発生しました。理由: {0}''.format(error.Stacktrace)

一般

リクエストの取得

説明

ServiceDesk Plus でリクエストに関する情報を取得します。

パラメータ

パラメータ 種類 デフォルト値 必須 説明
リクエスト ID 文字列 なし リクエストの ID。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

成功した場合: 「ServiceDesk Plus のリクエスト(ID {ID})が正常に取得されました」

「リクエスト ID」パラメータが見つからない場合: 「ServiceDesk Plus で「アクションで ID {ID} のリクエストを取得できませんでした」。理由: ID {ID} のリクエストが見つかりません。」

アクションが失敗し、ハンドブックの実行が停止します。

不成功の場合: 「アクション「Get Request action」の実行中にエラーが発生しました。」理由: {0}''.format(error.Stacktrace)

一般

フィールドの更新を待つ

説明

リクエストのフィールドが目的の値に更新されるのを待ちます。

パラメータ

パラメータ 種類 デフォルト値 必須 説明
リクエスト ID 文字列 なし リクエストの ID。
フィールド名 文字列 なし 更新するフィールドの名前。
文字列 なし 指定したフィールドの目標値。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、Playbook の実行が停止したりすることはありません。

フィールドの待機(非同期アクション)タスクが正常に作成された場合: 「次のフィールドの分析タスクを作成しました: {0}".format([fields_list]).

指定されたすべてのフィールドに対して分析タスクを作成できない場合: 「ServiceDesk Plus の分析タスクが作成されました。」

フィールドの更新を待機している場合: 「次の更新を待機しているアクション」

アクションが失敗し、Playbook の実行が停止します。

認証情報の誤りや接続の切断などの重大なエラーが報告された場合: 「ServiceDesk サービスに接続できませんでした。 エラー: {0}」.format(exception.stacktrace)

一般

リクエストの更新

説明

ID を使用して ServiceDesk Plus リクエストを更新します。

パラメータ

パラメータ 種類 デフォルト値 必須 説明
リクエスト ID 文字列 なし True 更新するリクエストの ID。
件名 文字列 なし いいえ リクエストの件名。
リクエスト元 文字列 なし いいえ

リクエストのリクエスト元。

指定しない場合、API キーのユーザーに設定します。

説明 文字列 なし いいえ リクエストの説明。
アセット 文字列 なし いいえ

リクエストに関連付けられるアセットの名前。

このパラメータは、アセットの名前を含むカンマ区切りの文字列のリストを取得することもできます。

ステータス 文字列 なし いいえ リクエストのステータス。
技術者 文字列 なし いいえ リクエストに割り当てられた技術者の名前。
優先度 文字列 なし いいえ リクエストの優先度。
緊急度 文字列 なし いいえ リクエストの緊急度。
カテゴリ 文字列 なし いいえ リクエストのカテゴリ。
リクエスト テンプレート 文字列 なし いいえ リクエストのテンプレート。
リクエストの種類 文字列 なし いいえ

リクエストの種類。

例: インシデント、サービス リクエスト

時間別(ミリ秒) 文字列 なし いいえ リクエストの期限(ミリ秒単位)。
モード 文字列 なし いいえ

このリクエストが作成されるモード。

例: E-メール

レベル 文字列 なし いいえ リクエストのレベル。
サイト 文字列 なし いいえ このリクエストが属するサイトを示します。
グループ 文字列 なし いいえ このリクエストが属するグループ。
影響 文字列 なし いいえ リクエストの影響

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

成功した場合: 「ServiceDesk Plus のリクエスト(ID {ID})が正常に更新されました」

「リクエスト ID」パラメータが見つからない場合: 「ServiceDesk Plus で「アクションで ID {ID} のリクエストが更新されませんでした。理由: ID {ID} のリクエストが見つかりません。」

アクションが失敗し、ハンドブックの実行が停止します。

不成功の場合: 「アクション「Update Request action」の実行中にエラーが発生しました。理由: {0}''.format(error.Stacktrace)

一般

ステータス更新の待機

説明

リクエストのステータスが目的のステータスに更新されるまで待ちます。

パラメータ

パラメータ 種類 デフォルト値 必須 説明
リクエスト ID 文字列 なし リクエストの ID。
文字列 なし 指定したフィールドの目標値。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、Playbook の実行が停止したりすることはありません。

フィールドの待機(非同期アクション)タスクが正常に作成された場合: 「次のフィールドの分析タスクを作成しました: {0}".format([fields_list]).

指定されたすべてのフィールドの分析タスクの作成に失敗した場合: 「ServiceDesk Plus の分析タスクが作成されました」

フィールドの更新を待機している場合: 「次の更新を待機しているアクション」

アクションが失敗し、Playbook の実行が停止します。

認証情報の誤りや接続の切断などの重大なエラーが報告された場合: 「ServiceDesk サービスに接続できませんでした。 エラー: {0}".format(exception.stacktrace)

一般

リクエストの作成 - プルダウン リスト

説明

新しいリクエストを作成。

パラメータ

パラメータ 種類 デフォルト値 必須 説明
件名 文字列 なし リクエストの件名。
リクエスト元 文字列 なし いいえ リクエストのリクエスト元。指定しない場合、API キーのユーザーに設定します。
アセット 文字列 なし いいえ

リクエストに関連付けられるアセットの名前。

このパラメータは、アセットの名前を含むカンマ区切りの文字列のリストを取得することもできます。

説明 文字列 なし いいえ リクエストの説明。
ステータス DDL なし いいえ リクエストのステータス。
技術者 文字列 なし いいえ リクエストに割り当てられた技術者の名前。
優先度 DDL なし いいえ リクエストの優先度。
緊急度 DDL なし いいえ リクエストの緊急度。
カテゴリ DDL なし いいえ リクエストのカテゴリ。
リクエスト テンプレート 文字列 なし いいえ リクエストのテンプレート。
リクエストの種類 DDL なし いいえ

リクエストの種類。

例: インシデント、サービス リクエスト

時間別(ミリ秒) 文字列 なし いいえ リクエストの期限(ミリ秒単位)。
モード DDL なし いいえ

このリクエストが作成されるモード。

例: E-メール

レベル DDL なし いいえ リクエストのレベル。
サイト 文字列 なし いいえ このリクエストが属するサイトを示します。
グループ 文字列 なし いいえ このリクエストが属するグループ。
影響 DDL なし いいえ リクエストの影響

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果
スクリプトの結果名 値のオプション
is_success True/False is_success:False
ケースウォール
結果のタイプ 値 / 説明 種類
出力メッセージ*

アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。

成功した場合: 「ServiceDesk Plus リクエストが正常に作成されました」

アクションが失敗し、ハンドブックの実行が停止します。

不成功の場合: 「アクション「リクエスト アクションの作成」の実行中にエラーが発生しました。理由: {0}''.format(error.Stacktrace)

一般

ジョブ

タグでクローズされたリクエストを同期する

説明

Chronicle SOAR ケース ハンドブックと Chronicle SOAR ケース内で作成された ServiceDesk Plus V3 リクエストを同期します。

パラメータ

パラメータ 種類 デフォルト値 必須 説明
API ルート 文字列 http://{IP OR FQDN}:8080/api/v3/ ServiceDeskPlus インスタンスの API ルート。
API キー パスワード なし ServiceDeskPlus インスタンスの API キー。
最大遡及時間 整数 24 いいえ ステータスを同期するために遡る時間数を指定します。
SSL を確認 チェックボックス オン 有効になっている場合は、ServiceDeskPlus サーバーへの接続用の SSL 証明書が有効であることを確認します。