1.0.2 • Published 7 years ago

enterprise_dashboard_data_api v1.0.2

Weekly downloads
-
License
Unlicense
Repository
-
Last release
7 years ago

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

ClassMethodHTTP requestDescription
EnterpriseDashboardDataApi.DefaultApiappConfigurationGetGET /app-configuration
EnterpriseDashboardDataApi.DefaultApiappConfigurationPutPUT /app-configuration
EnterpriseDashboardDataApi.DefaultApiareasLocationGetGET /areas/{location}
EnterpriseDashboardDataApi.DefaultApiareasLocationIdDeleteDELETE /areas/{location}/{id}
EnterpriseDashboardDataApi.DefaultApiareasLocationIdGetGET /areas/{location}/{id}
EnterpriseDashboardDataApi.DefaultApiareasLocationIdPutPUT /areas/{location}/{id}
EnterpriseDashboardDataApi.DefaultApiareasLocationPostPOST /areas/{location}
EnterpriseDashboardDataApi.DefaultApiareasLocationYearMonthUploadExcelSpreadsheetPostPOST /areas/{location}/{year}/{month}/upload-excel-spreadsheet
EnterpriseDashboardDataApi.DefaultApiareasLocationsGetGET /areas/locations
EnterpriseDashboardDataApi.DefaultApiareasNormalizedAreasGetGET /areas/normalized-areas
EnterpriseDashboardDataApi.DefaultApicommentsCountGetGET /comments/count
EnterpriseDashboardDataApi.DefaultApicommentsTileIdGetGET /comments/{tileId}
EnterpriseDashboardDataApi.DefaultApicommentsTileIdIdDeleteDELETE /comments/{tileId}/{id}
EnterpriseDashboardDataApi.DefaultApicommentsTileIdIdPutPUT /comments/{tileId}/{id}
EnterpriseDashboardDataApi.DefaultApicommentsTileIdPostPOST /comments/{tileId}
EnterpriseDashboardDataApi.DefaultApicompareGetGET /compare
EnterpriseDashboardDataApi.DefaultApidailyAreaReportExcelSpreadsheetLocationYearMonthGetGET /daily-area-report/excel-spreadsheet/{location}/{year}/{month}
EnterpriseDashboardDataApi.DefaultApidailyAreaReportLocationAreaYearMonthDayGetGET /daily-area-report/{location}/{area}/{year}/{month}/{day}
EnterpriseDashboardDataApi.DefaultApidailyAreaReportLocationAreaYearMonthDayPutPUT /daily-area-report/{location}/{area}/{year}/{month}/{day}
EnterpriseDashboardDataApi.DefaultApidailyAreaReportLocationYearMonthDayUploadExcelSpreadsheetPostPOST /daily-area-report/{location}/{year}/{month}/{day}/upload-excel-spreadsheet
EnterpriseDashboardDataApi.DefaultApidailyAreaReportSummaryLocationYearMonthDayGetGET /daily-area-report/summary/{location}/{year}/{month}/{day}
EnterpriseDashboardDataApi.DefaultApidataServicesLoadDataSourceNamePostPOST /data-services/load/{dataSourceName}
EnterpriseDashboardDataApi.DefaultApidataServicesTransformDataSourceNameYearMonthDayPostPOST /data-services/transform/{dataSourceName}/{year}/{month}/{day}
EnterpriseDashboardDataApi.DefaultApidataServicesTransformDataSourceNameYearMonthPostPOST /data-services/transform/{dataSourceName}/{year}/{month}
EnterpriseDashboardDataApi.DefaultApidataServicesTransformDataSourceNameYearPostPOST /data-services/transform/{dataSourceName}/{year}
EnterpriseDashboardDataApi.DefaultApihierarchyHierarchyGetGET /hierarchy/{hierarchy}
EnterpriseDashboardDataApi.DefaultApiinsightsTileIdGetGET /insights/{tileId}/
EnterpriseDashboardDataApi.DefaultApiinsightsTileIdPutPUT /insights/{tileId}/
EnterpriseDashboardDataApi.DefaultApikpiCategoriesGetGET /kpi-categories
EnterpriseDashboardDataApi.DefaultApikpiCategoriesTileIdGetGET /kpi-categories/{tileId}
EnterpriseDashboardDataApi.DefaultApikpiDataDataIdGetGET /kpi-data/{dataId}
EnterpriseDashboardDataApi.DefaultApikpiDefinitionsDataSourcesDataIdDeleteDELETE /kpi-definitions/data-sources/{dataId}
EnterpriseDashboardDataApi.DefaultApikpiDefinitionsDataSourcesDataIdGetGET /kpi-definitions/data-sources/{dataId}
EnterpriseDashboardDataApi.DefaultApikpiDefinitionsDataSourcesDataIdPutPUT /kpi-definitions/data-sources/{dataId}
EnterpriseDashboardDataApi.DefaultApikpiDefinitionsDataSourcesGetGET /kpi-definitions/data-sources
EnterpriseDashboardDataApi.DefaultApikpiDefinitionsTilesGetGET /kpi-definitions/tiles
EnterpriseDashboardDataApi.DefaultApikpiDefinitionsTilesTileIdDeleteDELETE /kpi-definitions/tiles/{tileId}
EnterpriseDashboardDataApi.DefaultApikpiDefinitionsTilesTileIdGetGET /kpi-definitions/tiles/{tileId}
EnterpriseDashboardDataApi.DefaultApikpiDefinitionsTilesTileIdPutPUT /kpi-definitions/tiles/{tileId}
EnterpriseDashboardDataApi.DefaultApikpiDetailGetGET /kpi-detail
EnterpriseDashboardDataApi.DefaultApimenusGetGET /menus
EnterpriseDashboardDataApi.DefaultApiseriousSafetyEventsLocationGetGET /serious-safety-events/{location}
EnterpriseDashboardDataApi.DefaultApiseriousSafetyEventsLocationPostPOST /serious-safety-events/{location}
EnterpriseDashboardDataApi.DefaultApiseriousSafetyEventsLocationSecondsSinceLastEventGetGET /serious-safety-events/{location}/seconds-since-last-event
EnterpriseDashboardDataApi.DefaultApisidebarsLocationYearMonthDayGetGET /sidebars/{location}/{year}/{month}/{day}
EnterpriseDashboardDataApi.DefaultApisidebarsLocationYearMonthDayPostPOST /sidebars/{location}/{year}/{month}/{day}
EnterpriseDashboardDataApi.DefaultApisidebarsSidebarIdDeleteDELETE /sidebars/{sidebarId}
EnterpriseDashboardDataApi.DefaultApisidebarsSidebarIdGetGET /sidebars/{sidebarId}
EnterpriseDashboardDataApi.DefaultApisidebarsSidebarIdPutPUT /sidebars/{sidebarId}
EnterpriseDashboardDataApi.DefaultApiusersAppDataTileIdGetGET /users/app-data/{tileId}
EnterpriseDashboardDataApi.DefaultApiusersAppDataTileIdPutPUT /users/app-data/{tileId}
EnterpriseDashboardDataApi.DefaultApiusersGetGET /users
EnterpriseDashboardDataApi.DefaultApiusersHiddenGetGET /users/hidden
EnterpriseDashboardDataApi.DefaultApiusersPutPUT /users
EnterpriseDashboardDataApi.DefaultApiusersTileIdWatchDeleteDELETE /users/{tileId}/watch
EnterpriseDashboardDataApi.DefaultApiusersTileIdWatchPutPUT /users/{tileId}/watch
EnterpriseDashboardDataApi.DefaultApiusersWatchGetGET /users/watch
EnterpriseDashboardDataApi.DefaultApiviewsCountGetGET /views/count
EnterpriseDashboardDataApi.DefaultApiviewsTileIdCountGetGET /views/{tileId}/count
EnterpriseDashboardDataApi.DefaultApiviewsTileIdPutPUT /views/{tileId}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.