Skip to content

harvardinformatics/p3.client

Repository files navigation

portal_api

PortalApi - JavaScript client for portal_api RC Portal This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: v1
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install portal_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 portal_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('portal_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/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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 PortalApi = require('portal_api');

var defaultClient = PortalApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new PortalApi.AppTagsApi()

var data = new PortalApi.AppTag(); // {AppTag} 

api.appTagsCreate(data).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:8091/p3/api

Class Method HTTP request Description
PortalApi.AppTagsApi appTagsCreate POST /app-tags/
PortalApi.AppTagsApi appTagsDelete DELETE /app-tags/{id}/
PortalApi.AppTagsApi appTagsList GET /app-tags/
PortalApi.AppTagsApi appTagsPartialUpdate PATCH /app-tags/{id}/
PortalApi.AppTagsApi appTagsRead GET /app-tags/{id}/
PortalApi.AppTagsApi appTagsUpdate PUT /app-tags/{id}/
PortalApi.AppsApi appsCreate POST /apps/
PortalApi.AppsApi appsDelete DELETE /apps/{id}/
PortalApi.AppsApi appsList GET /apps/
PortalApi.AppsApi appsPartialUpdate PATCH /apps/{id}/
PortalApi.AppsApi appsRead GET /apps/{id}/
PortalApi.AppsApi appsUpdate PUT /apps/{id}/
PortalApi.BuildStacksApi buildStacksCreate POST /build-stacks/
PortalApi.BuildStacksApi buildStacksDelete DELETE /build-stacks/{id}/
PortalApi.BuildStacksApi buildStacksList GET /build-stacks/
PortalApi.BuildStacksApi buildStacksPartialUpdate PATCH /build-stacks/{id}/
PortalApi.BuildStacksApi buildStacksRead GET /build-stacks/{id}/
PortalApi.BuildStacksApi buildStacksUpdate PUT /build-stacks/{id}/
PortalApi.BuildsApi buildsCreate POST /builds/
PortalApi.BuildsApi buildsDelete DELETE /builds/{id}/
PortalApi.BuildsApi buildsList GET /builds/
PortalApi.BuildsApi buildsPartialUpdate PATCH /builds/{id}/
PortalApi.BuildsApi buildsRead GET /builds/{id}/
PortalApi.BuildsApi buildsUpdate PUT /builds/{id}/
PortalApi.GetBasicsByLoginApi getBasicsByLoginList GET /get-basics-by-login/
PortalApi.GetBuildListApi getBuildListList GET /get-build-list/
PortalApi.GetBuildReportsApi getBuildReportsList GET /get-build-reports/
PortalApi.GetOrgNamesApi getOrgNamesList GET /get-org-names/
PortalApi.GetPiNamesApi getPiNamesList GET /get-pi-names/
PortalApi.GetUserListApi getUserListList GET /get-user-list/
PortalApi.OfficeHoursSignInsApi officeHoursSignInsCreate POST /office-hours-sign-ins/
PortalApi.OfficeHoursSignInsApi officeHoursSignInsDelete DELETE /office-hours-sign-ins/{id}/
PortalApi.OfficeHoursSignInsApi officeHoursSignInsList GET /office-hours-sign-ins/
PortalApi.OfficeHoursSignInsApi officeHoursSignInsPartialUpdate PATCH /office-hours-sign-ins/{id}/
PortalApi.OfficeHoursSignInsApi officeHoursSignInsRead GET /office-hours-sign-ins/{id}/
PortalApi.OfficeHoursSignInsApi officeHoursSignInsUpdate PUT /office-hours-sign-ins/{id}/

Documentation for Models

Documentation for Authorization

token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Releases

No releases published

Packages

No packages published

Languages