以下のFAQは開発者向けに書かれています。この構成の実装に関心のあるサポートマネージャーの方は、この記事を開発者と共有してください。

HelpshiftのREST APIを使用して、チケット作成時にカスタムチケットフィールドを更新するには、PUT /issuesリソースでcustom_fieldsパラメータを使用する必要があります。

このパラメーターは、カスタムチケットフィールドを含むキーと値のペアのJSONオブジェクトを受け入れます。

ご注意ください：HSAPIのcustom_fieldsパラメーターは、管理者がHelpshiftダッシュボードの設定タブ内でカスタムチケットフィールドを作成した後にのみ呼び出す必要があります。

カスタムチケットフィールドを作成する際、フィールドタイプは、以下の許可されたカスタムチケットフィールドタイプのいずれかである必要があります。

• 日付
• チェックボックス
• ドロップダウン
• 一行テキスト
• 複数行のテキスト
• 番号

各フィールドの値は、そのフィールドのデータ型と一致する必要があります。

このAPI設定を構成する際は、以下の点にご留意ください。

• すべての日付は、Unixタイムスタンプ（ミリ秒）形式にする必要があります。
• 無効なキーと、予期されるデータ型と一致しない値は削除され、値は設定されません。
• アーカイブ/削除されたフィールドは削除されるため、値は設定されません

カスタム_fieldsパラメーターについてさらに詳しく知りたい場合は、弊社のAPIドキュメントツールをご覧ください。

以下は、/issuesリソースに対するサンプルREST API PUTコールのスクリーンショットです。このコールは、新規カスタムチケットフィールドの値でチケットを正常に更新しました。

注意: このREST API呼び出しは、PostmanのAPIクライアントを使用しました。