転送元 - Freshservice
    • PDF

    転送元 - Freshservice

    • PDF

    記事の要約

    本ページでは、Freshserviceからデータを取得するための設定(転送設定)について説明します。
    接続に関する設定については、接続情報 - Freshserviceを参照ください。

    利用上の注意・制約

    API Rate Limit

    Freshservice APIには、一定期間内のリクエスト回数に制限があります。1時間あたり5000リクエストの制限があります。制限を超えると、HTTP 429エラーが返され、一時的にAPIが使用できなくなります。詳細はFreshservice公式ドキュメント - API Rate Limitsを参照ください。

    取得対象

    Agents

    エージェント(管理者やサポートスタッフ)の一覧を取得します。
    詳しくは、Freshservice公式ドキュメント - Agentsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    State--取得するエージェントの状態を選択できます。
    以下より選択できます。
  • fulltime
  • occasional

  • 未指定の場合は、すべての状態のエージェントを取得します。

    取得データ

    カラム名デフォルトのデータ型補足事項
    activebooleanアクティブ状態
    addressstring住所
    api_key_enabledbooleanAPIキーが有効かどうか
    auto_assign_status_changed_attimestamp自動割り当て状態の変更日時
    auto_assign_ticketsbooleanチケットの自動割り当て設定
    background_informationstring背景情報
    can_see_all_tickets_from_associated_departmentsboolean関連部署の全チケットを閲覧可能かどうか
    created_attimestamp作成日時
    custom_fieldsjsonカスタムフィールド
    department_idsjson部署ID一覧
    department_namesjson部署名一覧
    emailstringメールアドレス
    external_idstring外部ID
    first_namestring名前
    has_logged_inbooleanログイン実績があるかどうか
    idlongエージェントID
    job_titlestring職業
    languagestring言語設定
    last_active_attimestamp最終アクティブ日時
    last_login_attimestamp最終ログイン日時
    last_namestring苗字
    location_idlongロケーションID
    location_namestringロケーション名
    mobile_phone_numberstring携帯電話番号
    occasionalboolean臨時エージェントかどうか
    reporting_manager_idlong上司のID
    rolesjson役割一覧
    scoreboard_level_idlongスコアボードレベルID
    scoreboard_pointslongスコアボードポイント
    signaturestring署名
    time_formatstring時間形式
    time_zonestringタイムゾーン
    updated_attimestamp更新日時
    vip_userbooleanVIPユーザーかどうか
    work_phone_numberstring職場電話番号
    work_schedule_idlong勤務スケジュールID
    workspace_idsjsonワークスペースID一覧
    workspace_infojsonワークスペース情報
    member_ofjsonメンバーとして参加しているグループ
    observer_ofjson監視者として参加しているグループ
    member_of_pending_approvaljson参加申請中のグループ
    observer_of_pending_approvaljson監視者申請中のグループ

    Requesters

    リクエスター(サービスを利用するユーザー)の一覧を取得します。
    詳しくは、Freshservice公式ドキュメント - Requestersを参照ください。

    設定項目

    設定項目はありません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    activebooleanアクティブ状態
    addressstring住所
    background_informationstring背景情報
    can_see_all_changes_from_associated_departmentsboolean関連部署の全変更を閲覧可能かどうか
    can_see_all_tickets_from_associated_departmentsboolean関連部署の全チケットを閲覧可能かどうか
    created_attimestamp作成日時
    custom_fieldsjsonカスタムフィールド
    department_idsjson部署ID一覧
    department_namesjson部署名一覧
    external_idstring外部ID
    first_namestring名前
    has_logged_inbooleanログイン実績があるかどうか
    idlongリクエスターID
    is_agentbooleanエージェントかどうか
    job_titlestring職業
    languagestring言語設定
    last_namestring苗字
    location_idlongロケーションID
    location_namestringロケーション名
    mobile_phone_numberstring携帯電話番号
    primary_emailstringメインメールアドレス
    reporting_manager_idlong上司のID
    secondary_emailsjsonサブメールアドレス一覧
    time_formatstring時間形式
    time_zonestringタイムゾーン
    updated_attimestamp更新日時
    vip_userbooleanVIPユーザーかどうか
    work_phone_numberstring職場電話番号
    work_schedule_idlong勤務スケジュールID

    Tickets

    チケット(サービスリクエストやインシデント)の一覧を取得します。
    詳しくは、Freshservice公式ドキュメント - Ticketsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    Updated since--指定した日時以降に更新されたチケットのみを取得します。
    以下の形式で入力できます:
  • YYYY-MM-DD(例:2015-08-17)
  • YYYY-MM-DDTHH:MM:SSZ(例:2015-08-17T10:30:00Z)
  • その他のISO 8601形式
  • タイムゾーンが指定されていない場合は、UTCとして扱われます。
    Workspace ID--特定のワークスペースのチケットのみを取得します。
    ワークスペースIDは、Freshserviceの管理画面で確認できます。
    Include--取得するチケットに含める追加情報を選択できます。
    以下より選択できます。
  • stats
  • requester
  • requested_for
  • onboarding_context
  • offboarding_context
  • 取得データ

    カラム名デフォルトのデータ型補足事項
    subjectstring件名
    group_idlongグループID
    department_idlong部署ID
    categorystringカテゴリ
    sub_categorystringサブカテゴリ
    item_categorystringアイテムカテゴリ
    requester_idlongリクエスターID
    responder_idlong対応者ID
    due_bytimestamp期限日時
    fr_escalatedboolean初回エスカレーション済みかどうか
    deletedboolean削除済みかどうか
    spambooleanスパムかどうか
    email_config_idlongメール設定ID
    fwd_emailsjson転送メールアドレス一覧
    reply_cc_emailsjson返信CCメールアドレス一覧
    cc_emailsjsonCCメールアドレス一覧
    is_escalatedbooleanエスカレーション済みかどうか
    fr_due_bytimestamp初回返信期限日時
    idlongチケットID
    prioritylong優先度
    statuslongステータス
    sourcelongソース
    created_attimestamp作成日時
    updated_attimestamp更新日時
    workspace_idlongワークスペースID
    requested_for_idlong代理リクエストID
    to_emailsjson送信先メールアドレス一覧
    typestringタイプ
    descriptionstring説明
    description_textstring説明テキスト
    custom_fieldsjsonカスタムフィールド
    requesterjsonリクエスター情報
    statsjson統計情報
    requested_forjson代理リクエスト情報
    onboarding_contextjsonオンボーディングコンテキスト
    offboarding_contextjsonオフボーディングコンテキスト

    この記事は役に立ちましたか?