List Widgets
Query
GET /api/1.0/widgets?byCategory=<byCategory>
Parameter | Comments |
---|---|
byCategory | Query parameter, optional. If set, then widgets filtered by specified category |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "list":[ { "id":25901, "name":"test5", "userId":10077, "customerId":1033, "datasetId":15150, "type":2, "description":null, "urlString":"02SscJ", "access":0, "refreshChartMillis":-1, "createdDate":1492282355000, "jsonConfig":null, "queryId":-1, "queryStr":null, "adhocQuery":null, "category":"All", "drilldown":false, "dataset":{ "createdDate":1492282355000, "lastModDate":1492282355000, "id":15150, "metadataConfig":"{\"fieldNames\":[\"id_0\",\"id\",\"geometry\",\"properties\"],\"dataTypes\":{\"id_0\":\"java.lang.String\",\"id\":\"java.lang.String\",\"geometry\":\"java.util.Map\",\"properties\":\"java.util.Map\"}}", "mongoId":null, "mongoConnectUri":"localhost:27017/Some_a3PNFK", "customerId":1033, "datasetName":"test5", "identifier":null, "userId":0, "customer":null, "metaData":{ "fieldNames":[ "id_0", "id", "geometry", "properties" ], "dataTypes":{ "id_0":"java.lang.String", "id":"java.lang.String", "geometry":"java.util.Map", "properties":"java.util.Map" } } }, "position":{ "chartId":25901, "width":-1, "height":-1, "originalScreenWidth":-1, "originalScreenHeight":-1, "col":1, "row":13, "id":25901, "xpos":0, "ypos":0, "size_x":12, "size_y":12 }, "associations":null, "queryModified":false, "updateFilters":false, "dataFields":[ ], "transientChartFilters":null, "typeModified":false, "lastSyncDate":1492282355000, "viewOnly":false, "truncated":false, "processedName":"test5", "widgetConfig":null, "chartProperties":{ "chart.type":"datagrid" }, "statusIndColumns":[ ], "gridBean":null, "dataRow":null, "text":"", "colNames":null, "dataRows":null, "live":false, "filters":null, "widgetType":"DATA_GRID", "macros":null, "strictFilters":null, "dbFields":[ ], "widgetTypeStr":"datagrid", "filterFieldDataTypes":{ "geometry":"java.util.Map", "id":"java.lang.String", "id_0":"java.lang.String", "properties":"java.util.Map" }, "allFilters":[ ], "processedFilters":[ ] } ] } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER"
https://www.knowi.com/api/1.0/widgets/
Get Widget Details by Id
Query
GET /api/1.0/widgets/<objectId>
Parameter | Comments |
---|---|
objectId | Widget id to view |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "id":25901, "name":"test5", "userId":10077, "customerId":1033, "datasetId":15150, "type":2, "description":null, "urlString":"02SscJ", "access":0, "refreshChartMillis":-1, "createdDate":1492282355000, "jsonConfig":null, "queryId":-1, "queryStr":null, "adhocQuery":null, "category":"All", "drilldown":false, "dataset":{ "createdDate":1492282355000, "lastModDate":1492282355000, "id":15150, "metadataConfig":"{\"fieldNames\":[\"id_0\",\"id\",\"geometry\",\"properties\"],\"dataTypes\":{\"id_0\":\"java.lang.String\",\"id\":\"java.lang.String\",\"geometry\":\"java.util.Map\",\"properties\":\"java.util.Map\"}}", "mongoId":null, "mongoConnectUri":"localhost:27017/Some_a3PNFK", "customerId":1033, "datasetName":"test5", "identifier":null, "userId":0, "customer":null, "metaData":{ "fieldNames":[ "id_0", "id", "geometry", "properties" ], "dataTypes":{ "id_0":"java.lang.String", "id":"java.lang.String", "geometry":"java.util.Map", "properties":"java.util.Map" } } }, "position":{ "chartId":25901, "width":-1, "height":-1, "originalScreenWidth":-1, "originalScreenHeight":-1, "col":1, "row":13, "id":25901, "xpos":0, "ypos":0, "size_x":12, "size_y":12 }, "associations":null, "queryModified":false, "updateFilters":false, "dataFields":[ ], "transientChartFilters":null, "typeModified":false, "lastSyncDate":1492282355000, "viewOnly":false, "truncated":false, "processedName":"test5", "widgetConfig":null, "chartProperties":{ "chart.type":"datagrid" }, "statusIndColumns":[ ], "gridBean":null, "dataRow":null, "text":"", "colNames":null, "dataRows":null, "live":false, "filters":null, "widgetType":"DATA_GRID", "macros":null, "strictFilters":null, "dbFields":[ ], "widgetTypeStr":"datagrid", "filterFieldDataTypes":{ "geometry":"java.util.Map", "id":"java.lang.String", "id_0":"java.lang.String", "properties":"java.util.Map" }, "allFilters":[ ], "processedFilters":[ ] } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER"
https://www.knowi.com/api/1.0/widgets/10001
Get Widget Share Url
POST /api/1.0/widgets/<objectId>/share/url
Parameter | Comments |
---|---|
objectId | Widget id to generate share url |
contentFilters | Optional form parameter content filters |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "shareUrl": "Zar1OtKVb7iiiiV6Ufa8VJ25Wo3jvrPI1aySdisvceplMEie?contentFilters=%5B%7B%22fieldName%22%3A%22Customer%22%2C%22values%22%3A%5B%22Facebook%22%5D%2C%22operator%22%3A%22%3D%22%7D%5D" } Note: To construct the full url, prepend /w/ and the “shareUrl” to the host name and port. For example: http://localhost:9090/w/Zar1OtKVb7iiiiV6UfI1aySdisvceplMEie?contentFilters=%5B%7B%22fieldName%22%3A%22Customer%22%2C%22values%Facebook%22%5D%2C%22operator%22%3A%22 |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -X POST -i http://localhost:9090/api/1.0/widgets/3528/share/url -H 'Authorization: Bearer HERE_IS_YOUR_BEARER' -H 'Content-Type: application/x-www-form-urlencoded' -d 'contentFilters=[{"fieldName":"Customer","values":["Facebook"],"operator":"="}]'
Get Widget Secure Share Url
POST /api/1.0/widgets/<objectId>/share/url/secure
Parameter | Comments |
---|---|
objectId | Widget id to generate secure share url |
contentFilters | Optional form parameter content filters |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "secureShareUrl": "S0jBEWZ2WLNCCe8pXQYtTbip3zrq3oaM8iplCQDzEhpEkie/dnqPwU7UF61jmT+rgIft4aEY1kWQ1B1V4FWGoIGITmZGl___n3P859PnDoJlcSiov6CIWd___8Dpvl5JH74SIhJxww==" } Note: To construct the full url, prepend /w-secure/ and the “secureShareUrl” to the host name and port. For example: http://localhost:9090/w-secure/S0jBEWZ2WLNCCe8pXQYtTbip3zrq3oaM8iplCQDzEhpEkie/dnqPwU7UF61jmT+rgIft4aEY1kWQ1B1V4FWGoIGITmZGl___n3P859PnDoJlcSiov6CIWd___8Dpvl5JH74SIhJxww== |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -X POST -i http://localhost:9090/api/1.0/widgets/3528/share/url/secure -H 'Authorization: Bearer HERE_IS_YOUR_BEARER' -H 'Content-Type: application/x-www-form-urlencoded' -d 'contentFilters=[{"fieldName":"Customer","values":["Facebook"],"operator":"="}]'
Create Widget
Query
POST /api/1.0/widgets/
POST JSON payload:
Parameter | Comments |
---|---|
datasetId | Id of Dataset to use to create Widget |
widgetName | Widget name |
Response
HTTP Status | Response |
---|---|
200 OK | Return created Widget json info (same as "Get widget" command). Output example:
{ "id":25901, "name":"test5", "userId":10077, "customerId":1033, "datasetId":15150, "type":2, "description":null, "urlString":"02SscJ", "access":0, "refreshChartMillis":-1, "createdDate":1492282355000, "jsonConfig":null, "queryId":-1, "queryStr":null, "adhocQuery":null, "category":"All", "drilldown":false, "dataset":{ "createdDate":1492282355000, "lastModDate":1492282355000, "id":15150, "metadataConfig":"{\"fieldNames\":[\"id_0\",\"id\",\"geometry\",\"properties\"],\"dataTypes\":{\"id_0\":\"java.lang.String\",\"id\":\"java.lang.String\",\"geometry\":\"java.util.Map\",\"properties\":\"java.util.Map\"}}", "mongoId":null, "mongoConnectUri":"localhost:27017/Some_a3PNFK", "customerId":1033, "datasetName":"test5", "identifier":null, "userId":0, "customer":null, "metaData":{ "fieldNames":[ "id_0", "id", "geometry", "properties" ], "dataTypes":{ "id_0":"java.lang.String", "id":"java.lang.String", "geometry":"java.util.Map", "properties":"java.util.Map" } } }, "position":{ "chartId":25901, "width":-1, "height":-1, "originalScreenWidth":-1, "originalScreenHeight":-1, "col":1, "row":13, "id":25901, "xpos":0, "ypos":0, "size_x":12, "size_y":12 }, "associations":null, "queryModified":false, "updateFilters":false, "dataFields":[ ], "transientChartFilters":null, "typeModified":false, "lastSyncDate":1492282355000, "viewOnly":false, "truncated":false, "processedName":"test5", "widgetConfig":null, "chartProperties":{ "chart.type":"datagrid" }, "statusIndColumns":[ ], "gridBean":null, "dataRow":null, "text":"", "colNames":null, "dataRows":null, "live":false, "filters":null, "widgetType":"DATA_GRID", "macros":null, "strictFilters":null, "dbFields":[ ], "widgetTypeStr":"datagrid", "filterFieldDataTypes":{ "geometry":"java.util.Map", "id":"java.lang.String", "id_0":"java.lang.String", "properties":"java.util.Map" }, "allFilters":[ ], "processedFilters":[ ] } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X POST -d "{\"datasetId\":15134,\"widgetName\":\"newWidgetName1\"}"
https://www.knowi.com/api/1.0/widgets
Delete Widget
Query
DELETE /api/1.0/widgets/<objectId>
Parameter | Comments |
---|---|
objectId | Widget id to delete |
Response
HTTP Status | Response |
---|---|
200 OK | No response body |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -X DELETE
https://www.knowi.com/api/1.0/widgets/25902
Edit Widget
Query
PUT /api/1.0/widgets/<objectId>
Parameter | Comments |
---|---|
objectId | Widget id of Widget to edit |
PUT JSON payload:
Parameter | Comments |
---|---|
widgetName | Widget name |
Response
HTTP Status | Response |
---|---|
200 OK | Return edited Widget json info (same as "Get Widget" command). Output example:
{ "id":25901, "name":"test5", "userId":10077, "customerId":1033, "datasetId":15150, "type":2, "description":null, "urlString":"02SscJ", "access":0, "refreshChartMillis":-1, "createdDate":1492282355000, "jsonConfig":null, "queryId":-1, "queryStr":null, "adhocQuery":null, "category":"All", "drilldown":false, "dataset":{ "createdDate":1492282355000, "lastModDate":1492282355000, "id":15150, "metadataConfig":"{\"fieldNames\":[\"id_0\",\"id\",\"geometry\",\"properties\"],\"dataTypes\":{\"id_0\":\"java.lang.String\",\"id\":\"java.lang.String\",\"geometry\":\"java.util.Map\",\"properties\":\"java.util.Map\"}}", "mongoId":null, "mongoConnectUri":"localhost:27017/Some_a3PNFK", "customerId":1033, "datasetName":"test5", "identifier":null, "userId":0, "customer":null, "metaData":{ "fieldNames":[ "id_0", "id", "geometry", "properties" ], "dataTypes":{ "id_0":"java.lang.String", "id":"java.lang.String", "geometry":"java.util.Map", "properties":"java.util.Map" } } }, "position":{ "chartId":25901, "width":-1, "height":-1, "originalScreenWidth":-1, "originalScreenHeight":-1, "col":1, "row":13, "id":25901, "xpos":0, "ypos":0, "size_x":12, "size_y":12 }, "associations":null, "queryModified":false, "updateFilters":false, "dataFields":[ ], "transientChartFilters":null, "typeModified":false, "lastSyncDate":1492282355000, "viewOnly":false, "truncated":false, "processedName":"test5", "widgetConfig":null, "chartProperties":{ "chart.type":"datagrid" }, "statusIndColumns":[ ], "gridBean":null, "dataRow":null, "text":"", "colNames":null, "dataRows":null, "live":false, "filters":null, "widgetType":"DATA_GRID", "macros":null, "strictFilters":null, "dbFields":[ ], "widgetTypeStr":"datagrid", "filterFieldDataTypes":{ "geometry":"java.util.Map", "id":"java.lang.String", "id_0":"java.lang.String", "properties":"java.util.Map" }, "allFilters":[ ], "processedFilters":[ ] } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d "{\"widgetName\":\"updatedWidgetName1\"}"
https://www.knowi.com/api/1.0/widgets/123
Clone Widget
Query
POST /api/1.0/widgets/<objectIdToClone>
Parameter | Comments |
---|---|
objectIdToClone | Widget id of Widget to clone |
POST JSON payload:
Parameter | Comments |
---|---|
widgetName | New (cloned) Name of Widget |
Response
HTTP Status | Response |
---|---|
200 OK | Return cloned Widget json info (same as "Get Widget" command). Output example:
{ "id":25901, "name":"test5", "userId":10077, "customerId":1033, "datasetId":15150, "type":2, "description":null, "urlString":"02SscJ", "access":0, "refreshChartMillis":-1, "createdDate":1492282355000, "jsonConfig":null, "queryId":-1, "queryStr":null, "adhocQuery":null, "category":"All", "drilldown":false, "dataset":{ "createdDate":1492282355000, "lastModDate":1492282355000, "id":15150, "metadataConfig":"{\"fieldNames\":[\"id_0\",\"id\",\"geometry\",\"properties\"],\"dataTypes\":{\"id_0\":\"java.lang.String\",\"id\":\"java.lang.String\",\"geometry\":\"java.util.Map\",\"properties\":\"java.util.Map\"}}", "mongoId":null, "mongoConnectUri":"localhost:27017/Some_a3PNFK", "customerId":1033, "datasetName":"test5", "identifier":null, "userId":0, "customer":null, "metaData":{ "fieldNames":[ "id_0", "id", "geometry", "properties" ], "dataTypes":{ "id_0":"java.lang.String", "id":"java.lang.String", "geometry":"java.util.Map", "properties":"java.util.Map" } } }, "position":{ "chartId":25901, "width":-1, "height":-1, "originalScreenWidth":-1, "originalScreenHeight":-1, "col":1, "row":13, "id":25901, "xpos":0, "ypos":0, "size_x":12, "size_y":12 }, "associations":null, "queryModified":false, "updateFilters":false, "dataFields":[ ], "transientChartFilters":null, "typeModified":false, "lastSyncDate":1492282355000, "viewOnly":false, "truncated":false, "processedName":"test5", "widgetConfig":null, "chartProperties":{ "chart.type":"datagrid" }, "statusIndColumns":[ ], "gridBean":null, "dataRow":null, "text":"", "colNames":null, "dataRows":null, "live":false, "filters":null, "widgetType":"DATA_GRID", "macros":null, "strictFilters":null, "dbFields":[ ], "widgetTypeStr":"datagrid", "filterFieldDataTypes":{ "geometry":"java.util.Map", "id":"java.lang.String", "id_0":"java.lang.String", "properties":"java.util.Map" }, "allFilters":[ ], "processedFilters":[ ] } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X POST -d "{\"widgetName\":\"clonedWidgetName1\"}"
https://www.knowi.com/api/1.0/widgets/12345
Share Widget to Users/Groups
Query
PUT /api/1.0/widgets/<objectId>/share
Parameter | Comments |
---|---|
objectId | Widget Id to share |
sso_user | Optional bool. Set to `true` if sharing to sso user |
PUT JSON payload:
Parameter | Comments |
---|---|
shareProperties | Share properties json array. Available fields:
|
Response
HTTP Status | Response |
---|---|
200 OK | No response body |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |