Lean_ix_pathfinder_rest_api NPM

lean_ix_pathfinder_rest_api

LeanIxPathfinderRestApi - JavaScript client for lean_ix_pathfinder_rest_api Core application for storage and analysis of IT landscape data This SDK is automatically generated by the Swagger Codegen project:

API version: 4.0.31
Package version: 4.0.31
Build date: 2018-02-25T22:17:25.217+01:00
Build package: class 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 lean_ix_pathfinder_rest_api --save

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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var LeanIxPathfinderRestApi = require('lean_ix_pathfinder_rest_api');

var defaultClient = LeanIxPathfinderRestApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: token
var token = defaultClient.authentications['token'];
token.accessToken = "YOUR ACCESS TOKEN"

var api = new LeanIxPathfinderRestApi.AssetsApi()

var asset = "asset_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAsset(asset, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/services/pathfinder/v1

Class	Method	HTTP request	Description
LeanIxPathfinderRestApi.AssetsApi	deleteAsset	DELETE /assets/{asset}	deleteAsset
LeanIxPathfinderRestApi.AssetsApi	downloadAsset	GET /assets/{asset}	downloadAsset
LeanIxPathfinderRestApi.AssetsApi	upsertAsset	POST /assets/{asset}	upsertAsset
LeanIxPathfinderRestApi.BookmarksApi	createBookmark	POST /bookmarks	createBookmark
LeanIxPathfinderRestApi.BookmarksApi	deleteBookmark	DELETE /bookmarks/{id}	deleteBookmark
LeanIxPathfinderRestApi.BookmarksApi	getBookmark	GET /bookmarks/{id}	getBookmark
LeanIxPathfinderRestApi.BookmarksApi	getBookmarks	GET /bookmarks	getBookmarks
LeanIxPathfinderRestApi.BookmarksApi	updateBookmark	PUT /bookmarks/{id}	updateBookmark
LeanIxPathfinderRestApi.DocumentsApi	downloadDocument	GET /documents/{documentId}/download	downloadDocument
LeanIxPathfinderRestApi.ExportsApi	createExportFile	POST /exports/excel	createExportFile
LeanIxPathfinderRestApi.ExportsApi	createFullExport	POST /exports/fullExport	createFullExport
LeanIxPathfinderRestApi.ExportsApi	downloadExportFile	GET /exports/downloads/{workspaceId}	downloadExportFile
LeanIxPathfinderRestApi.ExportsApi	getExports	GET /exports	getExports
LeanIxPathfinderRestApi.FactSheetsApi	archiveFactSheet	DELETE /factSheets/{id}	deleteFactSheet
LeanIxPathfinderRestApi.FactSheetsApi	createFactSheet	POST /factSheets	createFactSheet
LeanIxPathfinderRestApi.FactSheetsApi	createFactSheetRelation	POST /factSheets/{id}/relations	createFactSheetRelation
LeanIxPathfinderRestApi.FactSheetsApi	deleteFactSheetRelation	DELETE /factSheets/{id}/relations/{relationId}	deleteFactSheetRelation
LeanIxPathfinderRestApi.FactSheetsApi	getFactSheet	GET /factSheets/{id}	getFactSheet
LeanIxPathfinderRestApi.FactSheetsApi	getFactSheetRelations	GET /factSheets/{id}/relations	getFactSheetRelations
LeanIxPathfinderRestApi.FactSheetsApi	getFactSheets	GET /factSheets	getFactSheets
LeanIxPathfinderRestApi.FactSheetsApi	updateFactSheet	PUT /factSheets/{id}	updateFactSheet
LeanIxPathfinderRestApi.FactSheetsApi	updateFactSheetRelation	PUT /factSheets/{id}/relations/{relationId}	updateFactSheetRelation
LeanIxPathfinderRestApi.FeaturesApi	getFeatures	GET /features	getFeatures
LeanIxPathfinderRestApi.GraphqlApi	processGraphQL	POST /graphql	processGraphQL
LeanIxPathfinderRestApi.GraphqlApi	processGraphQLMultipart	POST /graphql/upload	processGraphQLMultipart
LeanIxPathfinderRestApi.ModelsApi	getAuthorization	GET /models/authorization	getAuthorization
LeanIxPathfinderRestApi.ModelsApi	getDataModel	GET /models/dataModel	getDataModel
LeanIxPathfinderRestApi.ModelsApi	getEnrichedDataModel	GET /models/dataModel/enriched	getEnrichedDataModel
LeanIxPathfinderRestApi.ModelsApi	getLanguage	GET /models/languages/{id}	getLanguage
LeanIxPathfinderRestApi.ModelsApi	getReportingModel	GET /models/reportingModel	getReportingModel
LeanIxPathfinderRestApi.ModelsApi	getViewModel	GET /models/viewModel	getViewModel
LeanIxPathfinderRestApi.ModelsApi	updateAuthorization	PUT /models/authorization	updateAuthorization
LeanIxPathfinderRestApi.ModelsApi	updateDataModel	PUT /models/dataModel	updateDataModel
LeanIxPathfinderRestApi.ModelsApi	updateLanguage	PUT /models/languages/{id}	updateLanguage
LeanIxPathfinderRestApi.ModelsApi	updateReportingModel	PUT /models/reportingModel	updateReportingModel
LeanIxPathfinderRestApi.ModelsApi	updateViewModel	PUT /models/viewModel	updateViewModel
LeanIxPathfinderRestApi.TodosApi	createTodo	POST /todos	createTodo
LeanIxPathfinderRestApi.TodosApi	deleteTodo	DELETE /todos/{id}	deleteTodo
LeanIxPathfinderRestApi.TodosApi	getTodo	GET /todos/{id}	getTodo
LeanIxPathfinderRestApi.TodosApi	getTodos	GET /todos	getTodos
LeanIxPathfinderRestApi.TodosApi	updateTodo	PUT /todos/{id}	updateTodo

Documentation for Models

Documentation for Authorization

token

Type: OAuth
Flow: implicit
Authorization URL: depends
Scopes: N/A

superagent

@infinitebrahmanuniverse/nolb-lean @everything-registry/sub-chunk-2054 @zalastax/nolb-lean

4.0.31

6 years ago