enterprise_dashboard_data_api v1.0.2
enterprise_dashboard_data_api
EnterpriseDashboardDataApi - JavaScript client for enterprise_dashboard_data_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install enterprise_dashboard_data_api --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your enterprise_dashboard_data_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('enterprise_dashboard_data_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/enterprise_dashboard_data_api then install it via:
npm install YOUR_USERNAME/enterprise_dashboard_data_api --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var EnterpriseDashboardDataApi = require('enterprise_dashboard_data_api');
var api = new EnterpriseDashboardDataApi.DefaultApi()
var opts = {
'token': "token_example" // {String} The authorization token
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.appConfigurationGet(opts, callback);
Documentation for API Endpoints
All URIs are relative to https://safeview-control.rrhemergingtech.org/v1
Class | Method | HTTP request | Description |
---|---|---|---|
EnterpriseDashboardDataApi.DefaultApi | appConfigurationGet | GET /app-configuration | |
EnterpriseDashboardDataApi.DefaultApi | appConfigurationPut | PUT /app-configuration | |
EnterpriseDashboardDataApi.DefaultApi | areasLocationGet | GET /areas/{location} | |
EnterpriseDashboardDataApi.DefaultApi | areasLocationIdDelete | DELETE /areas/{location}/{id} | |
EnterpriseDashboardDataApi.DefaultApi | areasLocationIdGet | GET /areas/{location}/{id} | |
EnterpriseDashboardDataApi.DefaultApi | areasLocationIdPut | PUT /areas/{location}/{id} | |
EnterpriseDashboardDataApi.DefaultApi | areasLocationPost | POST /areas/{location} | |
EnterpriseDashboardDataApi.DefaultApi | areasLocationYearMonthUploadExcelSpreadsheetPost | POST /areas/{location}/{year}/{month}/upload-excel-spreadsheet | |
EnterpriseDashboardDataApi.DefaultApi | areasLocationsGet | GET /areas/locations | |
EnterpriseDashboardDataApi.DefaultApi | areasNormalizedAreasGet | GET /areas/normalized-areas | |
EnterpriseDashboardDataApi.DefaultApi | commentsCountGet | GET /comments/count | |
EnterpriseDashboardDataApi.DefaultApi | commentsTileIdGet | GET /comments/{tileId} | |
EnterpriseDashboardDataApi.DefaultApi | commentsTileIdIdDelete | DELETE /comments/{tileId}/{id} | |
EnterpriseDashboardDataApi.DefaultApi | commentsTileIdIdPut | PUT /comments/{tileId}/{id} | |
EnterpriseDashboardDataApi.DefaultApi | commentsTileIdPost | POST /comments/{tileId} | |
EnterpriseDashboardDataApi.DefaultApi | compareGet | GET /compare | |
EnterpriseDashboardDataApi.DefaultApi | dailyAreaReportExcelSpreadsheetLocationYearMonthGet | GET /daily-area-report/excel-spreadsheet/{location}/{year}/{month} | |
EnterpriseDashboardDataApi.DefaultApi | dailyAreaReportLocationAreaYearMonthDayGet | GET /daily-area-report/{location}/{area}/{year}/{month}/{day} | |
EnterpriseDashboardDataApi.DefaultApi | dailyAreaReportLocationAreaYearMonthDayPut | PUT /daily-area-report/{location}/{area}/{year}/{month}/{day} | |
EnterpriseDashboardDataApi.DefaultApi | dailyAreaReportLocationYearMonthDayUploadExcelSpreadsheetPost | POST /daily-area-report/{location}/{year}/{month}/{day}/upload-excel-spreadsheet | |
EnterpriseDashboardDataApi.DefaultApi | dailyAreaReportSummaryLocationYearMonthDayGet | GET /daily-area-report/summary/{location}/{year}/{month}/{day} | |
EnterpriseDashboardDataApi.DefaultApi | dataServicesLoadDataSourceNamePost | POST /data-services/load/{dataSourceName} | |
EnterpriseDashboardDataApi.DefaultApi | dataServicesTransformDataSourceNameYearMonthDayPost | POST /data-services/transform/{dataSourceName}/{year}/{month}/{day} | |
EnterpriseDashboardDataApi.DefaultApi | dataServicesTransformDataSourceNameYearMonthPost | POST /data-services/transform/{dataSourceName}/{year}/{month} | |
EnterpriseDashboardDataApi.DefaultApi | dataServicesTransformDataSourceNameYearPost | POST /data-services/transform/{dataSourceName}/{year} | |
EnterpriseDashboardDataApi.DefaultApi | hierarchyHierarchyGet | GET /hierarchy/{hierarchy} | |
EnterpriseDashboardDataApi.DefaultApi | insightsTileIdGet | GET /insights/{tileId}/ | |
EnterpriseDashboardDataApi.DefaultApi | insightsTileIdPut | PUT /insights/{tileId}/ | |
EnterpriseDashboardDataApi.DefaultApi | kpiCategoriesGet | GET /kpi-categories | |
EnterpriseDashboardDataApi.DefaultApi | kpiCategoriesTileIdGet | GET /kpi-categories/{tileId} | |
EnterpriseDashboardDataApi.DefaultApi | kpiDataDataIdGet | GET /kpi-data/{dataId} | |
EnterpriseDashboardDataApi.DefaultApi | kpiDefinitionsDataSourcesDataIdDelete | DELETE /kpi-definitions/data-sources/{dataId} | |
EnterpriseDashboardDataApi.DefaultApi | kpiDefinitionsDataSourcesDataIdGet | GET /kpi-definitions/data-sources/{dataId} | |
EnterpriseDashboardDataApi.DefaultApi | kpiDefinitionsDataSourcesDataIdPut | PUT /kpi-definitions/data-sources/{dataId} | |
EnterpriseDashboardDataApi.DefaultApi | kpiDefinitionsDataSourcesGet | GET /kpi-definitions/data-sources | |
EnterpriseDashboardDataApi.DefaultApi | kpiDefinitionsTilesGet | GET /kpi-definitions/tiles | |
EnterpriseDashboardDataApi.DefaultApi | kpiDefinitionsTilesTileIdDelete | DELETE /kpi-definitions/tiles/{tileId} | |
EnterpriseDashboardDataApi.DefaultApi | kpiDefinitionsTilesTileIdGet | GET /kpi-definitions/tiles/{tileId} | |
EnterpriseDashboardDataApi.DefaultApi | kpiDefinitionsTilesTileIdPut | PUT /kpi-definitions/tiles/{tileId} | |
EnterpriseDashboardDataApi.DefaultApi | kpiDetailGet | GET /kpi-detail | |
EnterpriseDashboardDataApi.DefaultApi | menusGet | GET /menus | |
EnterpriseDashboardDataApi.DefaultApi | seriousSafetyEventsLocationGet | GET /serious-safety-events/{location} | |
EnterpriseDashboardDataApi.DefaultApi | seriousSafetyEventsLocationPost | POST /serious-safety-events/{location} | |
EnterpriseDashboardDataApi.DefaultApi | seriousSafetyEventsLocationSecondsSinceLastEventGet | GET /serious-safety-events/{location}/seconds-since-last-event | |
EnterpriseDashboardDataApi.DefaultApi | sidebarsLocationYearMonthDayGet | GET /sidebars/{location}/{year}/{month}/{day} | |
EnterpriseDashboardDataApi.DefaultApi | sidebarsLocationYearMonthDayPost | POST /sidebars/{location}/{year}/{month}/{day} | |
EnterpriseDashboardDataApi.DefaultApi | sidebarsSidebarIdDelete | DELETE /sidebars/{sidebarId} | |
EnterpriseDashboardDataApi.DefaultApi | sidebarsSidebarIdGet | GET /sidebars/{sidebarId} | |
EnterpriseDashboardDataApi.DefaultApi | sidebarsSidebarIdPut | PUT /sidebars/{sidebarId} | |
EnterpriseDashboardDataApi.DefaultApi | usersAppDataTileIdGet | GET /users/app-data/{tileId} | |
EnterpriseDashboardDataApi.DefaultApi | usersAppDataTileIdPut | PUT /users/app-data/{tileId} | |
EnterpriseDashboardDataApi.DefaultApi | usersGet | GET /users | |
EnterpriseDashboardDataApi.DefaultApi | usersHiddenGet | GET /users/hidden | |
EnterpriseDashboardDataApi.DefaultApi | usersPut | PUT /users | |
EnterpriseDashboardDataApi.DefaultApi | usersTileIdWatchDelete | DELETE /users/{tileId}/watch | |
EnterpriseDashboardDataApi.DefaultApi | usersTileIdWatchPut | PUT /users/{tileId}/watch | |
EnterpriseDashboardDataApi.DefaultApi | usersWatchGet | GET /users/watch | |
EnterpriseDashboardDataApi.DefaultApi | viewsCountGet | GET /views/count | |
EnterpriseDashboardDataApi.DefaultApi | viewsTileIdCountGet | GET /views/{tileId}/count | |
EnterpriseDashboardDataApi.DefaultApi | viewsTileIdPut | PUT /views/{tileId} |
Documentation for Models
- EnterpriseDashboardDataApi.AppConfiguration
- EnterpriseDashboardDataApi.AppData
- EnterpriseDashboardDataApi.Area
- EnterpriseDashboardDataApi.Areas
- EnterpriseDashboardDataApi.ChartData
- EnterpriseDashboardDataApi.ChartDatas
- EnterpriseDashboardDataApi.Comment
- EnterpriseDashboardDataApi.Comments
- EnterpriseDashboardDataApi.Compare
- EnterpriseDashboardDataApi.CompareColumn
- EnterpriseDashboardDataApi.Count
- EnterpriseDashboardDataApi.DailyAreaReport
- EnterpriseDashboardDataApi.DailyAreaReportSummary
- EnterpriseDashboardDataApi.DataConfiguration
- EnterpriseDashboardDataApi.DataDefinitions
- EnterpriseDashboardDataApi.DataItem
- EnterpriseDashboardDataApi.Family
- EnterpriseDashboardDataApi.HiddenData
- EnterpriseDashboardDataApi.HiddenDatas
- EnterpriseDashboardDataApi.Hierarchy
- EnterpriseDashboardDataApi.HierarchyData
- EnterpriseDashboardDataApi.Insights
- EnterpriseDashboardDataApi.Kpi
- EnterpriseDashboardDataApi.KpiCategories
- EnterpriseDashboardDataApi.KpiCategory
- EnterpriseDashboardDataApi.KpiData
- EnterpriseDashboardDataApi.KpiDetail
- EnterpriseDashboardDataApi.Locations
- EnterpriseDashboardDataApi.Menu
- EnterpriseDashboardDataApi.Menus
- EnterpriseDashboardDataApi.MetadataProperties
- EnterpriseDashboardDataApi.NameArraySource
- EnterpriseDashboardDataApi.NameValue
- EnterpriseDashboardDataApi.NameValueSource
- EnterpriseDashboardDataApi.NormalizedAreas
- EnterpriseDashboardDataApi.Notes
- EnterpriseDashboardDataApi.Notification
- EnterpriseDashboardDataApi.Notifications
- EnterpriseDashboardDataApi.NumericData
- EnterpriseDashboardDataApi.NumericDataLines
- EnterpriseDashboardDataApi.Option
- EnterpriseDashboardDataApi.PeriodData
- EnterpriseDashboardDataApi.Preferences
- EnterpriseDashboardDataApi.SelectItem
- EnterpriseDashboardDataApi.SeriousSafetyEvent
- EnterpriseDashboardDataApi.SeriousSafetyEvents
- EnterpriseDashboardDataApi.Sidebar
- EnterpriseDashboardDataApi.Sidebars
- EnterpriseDashboardDataApi.SortProperty
- EnterpriseDashboardDataApi.StateCategories
- EnterpriseDashboardDataApi.TileConfiguration
- EnterpriseDashboardDataApi.TileDefinitions
- EnterpriseDashboardDataApi.TimeInSeconds
- EnterpriseDashboardDataApi.User
- EnterpriseDashboardDataApi.Views
- EnterpriseDashboardDataApi.WatchData
- EnterpriseDashboardDataApi.WatchDatas
Documentation for Authorization
All endpoints do not require authorization.
7 years ago