diff --git a/README.md b/README.md index 5b5cb1a..c21a460 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![OpenGrid](img/branding/OpenGrid_Logo_Horizontal_3Color.png) -[![Build status - Linux](https://img.shields.io/travis/Chicago/opengrid/master.svg?style=flat-square&label=Linux build)](https://travis-ci.org/Chicago/opengrid)[![Build status - Windows](https://img.shields.io/appveyor/ci/tomschenkjr/opengrid/master.svg?style=flat-square&label=Windows build)](https://ci.appveyor.com/project/tomschenkjr/opengrid)[![Node.js dependencies](https://img.shields.io/coveralls/Chicago/opengrid/master.svg?style=flat-square)](https://coveralls.io/github/Chicago/opengrid)[![Node.js](https://img.shields.io/node/v/gh-badges.svg?style=flat-square)](https://david-dm.org/Chicago/opengrid)[![Node.js dependencies](https://img.shields.io/david/Chicago/opengrid.svg?style=flat-square)](https://david-dm.org/Chicago/opengrid)[![Node.js devdependencies](https://img.shields.io/david/dev/chicago/opengrid.svg?style=flat-square)](https://david-dm.org/Chicago/opengrid#info=devDependencies&view=table) +[![Build status-Linux](https://img.shields.io/travis/Chicago/opengrid/master.svg?style=flat-square&label=Linux build)](https://travis-ci.org/Chicago/opengrid)[![Build status-Windows](https://img.shields.io/appveyor/ci/tomschenkjr/opengrid/master.svg?style=flat-square&label=Windows build)](https://ci.appveyor.com/project/tomschenkjr/opengrid)[![Node.js dependencies](https://img.shields.io/coveralls/Chicago/opengrid/master.svg?style=flat-square)](https://coveralls.io/github/Chicago/opengrid)[![Node.js](https://img.shields.io/node/v/gh-badges.svg?style=flat-square)](https://david-dm.org/Chicago/opengrid)[![Node.js dependencies](https://img.shields.io/david/Chicago/opengrid.svg?style=flat-square)](https://david-dm.org/Chicago/opengrid)[![Node.js devdependencies](https://img.shields.io/david/dev/chicago/opengrid.svg?style=flat-square)](https://david-dm.org/Chicago/opengrid#info=devDependencies&view=table) OpenGrid an open-source, interactive map platform that allows users to explore multiple data sources in an easy-to-use interface. Developed to support situational awareness, incident monitoring and responses, historical data retrieval, and real-time advanced analytics. Users can perform advanced queries to filter data, search within custom boundaries, or based on the users location. Other GIS data, such as weather and Shapefiles can be overlaid on the map with other data. OpenGrid is natively compatible with desktops and mobile devices. @@ -10,8 +10,7 @@ OpenGrid uses a service layer to retrieve data from an underlying data store. * User Documentation: http://docs.opengrid.io * Repository for User Interface: https://github.com/Chicago/opengrid -* Repository for -* Planning Documentation and Meeting Notes: https://github.com/Chicago/opengrid/wiki +* Repository for Planning Documentation and Meeting Notes: https://github.com/Chicago/opengrid/wiki * Issues: https://github.com/Chicago/opengrid/issues * Mailing List & Discussion: https://groups.google.com/forum/#!forum/opengrid-chicago diff --git a/docs/Administration.md b/docs/Administration.md index 81c3e09..00e876a 100644 --- a/docs/Administration.md +++ b/docs/Administration.md @@ -1,8 +1,8 @@ -#Administration -### Overview +
Administration has the authority to manage users’ responsibilities; as well as provide arrangements and tasks needed to control the users operation. They also allow access to specified functionalities.
-The Administration has the authority to:The Administration has the authority to:
- {
- "error": {
- "code": "<error code>",
- "message": "<error message>"
- }
- }
-
+
+```
+ {
+ "error": {
+ "code": "Sample Request
Request Payload:
+ ``` { "username": "admin", "password": "xxx" } ``` +Sample Response
The authentication token is returned, the authentication token consist of three sections separated by dots(.): HEADER.PAYLOAD.SIGNATURE; the key X-AUTH-TOKEN is appended to the response header below:
+ ``` X-AUTH-TOKEN: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiIsImV4cCI6MTQzOTMzNjQwNywianRpIjoiYWRtaW4iLCJyb2xlcyI6Im9wZW5ncmlkX2FkbWlucyIsImZuYW1lIjoiT3BlbkdyaWQiLCJsbmFtZSI6IkFkbWluIn0.nShqceUs52ykIxu0RBRp4vZ8zaQqfdZ2haZn8AWMqyq5GJHRQkddoOaaLtKABktr32C0zha1pMJJBrjuYoPHIQ ``` +This token can be parsed using the jwt_decode JavaScript Web Token library (See https://github.com/auth0/jwt-decode)
@@ -202,11 +207,12 @@ This token can be parsed using the jwt_decode JavaScript Web Token ``` { "id":null, - "o":{"userId":"test3", - "password":"testxxx", - "firstName":"Test", - "lastName":"Three", - "groups":[] + "o":{ + "userId":"test3", + "password":"testxxx", + "firstName":"Test", + "lastName":"Three", + "groups":[] } } ``` @@ -249,7 +255,7 @@ This token can be parsed using the jwt_decode JavaScript Web Token ``` { "_id": - {"$oid":"55b63708a3db5f292c533c7b"}, + {"$oid":"55b63708a3db5f292c533c7b"}, "userId":"TesterOne", "password":"test123", "firstName":"ABC Test", @@ -279,21 +285,22 @@ This token can be parsed using the jwt_decode JavaScript Web Token ``` { "id":{"$oid":"55ccaca15fc6c6bf8a807cf2"}, - "o":{ - "_id": - {"$oid":"55ccaca15fc6c6bf8a807cf2"}, - "userId":"twitterUser", - "password":"testxxx", - "firstName":"Twitter", - "lastName":"User", - "groups":[ - "opengrid_users_L1", - "opengrid_users_L2"] - } + "o":{ + "_id": + {"$oid":"55ccaca15fc6c6bf8a807cf2"}, + "userId":"twitterUser", + "password":"testxxx", + "firstName":"Twitter", + "lastName":"User", + "groups":[ + "opengrid_users_L1", + "opengrid_users_L2"] + } } ```Sample Response
+ ``` { "userId":"test3", @@ -303,7 +310,7 @@ This token can be parsed using the jwt_decode JavaScript Web Token "groups":[ ] } ``` - +DELETE /user/{user_id}
Delete a user given the user’s internal Id on the URL path.
@@ -376,23 +383,22 @@ The maximum number of records to return; If this parameter is not specified, noSample Response
``` [ {"_id" : - {"$oid":"55c0c620a3db5f3058630eb3"}, + {"$oid":"55c0c620a3db5f3058630eb3"}, "groupId":"opengrid_users", "name":"OpenGrid Users", "description":"Group for all OpenGrid users", "enabled": true, "functions": [ - "Quick Search", - "Advanced Search"], + "Quick Search", + "Advanced Search"], "datasets": [ - "twitter", - "weather"] + "twitter", + "weather"] } ] ``` @@ -453,15 +459,15 @@ The maximum number of records to return; If this parameter is not specified, no "description" : "Group for all OpenGrid users", "enabled" : true, "functions" : [ - "Quick Search", - "Advanced Search"], + "Quick Search", + "Advanced Search"], "datasets" : [ - "twitter", - "weather"] + "twitter", + "weather"] } ] ``` - +PUT/groups/{group_id}
Update a group (group-level attributes and members). Returns the updated group data, if successful.
@@ -482,17 +488,18 @@ The maximum number of records to return; If this parameter is not specified, no ``` { - "id":{"$oid":"55c525c6c4aae748132f4d06"}, - "o":{"groupId":"opengrid_users_L2", - "name":"OpenGrid Users Level 2", - "description":"Users with access to weather data", - "enabled":true, - "isAdmin":false, - "functions":[ + "id":{"$oid":"55c525c6c4aae748132f4d06"}, + "o": { + "groupId":"opengrid_users_L2", + "name":"OpenGrid Users Level 2", + "description":"Users with access to weather data", + "enabled":true, + "isAdmin":false, + "functions":[ "Quick Search", "Advanced Search"], - "datasets":["weather"] - } + "datasets":["weather"] + } } ``` @@ -506,8 +513,8 @@ The maximum number of records to return; If this parameter is not specified, no "enabled" : true, "isAdmin" : false, "functions" : [ - "Quick Search", - "Advanced Search"], + "Quick Search", + "Advanced Search"], "datasets" : ["weather"] } ``` @@ -549,208 +556,229 @@ The maximum number of records to return; If this parameter is not specified, no "id" : "twitter", "displayName" : "Twitter", "options": {"rendition": - { - "icon" : "default", - "color" : "#001F7A", - "fillColor" : "#00FFFF", - "opacity" : 85, - "size" : 6 - } - }, - "columns": - [ - { - "id" : "_id", + { + "icon" : "default", + "color" : "#001F7A", + "fillColor" : "#00FFFF", + "opacity" : 85, + "size" : 6 + }, + "supportedOperators" : [ { + "dataType" : "string", + "operators" : [ + "equal", + "not_equal", + "in", + "begins_with", + "contains" + ] + } + ], + "quickSearch" : { + "enable" : true, + "triggerAlias" : "twe", + "triggerWord" : "tweet", + "hintCaption" : "Search Tweets", + "hintExample" : "tweet 'food'" + } + }, + "columns": + [ + { + "id" : "_id", + "displayName" : "ID", + "dataType" : "string", + "filter" : false, + "popup" : false, + "list" : false + }, + { + "id" : "date", + "displayName" : "Date", + "dataType" : "date", + "filter" : true, + "popup" : true, + "list" : true, + "sortOrder" : 1 + }, + { + "id": "screenName", + "displayName" : "Screen Name", + "dataType" : "string", + "filter" : true, + "popup" : true, + "list" : true, + "sortOrder" : 2, + "groupBy" : true, + "quickSearch" : true + }, + { + "id" : "text", + "displayName" : "Text", + "dataType" : "string", + "filter" : true, + "popup" : true, + "list" : true, + "sortOrder": 3, + "quickSearch" : true + }, + { + "id" : "city", + "displayName" : "City", + "dataType" : "string", + "filter" : true, + "popup" : true, + "list" : true, + "sortOrder" : 4, + "groupBy" : true, + "quickSearch" : true + }, + { + "id" :"bio", + "displayName" : "Bio", + "dataType" : "string", + "sortOrder" : 5 + }, + { + "id" : "hashtags", + "displayName" : "Hashtags", + "dataType" : "string", + "sortOrder" : 6 + }, + { + "id" : "lat", + "displayName" : "Latitude", + "dataType" : "float", + "list" : true, + "sortOrder" : 7 + }, + { + "id" : "long", + "displayName" : "Longitude", + "dataType" : "float", + "list" : true, + "sortOrder" : 8 + } + ] + }, + { + "id" : "weather", + "displayName" : "Weather", + "options" : {"rendition": + { + "icon" : "default", + "color" : "#8c2d04", + "fillColor" : "#fdae6b", + "opacity" : 85, + "size" : 6 + } + }, + "columns": + [ + { + "id": "_id", "displayName" : "ID", "dataType" : "string", "filter" : false, "popup" : false, "list" : false - }, - { - "id" : "date", - "displayName" : "Date", - "dataType" : "date", + }, + { + "id" : "temp", + "displayName" : "Temperature", + "dataType" : "float", "filter" : true, "popup" : true, "list" : true, "sortOrder" : 1 - }, - { - "id": "screenName", - "displayName" : "Screen Name", - "dataType" : "string", + }, + { + "id" : "windspeed", + "displayName" : "Wind Speed", + "dataType" : "float", "filter" : true, "popup" : true, "list" : true, - "sortOrder" : 2, - "groupBy" : true - }, - { - "id" : "text", - "displayName" : "Text", + "sortOrder" : 2 + }, + { + "id" : "condition", + "displayName" : "Condition", "dataType" : "string", "filter" : true, "popup" : true, "list" : true, - "sortOrder": 3 - }, + "sortOrder" : 3 + }, { - "id" : "city", - "displayName" : "City", - "dataType" : "string", + "id" : "humidity", + "displayName" : "Humidity", + "dataType" : "float", "filter" : true, "popup" : true, "list" : true, - "sortOrder" : 4, - "groupBy" : true - }, + "sortOrder" : 4 + }, { - "id" :"bio", - "displayName" : "Bio", - "dataType" : "string", + "id" : "precipIntensity", + "displayName" : "Precipitation Intensity", + "dataType" : "float", + "filter" : true, + "popup" : true, + "list" : true , "sortOrder" : 5 - }, + }, { - "id" : "hashtags", - "displayName" : "Hashtags", + "id" : "date", + "displayName" : "Date", + "dataType" : "date", + "filter" : true, + "popup" : true, + "list" : true, + "sortOrder" : 5 + }, + { + "id" : "zipcode", + "displayName" : "Zip Code", "dataType" : "string", - "sortOrder" : 6 - }, - { - "id" : "lat", - "displayName" : "Latitude", - "dataType" : "float", - "list" : true, - "sortOrder" : 7 - }, - { - "id" : "long", - "displayName" : "Longitude", - "dataType" : "float", + "filter" : true, + "popup" : true, "list" : true, - "sortOrder" : 8 - } - ] - }, - { - "id" : "weather", - "displayName" : "Weather", - "options" : {"rendition": - { - "icon" : "default", - "color" : "#8c2d04", - "fillColor" : "#fdae6b", - "opacity" : 85, - "size" : 6 - } - }, - "columns": - [ - { - "id": "_id", - "displayName" : "ID", - "dataType" : "string", - "filter" : false, - "popup" : false, - "list" : false - }, - { - "id" : "temp", - "displayName" : "Temperature", - "dataType" : "float", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder" : 1 - }, - { - "id" : "windspeed", - "displayName" : "Wind Speed", - "dataType" : "float", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder" : 2 - }, - { - "id" : "condition", - "displayName" : "Condition", - "dataType" : "string", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder" : 3 - }, - { - "id" : "humidity", - "displayName" : "Humidity", - "dataType" : "float", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder" : 4 - }, - { - "id" : "precipIntensity", - "displayName" : "Precipitation Intensity", - "dataType" : "float", - "filter" : true, - "popup" : true, - "list" : true , - "sortOrder" : 5 - }, - { - "id" : "date", - "displayName" : "Date", - "dataType" : "date", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder" : 5 - }, - { - "id" : "zipcode", - "displayName" : "Zip Code", - "dataType" : "string", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder" : 6, - "values" : [ 60601 , 60602], - "groupBy" : true + "sortOrder" : 6, + "values" : [ 60601 , 60602], + "groupBy" : true }, - { - "id" :"forecast", - "displayName" : "Today's Forecast", - "dataType" : "string", - "popup" : true, - "list" : true , - "sortOrder" : 7 + { + "id" :"forecast", + "displayName" : "Today's Forecast", + "dataType" : "string", + "popup" : true, + "list" : true , + "sortOrder" : 7 }, - { - "id" : "icon", - "displayName" : "Icon", - "dataType" : "graphic", - "popup" : true, - "sortOrder" : 7 + { + "id" : "icon", + "displayName" : "Icon", + "dataType" : "graphic", + "popup" : true, + "sortOrder" : 7 }, - { - "id" : "lat", - "displayName" : "Latitude", - "dataType" : "float", - "list" : true , - "sortOrder" : 8 + { + "id" : "lat", + "displayName" : "Latitude", + "dataType" : "float", + "list" : true , + "sortOrder" : 8 }, - { - "id" : "long", - "displayName" : "Longitude", - "dataType" : "float", - "list" : true, - "sortOrder" : 9 + { + "id" : "long", + "displayName" : "Longitude", + "dataType" : "float", + "list" : true, + "sortOrder" : 9 } - ] - } + ] + } ] ``` @@ -773,96 +801,114 @@ The maximum number of records to return; If this parameter is not specified, no ``` { "id" : "twitter", - "displayName" : "Twitter", - "options" : - {"rendition" : - { - "icon" : "default", - "color" : "#001F7A", - "fillColor" : "#00FFFF", - "opacity" : 85, - "size" : 6 - } - }, + "displayName" : "Twitter", + "options": {"rendition": + { + "icon" : "default", + "color" : "#001F7A", + "fillColor" : "#00FFFF", + "opacity" : 85, + "size" : 6 + }, + "supportedOperators" : [ + { + "dataType" : "string", + "operators" : [ + "equal", + "not_equal", + "in", + "begins_with", + "contains" + ] + } + ], + "quickSearch" : { + "enable" : true, + "triggerAlias" : "twe", + "triggerWord" : "tweet", + "hintCaption" : "Search Tweets", + "hintExample" : "tweet 'food'" + } + }, "columns" : [ - { - "id" : "_id", - "displayName" : "ID", - "dataType" : "string", - "filter" : false, - "popup" : false, - "list" : false - }, - { - "id" : "date", - "displayName" : "Date", - "dataType" : "date", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder": 1 - }, - { - "id" : "screenName", - "displayName" : "Screen Name", - "dataType" : "string", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder" : 2, - "groupBy" : true - }, - { - "id" : "text", - "displayName" : "Text", - "dataType" : "string", - "filter" : true, - "popup" : true, - "list" : true, - "sortOrder" : 3 - }, - { - "id" : "city", - "displayName" : "City", - "dataType" : "string", - "filter" : true, - "popup" : true, - "list" : true , - "sortOrder" : 4, - "groupBy" : true - }, - { - "id" : "bio", - "displayName" : "Bio", - "dataType" : "string", - "sortOrder" : 5 - }, - { - "id" : "hashtags", - "displayName" : "Hashtags", - "dataType" : "string", - "sortOrder" : 6 - }, - { - "id" : "lat", - "displayName" : "Latitude", - "dataType" : "float", - "list" : true , - "sortOrder" : 7 - }, - { - "id" : "long", - "displayName" : "Longitude", - "dataType" : "float", - "list" : true, - "sortOrder" : 8 - } + { + "id" : "_id", + "displayName" : "ID", + "dataType" : "string", + "filter" : false, + "popup" : false, + "list" : false + }, + { + "id" : "date", + "displayName" : "Date", + "dataType" : "date", + "filter" : true, + "popup" : true, + "list" : true, + "sortOrder": 1 + }, + { + "id" : "screenName", + "displayName" : "Screen Name", + "dataType" : "string", + "filter" : true, + "popup" : true, + "list" : true, + "sortOrder" : 2, + "groupBy" : true + }, + { + "id" : "text", + "displayName" : "Text", + "dataType" : "string", + "filter" : true, + "popup" : true, + "list" : true, + "sortOrder" : 3 + }, + { + "id" : "city", + "displayName" : "City", + "dataType" : "string", + "filter" : true, + "popup" : true, + "list" : true , + "sortOrder" : 4, + "groupBy" : true + }, + { + "id" : "bio", + "displayName" : "Bio", + "dataType" : "string", + "sortOrder" : 5 + }, + { + "id" : "hashtags", + "displayName" : "Hashtags", + "dataType" : "string", + "sortOrder" : 6 + }, + { + "id" : "lat", + "displayName" : "Latitude", + "dataType" : "float", + "list" : true , + "sortOrder" : 7 + }, + { + "id" : "long", + "displayName" : "Longitude", + "dataType" : "float", + "list" : true, + "sortOrder" : 8 + } ] } ``` -## 1.1.9 /datasets/{dataset_id}/query +GET/datasets/{dataset_id}/query
@@ -894,7 +940,6 @@ It is recommended that this value be URL encoded. -Optional parameters that can be passed depending on service capabilities. This value needs to be encoded for the call to work as expected. "geoFilter" is an attribute supported as of Release 1.1.0 and should be a valid geoJson geometry value.