You can configure the format for dates that are returned by the Legacy REST Web Services interface. It will return dates in one of the following formats:
A string representation of a Java Date object (default)
MM/dd/yyyy HH:mm:ss z
For example: 01/29/2011 11:11:11 GMT
To control which date format will be returned, set the enableFormatDateOutput
property of the /atg/rest/output/JSONOutputCustomizer
or /atg/rest/output/XMLOutputCustomizer
components.
Set
enableFormatDateOutput
totrue
to receive the date and time inMM/dd/yyyy HH:mm:ss z
format.Set
enableFormatDateOutput
tofalse
to receive the string representation of theDate
object.
Note: The return depth for a REST request may cause a date property to be expanded. If a date property is expanded, it will not be in either of the formats described in this section but will be a set of properties that make up the date. See Return Depth. If you do not want to expand date properties, you can suppress property expansion for them. See Suppressing Property Expansion in Legacy REST.
Time Zone Configuration
If you set the enableFormatDate
property of the JSONOutputCustomizer
or XMLOutputCustomizer
to true
, the Legacy REST Web Services interface returns date values using the time zone specified by the timeZoneId
property. The default value for this property is Coordinated Universal Time (UTC).
Set the timeZoneId
property of JSONOutputCustomizer
or XMLOutputCustomizer
to the time zone identifier that you choose. Specify the time zone using a string recognized by the java.util.TimeZone
class.
If you choose to return the string representation of Java Date objects, the Legacy REST interface will return date values using the time zone of the server.