Skip to Content

Changes for page ERRest In Depth

Last modified by Pascal Robert on 2012/06/10 16:01
From version 35.1
edited by Pascal Robert
on 2012/03/11 21:01
Change comment: There is no comment for this version
To version 37.1
edited by Pascal Robert
on 2012/05/02 20:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,3 +1,85 @@
1 +* ERXRestContext
2 +** contains the editing context and an userInfo dictionnary
3 +** will be populated with er.rest.dateFormat, er.rest.timestampFormatter and er.rest.timestampFormat (read only for non-HTML responses)
4 +*** want to change the time format for a specific controller?
5 +
6 +{{code}}
7 +
8 +protected ERXRestContext createRestContext() {
9 + ERXRestContext restContext = new ERXRestContext(editingContext());
10 + restContext.setUserInfoForKey("yyyy-MM-dd", "er.rest.dateFormat");
11 + restContext.setUserInfoForKey("yyyy-MM-dd", "er.rest.timestampFormat");
12 + return restContext;
13 + }
14 +
15 +{{/code}}
16 +
17 +*
18 +** you just need to override createRestContext() in your controller if you want to add other stuff to the context (a user, etc.)
19 +* Properties
20 +** ERXRest.idKey (ERXRestFormatDelegate)
21 +*** (default "id") Override this property if you want to use a different key for the 'id' attribute ERXRest.typeKey
22 +** ERXRest.nilKey (ERXRestFormatDelegate)
23 +** ERXRest.writeNilKey (ERXRestFormatDelegate)
24 +** ERXRest.pluralEntityNames (ERXRestFormatDelegate)
25 +** ERXRest.writeTypeKey (ERXRestFormatDelegate)
26 +** ERXRest.suppressTypeAttributesForSimpleTypes
27 +** ERXRest.strictMode
28 +** ERXRest.pluralEntityNames (ERXRouteRequestHandler)
29 +** ERXRest.routeCase (ERXRouteRequestHandler)
30 +** ERXRest.lowercaseEntityNames (ERXRouteRequestHandler)
31 +** ERXRest.parseUnknownExtensions (ERXRouteRequestHandler)
32 +*** (default "true") If set to "false", will return a 404 status code if the format doesn't exist
33 +** ERXRest.missingControllerName (ERXRouteRequestHandler)
34 +*** (default "ERXMissingRouteController") Allow you to specify which controller to use when a route doesn't exist
35 +** er.rest.rfcDateFormat
36 +** er.rest.dateFormat
37 +** er.rest.dateFormat.primary
38 +** er.rest.dateFormat.secondary
39 +** er.rest.dateFormatter
40 +** er.rest.timestampFormat
41 +** er.rest.timestampFormat.primary
42 +** er.rest.timestampFormat.secondary
43 +** er.rest.timestampFormatter
44 +** er.rest.rfcDateFormat
45 +** ERXRest.transactionsEnabled
46 +** ERXRest.maxEventsPerTransaction
47 +* JSON Schema
48 +** {{code}}
49 +/something?schema=true
50 +
51 +public WOActionResults indexAction() {
52 +if (isSchemaRequest()) {
53 + return schemaResponse(showFilter());
54 +}
55 +protected boolean isSchemaRequest() {
56 + return request().stringFormValueForKey("schema") != null;
57 +}
58 +{{/code}}
59 +
60 +Same Origin policy
61 +Transactions
62 +HTML vs other formats
63 +Response representation
64 +Missing route
65 +Missing object
66 +POJO objects
67 +Headers
68 +Caching
69 +Adding new format
70 +Security
71 +strictMode
72 +Workflow
73 +Query arguments and RXRestFetchSpecification
74 +ERXRestNameRegistry
75 +MapClassDescription / NSDictionaryClassDescription
76 +
77 +ERXRestUtils
78 +Properties
79 +er.rest.dateFormat
80 +er.rest.timestampFormat
81 +er.rest.rfcDateFormat
82 +
1 1  request > route
2 2  
3 3  Application(ERXApplication).dispatchRequest(WORequest) line: 2051