Version 25.3.9411

• 一般的な日付フォーマッタ
  • now([outputformat])
    • 例
  • todate([outputformat][, inputformat][, strictInputFormat])
    • 例
  • dateadd(intervaltype, value[, outputformat][, inputformat])
    • 例
• その他の日付フォーマッタ
  • compare([value][, inputformat])
  • date([outputformat])
  • datediff([interval][, value][, inputformat])
  • day([inputformat])
  • dayofweek([inputformat])
  • dayofyear([inputformat])
  • filetimenow()
  • fromfiletime([outputformat])
  • isleap([ifleap][, ifnotleap])
  • month([inputformat])
  • tofiletime([inputformat])
  • toutc([outputformat][, inputformat])
  • utcnow([outputformat])
  • weekday([inputformat])
  • year([inputformat])
• サンプル日付フォーマット
  • リテラル文字を含む日付フォーマット

一般的な日付フォーマッタ

以下のフォーマッタは、最も一般的な日付フォーマッタです。参考までに各フォーマッタの例を提供しています。

その他の日付フォーマットの例はSample Date Formats にあります。

Note：一部のフォーマッタのオプションパラメータを囲う角括弧は、必須ではありません。これらは、パラメータがオプションであることを示すためにあります。

now([outputformat])

指定された outputformat に従って現在のシステム日時を返します（デフォルトの形式はyyyy-MM-dd'T'hh:mm:sszzz です）。

このフォーマッタは入力属性（変数）を変更しないという点で珍しいため、そのような入力属性は必要ありません。

例

<api:set attr="timestamp" value="[now()]" />

todate([outputformat][, inputformat][, strictInputFormat])

入力属性を、 outputformat で指定された形式の日付としてフォーマットします（デフォルトの形式はyyyy-MM-dd'T'hh:mm:sszzz です）。日付フォーマットの例とその表現方法については、Sample Date Formats を参照してください。

フォーマッタは入力値のフォーマットを自動検出しようとしますが、フォーマッタが入力フォーマットを判別できない場合は、 inputformat パラメータを指定できます。

strictInputFormat 引数を使用して、受信した日付値が入力形式と一致するかどうかをチェックします。一致しない場合は、タスクは日付を標準の日付形式に変換する代わりにエラーをスローします。デフォルトではチェックしません。強制的にチェックするには、フォーマッタにtrue を追加します。

例

<api:set attr="simpleDate" value="01-30-2020" />
<api:set attr="reformattedDate" value="[simpleDate | todate('yyyyMMdd', 'dd-MM-yyyy')]" />

dateadd(intervaltype, value[, outputformat][, inputformat])

入力日に指定された時間を加算し、その結果を返します。intervaltype パラメータは追加する時間の単位（year、month、day、hour、minute、second、またはmillisecond）を指定し、 value パラメータはその単位をいくつ追加するかを指定します。

フォーマッタは入力値のフォーマットを自動検出しようとしますが、フォーマッタが入力属性の日付フォーマットを判別できない場合は、 inputformat パラメータを指定できます。結果は、 outputformat で指定された形式で返されます（デフォルトの形式はyyyy-MM-dd'T'hh:mm:sszzz です）。

例

<api:set attr="shipdate" value="2020-03-15" />
<api:set attr="estmArrivalDate" value="[shipdate | dateadd('day', 2)]" />

その他の日付フォーマッタ

以下は、あまり一般的に使用されないフォーマッタのリストです。

compare([value][, inputformat])

属性値とパラメータ値によって表される日付の相対値を示す符号付き数値を返します。

• value：属性値と比較する日付の文字列表現（オプション）。デフォルトはnow です。
• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

date([outputformat])

Note：このフォーマッタは、上で説明したnow() フォーマッタのエイリアスです。

現在のシステムの日付と時刻を、 outputformat パラメータ（指定されている場合）で指定された形式で返します。

• outputformat：フォーマット指定子（オプション）。有効な指定子は、d（短い形式の日）、D（長い形式の日）、f（長い形式の日/短い形式の時間 ）、F（長い形式の日/時間）、g（標準の短い形式の日/時）、G（標準の短い形式の日/長い形式の時間）、r またはR（RFC1123 形式）、s（ソート可能な形式の日/時）、t（短い形式の時間）、T（長い形式の時間）、file（Windows ファイル時間）、MM/dd/yy などです。

datediff([interval][, value][, inputformat])

現在と value パラメータで指定した日付との差を（ interval パラメータで指定した単位で）返します。

• interval：結果を取得する間隔（オプション）。day、hour、minute、second、またはmillisecond を指定します。
• value：属性値と比較する日付の文字列表現（オプション）。デフォルトはnow です。
• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

day([inputformat])

属性値で表される日付の、1から31までの値で表される日の部分を返します。

• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

dayofweek([inputformat])

属性値で表される日付の曜日を返します。

• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

dayofyear([inputformat])

属性値で表される日付の、1から366までの値で表される年日を返します。

• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

filetimenow()

現在のシステムファイルの時刻の日時を返します。

fromfiletime([outputformat])

有効なファイル時刻を、 outputformat パラメータ（指定されている場合）で指定された形式で有効なdatetime 値に変換します。

• outputformat：フォーマット指定子（オプション）。有効な指定子は、d（短い形式の日）、D（長い形式の日）、f（長い形式の日/短い形式の時間 ）、F（長い形式の日/時間）、g（標準の短い形式の日/時）、G（標準の短い形式の日/長い形式の時間）、r またはR（RFC1123 形式）、s（ソート可能な形式の日/時）、t（短い形式の時間）、T（長い形式の時間）、file（Windows ファイル時間）、MM/dd/yy などです。

isleap([ifleap][, ifnotleap])

属性値で表される4桁の年がうるう年であれば true （または ifleap ）、それ以外の場合は false （または ifnotleap ）を返します。

• ifleap：属性値がうるう年の場合に返される値（オプション）。
• ifnotleap：属性値がうるう年でない場合に返される値（オプション）。

month([inputformat])

属性値で表される日付の、1から12までの値で表される月の部分を返します。

• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

tofiletime([inputformat])

有効な日時を有効なファイル時刻値に変換します。

• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

toutc([outputformat][, inputformat])

属性値で指定された日付を、 outputformat パラメータ（指定されている場合）で指定された形式で UTC に変換して返します。

• outputformat：フォーマット指定子（オプション）。有効な指定子は、d（短い形式の日）、D（長い形式の日）、f（長い形式の日/短い形式の時間 ）、F（長い形式の日/時間）、g（標準の短い形式の日/時）、G（標準の短い形式の日/長い形式の時間）、r またはR（RFC1123 形式）、s（ソート可能な形式の日/時）、t（短い形式の時間）、T（長い形式の時間）、file（Windows ファイル時間）、MM/dd/yy などです。

utcnow([outputformat])

現在のシステムのUTC 日時を返します。

• outputformat：フォーマット指定子（オプション）。有効な指定子は、d（短い形式の日）、D（長い形式の日）、f（長い形式の日/短い形式の時間 ）、F（長い形式の日/時間）、g（標準の短い形式の日/時）、G（標準の短い形式の日/長い形式の時間）、r またはR（RFC1123 形式）、s（ソート可能な形式の日/時）、t（短い形式の時間）、T（長い形式の時間）、file（Windows ファイル時間）、MM/dd/yy などです。

weekday([inputformat])

曜日を、月曜日が0、日曜日が6の整数値で返します。

• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

year([inputformat])

属性値で表される日付の年部分を返します。

• inputformat：入力フォーマット指定子（オプション）。デフォルトはautodetected です。

サンプル日付フォーマット

以下は、参照用の日付フォーマット文字列のサンプルです。これらを使って、ユースケースに合わせて日付フォーマッタをカスタマイズしてください。各エディションでサポートされている内容に違いがあるため、このセクションではクロスプラットフォーム版と.NET 版の両方の結果を記載しています。

次のテーブルの各例では、日付は2024年3月5日を使用します。時刻は、東部標準時間（UTC-5）の午前0時から12時間31分5秒336ミリ秒後です。

リテラル文字を含む日付フォーマット

DateTime 文字列でリテラル（’T’ など）を扱う場合は、フォーマッタの外部で使用される可能性のある引用符に注意してください。例えば、value XML 属性でフォーマッタを使用してAPI ServerScript 属性に値を割り当てる場合、文字列の終端が早すぎないように、別の引用符スタイルやエスケープシーケンスを使う必要がある場合があります。

例えば、カスタムスクリプトでアイテムの属性にdatetime 値を作成し、リテラルが必要な場合、開始タグと終了api:set タグの間に属性の値を定義することができます。value="" は設定されていないことに注意してください。

<api:set attr="out.data">[_ | now("yyyy-MM-dd'T'HH:mm:ss")]</api:set>