Freshservice (プレビュー)
Freshservice はクラウドベースの IT サービス デスクおよびサービス管理ソリューションであり、組織全体で従業員のエクスペリエンスを変革するために、設定と使用が簡単です。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 名前 | Freshworks アプリのサポート |
| URL | https://www.freshworks.com |
| appsupport-ex@freshworks.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.freshworks.com/freshservice/lp/home/ |
| プライバシー ポリシー | https://www.freshworks.com/privacy |
| カテゴリ | IT 運用 |
Authentication
Important
FreshService では、ユーザー名とパスワード ベースの認証はサポートされなくなりました。 コネクタでサポートされる認証の種類は API キーの 1 つだけになりました。 FreshService API の移行に関するドキュメント
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| API キー | API キー認証の種類 | すべてのリージョン | 共有不可 |
| 既定 [非推奨] | このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。 | すべてのリージョン | 共有不可 |
API キー
認証 ID: 基本
適用対象: すべてのリージョン
API キー認証の種類
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| API キー | 文字列 | この API の API キー | 正しい |
| サイト URL | 文字列 | ルート サイトの URL (例: https://sample.freshservice.com ) | 正しい |
既定 [非推奨]
適用対象: すべてのリージョン
このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| ユーザー名 | 文字列 | この API のユーザー名 | 正しい |
| パスワード | securestring | この API のパスワード | 正しい |
| サイト URL | 文字列 | ルート サイトの URL (例: https://sample.freshservice.com ) | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
| トリガーポーリングの頻度 | 1 | 120 秒 |
アクション
| チケットにメモを追加する (V2) |
チケットにプライベートノートまたはパブリックノートを追加します。 |
| チケットにメモを追加する [非推奨] |
チケットにプライベートノートまたはパブリックノートを追加します。 |
| チケットを作成する (V2) |
チケットを作成します。 |
| チケットを作成する [非推奨] |
チケットを作成します。 |
| チケットを更新する (V2) |
チケットを更新します (指定した値のみが更新されます)。 |
| チケットを更新する [非推奨] |
チケットを更新します (指定した値のみが更新されます)。 |
チケットにメモを追加する (V2)
チケットにプライベートノートまたはパブリックノートを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チケット ID
|
ticketId | True | integer |
更新するチケット ID。 |
|
注
|
body | True | string |
チケットに追加するメモ。 |
|
プライベートである
|
private | boolean |
メッセージがプライベートの場合は true に設定します。 |
戻り値
- Body
- AddNote_ResponseV2
チケットにメモを追加する [非推奨]
チケットにプライベートノートまたはパブリックノートを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チケット ID
|
ticketId | True | integer |
更新するチケット ID。 |
|
注
|
body | True | string |
チケットに追加するメモ。 |
|
プライベートである
|
private | boolean |
メッセージがプライベートの場合は true に設定します。 |
戻り値
- Body
- AddNote_Response
チケットを作成する (V2)
チケットを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
要求元 ID
|
requester_id | integer |
要求元のユーザー ID。 要求元 ID、要求元の電子メール、および要求元の電話のいずれかが必要です |
|
|
要求元の電子メール
|
string |
要求元の電子メール。 要求元 ID、要求元の電子メール、および要求元の電話のいずれかが必要です |
||
|
要求元の電話
|
phone | string |
要求元の電話番号。 要求元 ID、要求元の電子メール、および要求元の電話のいずれかが必要です |
|
|
要求元名
|
name | string |
要求元の名前。 これは、要求元の電話の値が指定されている場合にのみ必須フィールドです |
|
|
サブジェクト
|
subject | True | string |
チケットの件名。 |
|
ステータス
|
status | True | string |
チケットの状態。 |
|
Priority
|
priority | True | string |
チケットの優先順位 (低、中、高など)。 |
|
Description
|
description | True | string |
チケットの説明。 |
|
緊急度
|
urgency | string |
問題の緊急性 (低、中、高など)。 |
|
|
インパクト
|
impact | string |
問題の影響 (低、中、高など)。 |
|
|
情報源
|
source | string |
チケットが作成されたチャネル。 |
戻り値
チケットを作成する [非推奨]
チケットを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
要求元 ID
|
requester_id | True | integer |
要求元のユーザー ID。 既存の連絡先の場合は、電子メールではなくrequester_idを渡すことができます。 |
|
サブジェクト
|
subject | True | string |
チケットの件名。 |
|
ステータス
|
status | True | string |
チケットの状態。 |
|
Priority
|
priority | True | string |
チケットの優先順位 (低、中、高など)。 |
|
Description
|
description | True | string |
チケットの説明。 |
|
緊急度
|
urgency | string |
問題の緊急性 (低、中、高など)。 |
|
|
インパクト
|
impact | string |
問題の影響 (低、中、高など)。 |
|
|
情報源
|
source | string |
チケットが作成されたチャネル。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
helpdesk_ticket
|
item.helpdesk_ticket | Ticket_Response |
チケットを更新する (V2)
チケットを更新します (指定した値のみが更新されます)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チケット ID
|
ticketId | True | integer |
更新するチケット ID。 |
|
要求元 ID
|
requester_id | integer |
要求元のユーザー ID。 既存の連絡先の場合は、電子メールではなくrequester_idを渡すことができます。 |
|
|
サブジェクト
|
subject | string |
チケットの件名。 |
|
|
ステータス
|
status | string |
チケットの状態。 |
|
|
Priority
|
priority | string |
チケットの優先順位 (低、中、高など)。 |
|
|
緊急度
|
urgency | string |
問題の緊急性 (低、中、高など)。 |
|
|
インパクト
|
impact | string |
問題の影響 (低、中、高など)。 |
|
|
情報源
|
source | string |
チケットが作成されたチャネル。 |
戻り値
チケットを更新する [非推奨]
チケットを更新します (指定した値のみが更新されます)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チケット ID
|
ticketId | True | integer |
更新するチケット ID。 |
|
要求元 ID
|
requester_id | integer |
要求元のユーザー ID。 既存の連絡先の場合は、電子メールではなくrequester_idを渡すことができます。 |
|
|
サブジェクト
|
subject | string |
チケットの件名。 |
|
|
ステータス
|
status | string |
チケットの状態。 |
|
|
Priority
|
priority | string |
チケットの優先順位 (低、中、高など)。 |
|
|
緊急度
|
urgency | string |
問題の緊急性 (低、中、高など)。 |
|
|
インパクト
|
impact | string |
問題の影響 (低、中、高など)。 |
|
|
情報源
|
source | string |
チケットが作成されたチャネル。 |
戻り値
トリガー
| チケットが作成されたとき (V2) |
新しいチケットが作成されたときにトリガーされます。 |
| チケットが作成されたとき [非推奨] |
新しいチケットが作成されたときにトリガーされます。 |
チケットが作成されたとき (V2)
チケットが作成されたとき [非推奨]
定義
Ticket_Response
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Date-Time 時に作成
|
created_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
削除済み
|
deleted | boolean |
チケットが削除/ごみ箱に入った場合は true に設定します。 削除されたチケットは、"削除済み" フィルター以外のビューでは考慮されません。 |
|
部門 ID
|
department_id_value | integer | |
|
チケット ID
|
display_id | integer |
アカウントに固有のチケット ID。 |
|
期限:Date-Time
|
due_by | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
グループ ID
|
group_id | integer |
チケットが割り当てられているグループの ID。 |
|
ID (アイディー)
|
id | integer |
チケットの一意の ID。 |
|
インパクト
|
impact | integer |
問題の影響を表す数値。 |
|
エスカレーション済み
|
isescalated | boolean |
エスカレーションが送信された場合は true に設定されます。 |
|
所有者 ID
|
owner_id | string |
問題が割り当てられているエージェントの ID。 |
|
Priority
|
priority | integer |
チケットの優先順位を表す番号。 |
|
要求元 ID
|
requester_id | integer |
要求元のユーザー ID。 既存の連絡先の場合は、電子メールではなくrequester_idを渡すことができます。 |
|
レスポンダー ID
|
responder_id | integer |
チケットが割り当てられているエージェントの ID。 |
|
情報源
|
source | integer |
チケットが作成されたチャネルを表す番号。 |
|
Spam
|
spam | boolean |
チケットがスパムとしてマークされている場合は true に設定します。 |
|
ステータス
|
status | integer |
チケットの状態を表す番号。 |
|
サブジェクト
|
subject | string |
チケットの件名。 |
|
チケットの種類
|
ticket_type | string |
チケット フィールドで定義されているプロパティ フィールドを入力します。 |
|
電子メールへ
|
to_email | string |
受信チケットの電子メールが送信された電子メール アドレス。 |
|
Date-Time 時に更新
|
updated_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
緊急度
|
urgency | integer |
問題の緊急性を表す数値。 |
|
Description
|
description | string |
問題の説明。 |
|
説明 HTML
|
description_html | string |
チケットの HTML コンテンツ。 説明とdescription_htmlを一緒に渡さないでください。 |
|
ステータス名
|
status_name | string |
チケットの状態。 |
|
優先度名
|
priority_name | string |
チケットの優先順位。 |
|
ソース名
|
source_name | string |
チケットが作成されたチャネル。 |
|
レスポンダー名
|
responder_name | string |
チケットが割り当てられているエージェントの名前。 |
|
電子メールへ
|
to_emails | array of string |
受信チケットの電子メールが送信された電子メール アドレス。 |
|
部署名
|
department_name | string |
部署の名前。 |
|
関連する問題 ID
|
assoc_problem_id | integer |
チケットに関連付けられている問題の ID。 |
|
関連する変更 ID
|
assoc_change_id | integer |
問題に関連付けられた変更の ID。 |
|
関連する変更原因 ID
|
assoc_change_cause_id | integer |
チケットの原因となった変更の ID。 |
|
関連付けられている資産 ID
|
assoc_asset_id | integer |
チケットに関連付けられている資産の ID。 |
|
緊急度の名前
|
urgency_name | string |
問題の緊急性。 |
|
影響名
|
impact_name | string |
問題の影響。 |
CreateUpdateTicket_ResponseV2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Date-Time 時に作成
|
ticket.created_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
部門 ID
|
ticket.department_id | integer | |
|
期限:Date-Time
|
ticket.due_by | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
グループ ID
|
ticket.group_id | integer |
チケットが割り当てられているグループの ID。 |
|
ID (アイディー)
|
ticket.id | integer |
チケットの一意の ID。 |
|
エスカレーション済み
|
ticket.is_escalated | boolean |
エスカレーションが送信された場合は true に設定されます。 |
|
Priority
|
ticket.priority | integer |
チケットの優先順位を表す番号。 |
|
要求元 ID
|
ticket.requester_id | integer |
要求元のユーザー ID。 既存の連絡先の場合は、電子メールではなくrequester_idを渡すことができます。 |
|
レスポンダー ID
|
ticket.responder_id | integer |
チケットが割り当てられているエージェントの ID。 |
|
情報源
|
ticket.source | integer |
チケットが作成されたチャネルを表す番号。 |
|
Spam
|
ticket.spam | boolean |
チケットがスパムとしてマークされている場合は true に設定します。 |
|
ステータス
|
ticket.status | integer |
チケットの状態を表す番号。 |
|
サブジェクト
|
ticket.subject | string |
チケットの件名。 |
|
チケットの種類
|
ticket.type | string |
チケット フィールドで定義されているプロパティ フィールドを入力します。 |
|
Date-Time 時に更新
|
ticket.updated_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Description
|
ticket.description_text | string |
問題の説明。 |
|
説明 HTML
|
ticket.description | string |
チケットの HTML コンテンツ。 説明とdescription_htmlを一緒に渡さないでください。 |
|
電子メールへ
|
ticket.to_emails | array of string |
受信チケットの電子メールが送信された電子メール アドレス。 |
ListTicket_ResponseV2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Date-Time 時に作成
|
created_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
部門 ID
|
department_id | integer | |
|
期限:Date-Time
|
due_by | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
グループ ID
|
group_id | integer |
チケットが割り当てられているグループの ID。 |
|
ID (アイディー)
|
id | integer |
チケットの一意の ID。 |
|
エスカレーション済み
|
is_escalated | boolean |
エスカレーションが送信された場合は true に設定されます。 |
|
Priority
|
priority | integer |
チケットの優先順位を表す番号。 |
|
要求元 ID
|
requester_id | integer |
要求元のユーザー ID。 既存の連絡先の場合は、電子メールではなくrequester_idを渡すことができます。 |
|
レスポンダー ID
|
responder_id | integer |
チケットが割り当てられているエージェントの ID。 |
|
情報源
|
source | integer |
チケットが作成されたチャネルを表す番号。 |
|
Spam
|
spam | boolean |
チケットがスパムとしてマークされている場合は true に設定します。 |
|
ステータス
|
status | integer |
チケットの状態を表す番号。 |
|
サブジェクト
|
subject | string |
チケットの件名。 |
|
チケットの種類
|
type | string |
チケット フィールドで定義されているプロパティ フィールドを入力します。 |
|
Date-Time 時に更新
|
updated_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Description
|
description_text | string |
問題の説明。 |
|
説明 HTML
|
description | string |
チケットの HTML コンテンツ。 説明とdescription_htmlを一緒に渡さないでください。 |
|
電子メールへ
|
to_emails | array of string |
受信チケットの電子メールが送信された電子メール アドレス。 |
UpdateTicket_Response
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
削除済み
|
ticket.deleted | boolean |
チケットが削除/ごみ箱に入った場合は true に設定します。 削除されたチケットは、"削除済み" フィルター以外のビューでは考慮されません。 |
|
チケット ID
|
ticket.display_id | integer |
アカウントに固有のチケット ID。 |
|
サブジェクト
|
ticket.subject | string |
チケットの件名。 |
|
Description
|
ticket.description | string |
チケットの説明。 |
|
説明 HTML
|
ticket.description_html | string |
チケットの HTML コンテンツ。 説明とdescription_htmlを一緒に渡さないでください。 |
|
ステータス名
|
ticket.status_name | string |
チケットの状態。 |
|
優先度名
|
ticket.priority_name | string |
チケットの優先順位。 |
|
ソース名
|
ticket.source_name | string |
チケットが作成されたチャネル。 |
|
レスポンダー名
|
ticket.responder_name | string |
チケットが割り当てられているエージェントの名前。 |
|
電子メールへ
|
ticket.to_emails | array of string |
受信チケットの電子メールが送信された電子メール アドレス。 |
|
部署名
|
ticket.department_name | string |
部署の名前。 |
|
関連する問題 ID
|
ticket.assoc_problem_id | integer |
チケットに関連付けられている問題の ID。 |
|
関連する変更 ID
|
ticket.assoc_change_id | integer |
問題に関連付けられた変更の ID。 |
|
関連する変更原因 ID
|
ticket.assoc_change_cause_id | integer |
チケットの原因となった変更の ID。 |
|
関連付けられている資産 ID
|
ticket.assoc_asset_id | integer |
チケットに関連付けられている資産の ID。 |
|
緊急度の名前
|
ticket.urgency_name | string |
問題の緊急性。 |
|
影響名
|
ticket.impact_name | string |
問題の影響。 |
AddNote_Response
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Date-Time 時に作成
|
note.created_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
削除済み
|
note.deleted | boolean |
チケットが削除/ごみ箱に入った場合は true に設定します。 削除されたチケットは、"削除済み" フィルター以外のビューでは考慮されません。 |
|
ID (アイディー)
|
note.id | integer |
メモの一意の ID。 |
|
非公開
|
note.private | boolean |
メモがプライベートの場合は true に設定します。 |
|
情報源
|
note.source | integer |
チケットが作成されたチャネルを表す番号。 |
|
Date-Time 時に更新
|
note.updated_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
ユーザー ID
|
note.user_id | integer |
メモを追加するエージェントのUser_id。 |
|
Body
|
note.body | string |
ノートの内容 (プレーンテキスト)。 |
|
本文 HTML
|
note.body_html | string |
ノートの内容 (HTML 形式)。 本文またはbody_htmlを渡す必要があります。 |
|
attachments
|
note.attachments | array of string |
AddNote_ResponseV2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Date-Time 時に作成
|
conversation.created_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
ID (アイディー)
|
conversation.id | integer |
メモの一意の ID。 |
|
非公開
|
conversation.private | boolean |
メモがプライベートの場合は true に設定します。 |
|
Date-Time 時に更新
|
conversation.updated_at | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
ユーザー ID
|
conversation.user_id | integer |
メモを追加するエージェントのUser_id。 |
|
Body
|
conversation.body_text | string |
ノートの内容 (プレーンテキスト)。 |
|
本文 HTML
|
conversation.body | string |
ノートの内容 (HTML 形式)。 本文またはbody_htmlを渡す必要があります。 |
|
attachments
|
conversation.attachments | array of string | |
|
チケット ID
|
conversation.ticket_id | integer |
チケットの一意の ID。 |