From 8efbd05d110da61a9df4f300fac8322632564925 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20M=C3=A4rki?= Date: Fri, 15 Apr 2016 15:56:42 +0200 Subject: [PATCH] Readme --- Readme.md | 104 +++++++++++++++++++++++++++--------------------------- 1 file changed, 52 insertions(+), 52 deletions(-) diff --git a/Readme.md b/Readme.md index db6b4c0..2ec6d0b 100644 --- a/Readme.md +++ b/Readme.md @@ -385,7 +385,7 @@ curl -H "Content-Type: application/json" -X POST -d '{"range":{"startSeconds":" See JSON representation of the data above. -#### Query using compression +#### Query Using Compression ```json { @@ -423,57 +423,6 @@ The `curl` command has a `--compressed` option to decompress data automatically. curl --compressed -H "Content-Type: application/json" -X POST -d '{"compression":"gzip","range":{"startPulseId":0,"endPulseId":3},"channels":["Channel_01"]}' http://data-api.psi.ch/sf/query | python -m json.tool ``` -#### Query setting CSV response format - -```json -{ - "responseFormat":"csv", - "range":{ - "startPulseId":0, - "endPulseId":4 - }, - "channels":[ - "channel1", - "channel2" - ], - "fields":[ - "channel", - "pulseId", - "iocSeconds", - "globalSeconds", - "shape", - "eventCount", - "value" - ] -} -``` - -It is possible to request the time in seconds (since January 1, 1970 (the UNIX epoch) as a decimal value including fractional seconds - using fields *globalSeconds* and *iocSeconds*) or in milliseconds (since January 1, 1970 (the JAVA epoch) - using fields *globalMillis* and *iocMillis*) - -##### Command - -```bash -curl -H "Content-Type: application/json" -X POST -d '{"responseFormat":"csv","range":{"startPulseId":0,"endPulseId":4},"channels":["channel1","channel2"],"fields":["channel","pulseId","iocSeconds","globalSeconds","shape","eventCount","value"]}' http://data-api.psi.ch/sf/query -``` - -##### Response - -The response is in CSV. - -```text -channel;pulseId;iocSeconds;globalSeconds;shape;eventCount;value -testChannel1;0;0.000000000;0.000000000;[1];1;0 -testChannel1;1;0.010000000;0.010000000;[1];1;1 -testChannel1;2;0.020000000;0.020000000;[1];1;2 -testChannel1;3;0.030000000;0.030000000;[1];1;3 -testChannel1;4;0.040000000;0.040000000;[1];1;4 -testChannel2;0;0.000000000;0.000000000;[1];1;0 -testChannel2;1;0.010000000;0.010000000;[1];1;1 -testChannel2;2;0.020000000;0.020000000;[1];1;2 -testChannel2;3;0.030000000;0.030000000;[1];1;3 -testChannel2;4;0.040000000;0.040000000;[1];1;4 -``` - #### Querying for Specific Fields Allows for server side optimizations since not all data needs to be retrieved. @@ -525,6 +474,57 @@ curl -H "Content-Type: application/json" -X POST -d '{"fields":["pulseId","valu ] ``` +#### Query CSV Format + +```json +{ + "responseFormat":"csv", + "range":{ + "startPulseId":0, + "endPulseId":4 + }, + "channels":[ + "channel1", + "channel2" + ], + "fields":[ + "channel", + "pulseId", + "iocSeconds", + "globalSeconds", + "shape", + "eventCount", + "value" + ] +} +``` + +It is possible to request the time in seconds (since January 1, 1970 (the UNIX epoch) as a decimal value including fractional seconds - using fields *globalSeconds* and *iocSeconds*), in milliseconds (since January 1, 1970 (the JAVA epoch) - using fields *globalMillis* and *iocMillis*) or as a ISO8601 formatted String - using fields *globalDate* and *iocDate* (such as 1997-07-16T19:20:30.123456789+02:00). + +##### Command + +```bash +curl -H "Content-Type: application/json" -X POST -d '{"responseFormat":"csv","range":{"startPulseId":0,"endPulseId":4},"channels":["channel1","channel2"],"fields":["channel","pulseId","iocSeconds","globalSeconds","shape","eventCount","value"]}' http://data-api.psi.ch/sf/query +``` + +##### Response + +The response is in CSV. + +```text +channel;pulseId;iocSeconds;globalSeconds;shape;eventCount;value +testChannel1;0;0.000000000;0.000000000;[1];1;0 +testChannel1;1;0.010000000;0.010000000;[1];1;1 +testChannel1;2;0.020000000;0.020000000;[1];1;2 +testChannel1;3;0.030000000;0.030000000;[1];1;3 +testChannel1;4;0.040000000;0.040000000;[1];1;4 +testChannel2;0;0.000000000;0.000000000;[1];1;0 +testChannel2;1;0.010000000;0.010000000;[1];1;1 +testChannel2;2;0.020000000;0.020000000;[1];1;2 +testChannel2;3;0.030000000;0.030000000;[1];1;3 +testChannel2;4;0.040000000;0.040000000;[1];1;4 +``` + #### Data Ordering ```json