PORTERS Connect API 9.3.0では、下記の機能拡張を実施いたします。
PORTERS 9.3.0 で追加される項目タイプ「時分型」を、Resource API の Read / Write / Search で取り扱うことができます。
時分型項目の利用にあたり、HTTP Header(X-P-ConnectAPI-Version)の指定は不要です。
時分型項目とは
時刻(時分)のみを保持する項目です。PORTERS の画面では 00:00〜47:59 の範囲で入力できます。
Field Type は年月日時分型と同じ「12(DateTime)」です。
データベース上は 1970/01/01 を基準日とした年月日時分として保存されます。(24:00〜47:59 は 1970/01/02 として保存)
【PORTERS画面上の値とデータベース上の値の例】
PORTERSの画面 |
データベース上の値 |
| 09:00 | 1970/01/01 09:00 |
| 26:00 | 1970/01/02 02:00 |
Read(取得)
- 時分型項目の値は、年月日時分型と同じ [yyyy/mm/dd HH:MM:SS] の書式で出力されます。
例: <Job.U_XXX>1970/01/01 09:00:00</Job.U_XXX> - HH:MM のみの書式では出力されません。
時分のみを表示する場合は、ご利用者様側でレスポンスを加工してください。 - 年月日時分型と異なり、タイムゾーンによる変換は行われません。
Write(登録・更新)
- 時分型項目の値は、基準日を付けた次の書式で指定します。
[1970/01/01 HH:MM:SS](00:00〜23:59)
[1970/01/02 HH:MM:SS](24:00〜47:59 に相当。例: 26:00 → 1970/01/02 02:00:00) - 基準日(1970/01/01・1970/01/02)以外の年月日を指定した場合はバリデーションエラーとなり、Code 103 が返ります(HTTP ステータスは 200)。
Search(Read の condition)
- condition に時分型項目を指定する場合も、基準日を付けた書式で指定します。
例(15:00 以上 26:00 以下): condition=Job.U_XXX:ge=1970/01/01 15:00:00,Job.U_XXX:le=1970/01/02 02:00:00(実際は URL エンコードが必要) - 不正な書式を指定した場合はバリデーションエラーとなり、Code 100 が返り検索は実行されません(HTTP ステータスは 200)。
- order(並び順)には年月日時分型と同様の仕様で指定できます。
年月日時分型項目との判別について
時分型項目は、Field - Read では年月日時分型と同じ Field Type = 12 として取得されます。
現在、API のレスポンスから対象の項目が時分型かどうかを判別する手段は提供されていません。
時分型項目を API で取り扱う場合は、PORTERS のカスタマイズ画面(項目&詳細)で対象の項目が時分型であることをご確認のうえ、項目のエイリアスを指定して個別に対応してください。
既存の API 連携への影響
時分型項目は、Field - Read(/v1/field)では年月日時分型と同じ Field Type = 12 として取得されます。
そのため、PORTERS管理者がリソースに時分型項目を追加した場合、既存の連携プログラムが当該項目を年月日時分型と同様に扱い、任意の日時(例:2026/07/09 09:00:00)を書き込むと、Code 103 エラーが発生します。
時分型項目へ値を書き込む際は、基準日を考慮した指定形式(例:1970/01/01 09:00:00)をご利用ください。
なお、APIから時分型項目かどうかを機械的に判別することはできません。そのため、連携プログラムの対象となるパーティションにどの時分型項目が存在するかについては、ご利用環境のPORTERS管理者へご確認ください。