kintone添付ファイルを取得する

使い方

kintone のレコードに添付されているファイルを、kintone から取得してエブリサイトで使用する準備を行います。

この「やること」では準備までしか実行しません。ファイルをアイテムで表示したり、ユーザーのブラウザーでダウンロードさせるには、「添付ファイルを公開する」や「添付ファイルをダウンロードする」といった別の「やること」につなげる必要があります。

設定するパラメーター

kintone 接続設定

kintone 接続設定を指定します。API トークンに、指定レコードおよび添付ファイルフィールドに対する閲覧権限が必要です。

添付ファイルフィールドまたはファイルキー

レコードの添付ファイルフィールドの値を指定するか、または kintone 添付ファイルのファイルキー値を指定します。

以下のいずれかの形式で指定可能です。

添付ファイルフィールド値
- Cybozu 公式ドキュメントの「添付ファイル」の項目をご覧ください。
- 添付ファイルフィールド値は配列形式です。複数のファイルが添付されている場合は配列にすべての添付ファイルが含まれます。その場合、「kintone添付ファイルを取得する」は添付されているすべてのファイルを取得します。
- 例えばアクション1でレコードを取得していて、添付ファイルフィールドのフィールドコードが「添付ファイル」の場合、以下のような式で指定可能です。
```
= $1[0].添付ファイル
```
添付ファイルフィールド値の一要素
- 上記の通り、複数のファイルが添付されている場合に添付ファイルフィールドの値で指定すると、すべてのファイルが取得されます。そうではなくて、例えば最初の1つだけを取得したい、というような場合は、添付ファイルフィールド値の配列から特定要素だけを指定することもできます。
- 例えばアクション1でレコードを取得していて、添付ファイルフィールドのフィールドコードが「添付ファイル」の場合、添付されている最初の要素だけを取得したい場合は、以下のような式で指定します。ただしこの指定方法は、ファイルが1つも添付されていないと式エラーになりますので注意が必要です。
```
= $1[0].添付ファイル[0]
```
ファイルキーまたはファイルキーの配列
- 文字列形式で渡した場合、"201202061155587E339F9067544F1A92C743460E3D12B3297" のようなファイルキー文字列とみなされます。
- 文字列配列を渡した場合、ファイルキーの配列とみなします。

キャッシュが無効になる日時

取得したファイルのキャッシュが無効になる日時を指定します。指定されている場合、キャッシュがあればキャッシュからファイルを返します。キャッシュがなければ kintone からファイルを取得し、指定の日時を期限としてキャッシュします。

このパラメーターを空にした場合、キャッシュは行われません。つまり、キャッシュの有無にかかわらず kintone からファイルを取得し、取得したファイルはキャッシュしません。

日時は以下の形式で入力できます。

ISO 8601形式の日時
- 2025-05-06T04:30:00Z のような形式です。
ローカル時刻
- 2025-05-06 04:30:00 のように時差情報を含めない形式です。この場合、時刻は「タイムゾーンをセットする」でセットしたタイムゾーンで解釈されます。
日付
- 2025-05-06 のように時刻を含まない形式です。この場合、時刻は「タイムゾーンをセットする」でセットしたタイムゾーンにおける 00:00:00 と解釈されます。
時刻
- 07:30 のように日付を含まない形式です。この場合、ダミーで日付が 1970-01-01 であるとみなされます。タイムゾーンは「タイムゾーンをセットする」でセットしたタイムゾーンになります。

キャッシュを期間で指定したい場合、アクションを使う方法と関数を使う方法があります。例えばキャッシュの有効期間を最大1週間にしたい場合、

アクションで指定 ...「日時を計算する」で現在日時から1週間後を計算し、そのアクションを = $1 のように式で参照する。
関数で指定 ... fromnow 関数を使用して = fromnow(1, "weeks") と記述する。

結果値

以下の属性を持つオブジェクトの配列です。取得したファイルが1つだけの場合でも結果は配列になります。

属性	意味
fileId	ファイルID
filename	ファイル名
contentType	コンテンツタイプ
contentLength	コンテンツサイズ

その他の情報が入っている場合もありますが、それらは内部情報で、カスタマイズで直接参照することは想定されていません。

ファイル名が不明の場合はファイルIDと同じになります。