Skip to content

cloudfabrix/api-sdk-javascript

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
docs
docs
 
 
src
src
 
 
test
test
 
 
README.md
README.md
 
 
git_push.sh
git_push.sh
 
 
mocha.opts
mocha.opts
 
 
package.json
package.json
 
 

Repository files navigation

cloud_fabrix_rda_platform_api

CloudFabrixRdaPlatformApi - JavaScript client for cloud_fabrix_rda_platform_api CloudFabrix RDA Platform API This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 4.0
  • Package version: 4.0
  • Generator version: 7.11.0
  • Build package: org.openapitools.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 cloud_fabrix_rda_platform_api --save

Finally, you need to build the module:

npm run build
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

To use the link you just defined in your project, switch to the directory you want to use your cloud_fabrix_rda_platform_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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.

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 CloudFabrixRdaPlatformApi = require('cloud_fabrix_rda_platform_api');

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

var api = new CloudFabrixRdaPlatformApi.AuditReportApi()
var opts = {
  'cfxqlQuery': "cfxqlQuery_example", // {String} <a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results
  'sort': ["null"], // {[String]} Sort the output based on given fields. Prepend '-' to sort descending
  'offset': 56, // {Number} Offset to start the results from.
  'limit': 56 // {Number} Maximum number of results to return
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuditReport(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
CloudFabrixRdaPlatformApi.AuditReportApi getAuditReport GET /api/v2/audit Get details of audit report
CloudFabrixRdaPlatformApi.AuthenticationApi login POST /api/v2/login Login into api server. (Run this first)
CloudFabrixRdaPlatformApi.BlueprintsApi addABlueprint POST /api/v2/blueprints Add a blueprint
CloudFabrixRdaPlatformApi.BlueprintsApi changeBlueprintStatus PUT /api/v2/blueprints/blueprint/{id}/status Enable/Disable an existing blueprint
CloudFabrixRdaPlatformApi.BlueprintsApi deleteBlueprint DELETE /api/v2/blueprints/blueprint/{id} Delete a blueprint
CloudFabrixRdaPlatformApi.BlueprintsApi editBlueprint PUT /api/v2/blueprints/blueprint/{id} Edit a blueprint. Note: If the Blueprint does not exist, it will be added to the system.
CloudFabrixRdaPlatformApi.BlueprintsApi getAduitReport GET /api/v2/blueprints/blueprint/{name}/{id}/audit/ Get blueprint audit report
CloudFabrixRdaPlatformApi.BlueprintsApi getArtifactReport GET /api/v2/blueprints/blueprint/{id}/artifacts/ Get blueprint artifact dependencies report
CloudFabrixRdaPlatformApi.BlueprintsApi getBlueprint GET /api/v2/blueprints/blueprint/{id} Get a blueprint
CloudFabrixRdaPlatformApi.BlueprintsApi getBlueprints GET /api/v2/blueprints Fetch meta data about blueprints
CloudFabrixRdaPlatformApi.CredentialsApi addCredential POST /api/v2/credentials Add a credential
CloudFabrixRdaPlatformApi.CredentialsApi checkConnectivity POST /api/v2/credentials/credential/{name}/verify Verify connectivity and credential validity
CloudFabrixRdaPlatformApi.CredentialsApi deleteCredential DELETE /api/v2/credentials/credential/{name} Delete a credential
CloudFabrixRdaPlatformApi.CredentialsApi editCredential PUT /api/v2/credentials/credential/{name} Edit a credential. Note: If the Credential does not exist, it will be added to the system.
CloudFabrixRdaPlatformApi.CredentialsApi getCredential GET /api/v2/credentials/credential/{name} Get a credential
CloudFabrixRdaPlatformApi.CredentialsApi getCredentialTypeFields GET /api/v2/credentials/types/{type} Get fields of a credential type
CloudFabrixRdaPlatformApi.CredentialsApi getCredentialTypes GET /api/v2/credentials/types Get all credential types
CloudFabrixRdaPlatformApi.CredentialsApi getSecrets GET /api/v2/credentials Fetch meta data about credentials
CloudFabrixRdaPlatformApi.DashboardGroupsApi addDashboardGroup POST /api/v2/dashboard_groups Add dashboard group
CloudFabrixRdaPlatformApi.DashboardGroupsApi deleteDashboardGroup DELETE /api/v2/dashboard_groups/dashboard_group/{name} Delete dashboard group
CloudFabrixRdaPlatformApi.DashboardGroupsApi editDashboardGroup PUT /api/v2/dashboard_groups/dashboard_group/{name} Edit dashboard group. Note: If the Dashboard Group does not exist, it will be added to the system.
CloudFabrixRdaPlatformApi.DashboardGroupsApi getDashboardGroups GET /api/v2/dashboard_groups Get all dashboard groups
CloudFabrixRdaPlatformApi.DashboardGroupsApi statusDashboardGroup PUT /api/v2/dashboard_groups/dashboard_group/{name}/status Activate/Deactivate a dashboard group
CloudFabrixRdaPlatformApi.DashboardsApi addDashboard POST /api/v2/dashboards Add a dashboard
CloudFabrixRdaPlatformApi.DashboardsApi deleteDashboard DELETE /api/v2/dashboards/dashboard/{dashboard_id} Delete a dashboard
CloudFabrixRdaPlatformApi.DashboardsApi editDashboard PUT /api/v2/dashboards/dashboard/{dashboard_id} Update a dashboard. Note: If the dashboard does not exist, it will be added to the system.
CloudFabrixRdaPlatformApi.DashboardsApi getDashboards GET /api/v2/dashboards Fetch meta data for dashboards
CloudFabrixRdaPlatformApi.DatasetsApi addDataset POST /api/v2/datasets Add a dataset
CloudFabrixRdaPlatformApi.DatasetsApi deleteDataset DELETE /api/v2/datasets/dataset/{name} Delete a dataset
CloudFabrixRdaPlatformApi.DatasetsApi deleteDatasetAllData DELETE /api/v2/datasets/dataset/{name}/data/all Delete enitre data of a dataset
CloudFabrixRdaPlatformApi.DatasetsApi deleteDatasetRows DELETE /api/v2/datasets/dataset/{name}/data Delete matching dataset rows
CloudFabrixRdaPlatformApi.DatasetsApi getDatasetData GET /api/v2/datasets/dataset/{name}/data Get data of a dataset
CloudFabrixRdaPlatformApi.DatasetsApi getDatasets GET /api/v2/datasets Fetch meta data about datasets
CloudFabrixRdaPlatformApi.DatasetsApi updateDatasetData PUT /api/v2/datasets/dataset/{name}/data Update rows of a dataset
CloudFabrixRdaPlatformApi.FabricHealthApi getAgents GET /api/v2/farbic_health/agents/rda_agents Get details of RDA Agents
CloudFabrixRdaPlatformApi.FabricHealthApi getAppMicroservices GET /api/v2/farbic_health/microservices/app Get details of micro services belonging to Applications (e.g. OIA)
CloudFabrixRdaPlatformApi.FabricHealthApi getCoreMicroservices GET /api/v2/farbic_health/microservices/core Get details of microservices that belong to core RDAF platform
CloudFabrixRdaPlatformApi.FabricHealthApi getEventGwEndpoint GET /api/v2/farbic_health/agents/event_gateways/endpoints Get event gateway endpoint details
CloudFabrixRdaPlatformApi.FabricHealthApi getFabricUsage GET /api/v2/farbic_health/usage Get fabric usage
CloudFabrixRdaPlatformApi.FabricHealthApi getWorkers GET /api/v2/farbic_health/workers Get details of worker pods running on the system
CloudFabrixRdaPlatformApi.IconLibraryApi bulkImportIconsApiV2IconsBulkUploadPost POST /api/v2/icons/bulk_upload Bulk Import Icons
CloudFabrixRdaPlatformApi.IconLibraryApi deleteIconApiV2IconsIconNameIdDelete DELETE /api/v2/icons/icon/{name}/{id} Delete Icon
CloudFabrixRdaPlatformApi.IconLibraryApi getIconReport GET /api/v2/icons Get details of icons in the library
CloudFabrixRdaPlatformApi.IconLibraryApi uploadIconFileApiV2IconsUploadNamePost POST /api/v2/icons/upload/{name} Upload an image file to Icon Library
CloudFabrixRdaPlatformApi.JobsApi getJobTraces GET /api/v2/jobs/job/{job_id}/traces Get traces of the jobs
CloudFabrixRdaPlatformApi.JobsApi getJobs GET /api/v2/jobs Get jobs deatils
CloudFabrixRdaPlatformApi.OrganizationsApi addOrganization POST /api/v2/organizations Add Organization
CloudFabrixRdaPlatformApi.OrganizationsApi deleteOrganization DELETE /api/v2/organizations/organization/{id} Delete Organizations.
CloudFabrixRdaPlatformApi.OrganizationsApi editOrganization PUT /api/v2/organizations/organization/{id} Edit Organization
CloudFabrixRdaPlatformApi.OrganizationsApi getOrganizations GET /api/v2/organizations Get Organizations
CloudFabrixRdaPlatformApi.PersistentStreamsApi addPstream POST /api/v2/pstreams Add a pstream
CloudFabrixRdaPlatformApi.PersistentStreamsApi deletePstream DELETE /api/v2/pstreams/pstream/{name} Delete a pstream.
CloudFabrixRdaPlatformApi.PersistentStreamsApi deletePstreamData DELETE /api/v2/pstreams/pstream/{name}/data Delete specific data from a pstream
CloudFabrixRdaPlatformApi.PersistentStreamsApi editPstream PUT /api/v2/pstreams/pstream/{name} Edit attributes of a pstream
CloudFabrixRdaPlatformApi.PersistentStreamsApi getPstreamData GET /api/v2/pstreams/pstream/{name}/data Get data of a pstream
CloudFabrixRdaPlatformApi.PersistentStreamsApi getPstreamMetadata GET /api/v2/pstreams/pstream/{name}/metadata Get metadata of a pstream
CloudFabrixRdaPlatformApi.PersistentStreamsApi getPstreamStats GET /api/v2/pstreams/pstream/{name}/stats Get stats of a pstream
CloudFabrixRdaPlatformApi.PersistentStreamsApi getPstreams GET /api/v2/pstreams Fetch meta data about pstreams
CloudFabrixRdaPlatformApi.PersistentStreamsApi publishToPstream POST /api/v2/pstreams/pstream/{name}/data Add data to an existing pstream
CloudFabrixRdaPlatformApi.PersistentStreamsApi updatePstreamData PUT /api/v2/pstreams/pstream/{name}/data Update data in a pstream by query
CloudFabrixRdaPlatformApi.PipelinesApi addDraftPipeline POST /api/v2/pipelines/draft Add a draft pipeline
CloudFabrixRdaPlatformApi.PipelinesApi addPublishedPipeline POST /api/v2/pipelines Add a published pipeline
CloudFabrixRdaPlatformApi.PipelinesApi deleteAllVersionsDraftPipeline DELETE /api/v2/pipelines/draft/{name} Delete all versions of a draft pipeline
CloudFabrixRdaPlatformApi.PipelinesApi deleteAllVersionsPublishedPipeline DELETE /api/v2/pipelines/pipeline/{name} Delete all versions of a published pipeline
CloudFabrixRdaPlatformApi.PipelinesApi deleteDraftPipeline DELETE /api/v2/pipelines/draft/{name}/version/{version} Delete a draft pipeline version
CloudFabrixRdaPlatformApi.PipelinesApi deletePublishedPipeline DELETE /api/v2/pipelines/pipeline/{name}/version/{version} Delete a published pipeline version
CloudFabrixRdaPlatformApi.PipelinesApi editDraftPipeline PUT /api/v2/pipelines/draft/{name} Edit a draft pipeline. Note: If the Pipeline does not exist, it will be added to the system.
CloudFabrixRdaPlatformApi.PipelinesApi editPublishedPipeline PUT /api/v2/pipelines/pipeline/{name} Edit a published pipeline. Note: If the Pipeline does not exist, it will be added to the system.
CloudFabrixRdaPlatformApi.PipelinesApi getDraftPipeline GET /api/v2/pipelines/draft/{name}/version/{version} Get a draft pipeline version
CloudFabrixRdaPlatformApi.PipelinesApi getDraftPipelineVersions GET /api/v2/pipelines/draft/{name}/versions Get all versions of a draft pipeline
CloudFabrixRdaPlatformApi.PipelinesApi getDraftPipelines GET /api/v2/pipelines/draft Fetch meta data about draft pipelines
CloudFabrixRdaPlatformApi.PipelinesApi getPipelineLogs GET /api/v2/pipelines/{name}/logs Get logs of a pipeline
CloudFabrixRdaPlatformApi.PipelinesApi getPipelineTraces GET /api/v2/pipelines/{name}/traces Get traces of a pipeline
CloudFabrixRdaPlatformApi.PipelinesApi getPipelineVersionLogs GET /api/v2/pipelines/{name}/version/{version}/logs Get logs for a pipeline version
CloudFabrixRdaPlatformApi.PipelinesApi getPipelineVersionTraces GET /api/v2/pipelines/{name}/version/{version}/traces Get traces for a pipeline version
CloudFabrixRdaPlatformApi.PipelinesApi getPipelines GET /api/v2/pipelines Fetch meta data about pipelines
CloudFabrixRdaPlatformApi.PipelinesApi getPipelinesLogs GET /api/v2/pipelines/logs Fetch logs for pipelines
CloudFabrixRdaPlatformApi.PipelinesApi getPipelinesTraces GET /api/v2/pipelines/traces Fetch traces for pipelines
CloudFabrixRdaPlatformApi.PipelinesApi getPublishedPipeline GET /api/v2/pipelines/pipeline/{name}/version/{version} Get a published pipeline version
CloudFabrixRdaPlatformApi.PipelinesApi getPublishedPipelineVersions GET /api/v2/pipelines/pipeline/{name}/versions Get all versions of a published pipeline
CloudFabrixRdaPlatformApi.PipelinesApi publishDraftPipeline POST /api/v2/pipelines/draft/{name}/version/{version}/publish Publish a draft pipeline
CloudFabrixRdaPlatformApi.PipelinesApi runDraftPipeline POST /api/v2/pipelines/draft/{name}/version/{version}/run Run a Draft Pipeline
CloudFabrixRdaPlatformApi.PipelinesApi runPipeline POST /api/v2/pipelines/pipeline/{name}/version/{version}/run Run a Published Pipeline
CloudFabrixRdaPlatformApi.RdaPacksApi deleteRdaPack DELETE /api/v2/rda_packs/rda_pack/{name}/{version}/delete Delete an RDA pack with specified name and version
CloudFabrixRdaPlatformApi.RdaPacksApi getPacks GET /api/v2/rda_packs Fetch meta data about packs
CloudFabrixRdaPlatformApi.RdaPacksApi statusRdaPack PUT /api/v2/rda_packs/rda_pack/{name}/{version}/status Activate/Deactivate an RDA pack with specified name and version
CloudFabrixRdaPlatformApi.RdaPacksApi uploadRdaPackApiV2RdaPacksRdaPackUploadPost POST /api/v2/rda_packs/rda_pack/upload Upload a RDA pack
CloudFabrixRdaPlatformApi.TextFsmTemplateApi addTextfsm POST /api/v2/textfsms Add a textfsm template
CloudFabrixRdaPlatformApi.TextFsmTemplateApi deleteTextfsm DELETE /api/v2/textfsms/textfsm/{name} Delete a textfsm template
CloudFabrixRdaPlatformApi.TextFsmTemplateApi getTextfsm GET /api/v2/textfsms Fetch meta data about TextFsm
CloudFabrixRdaPlatformApi.TextFsmTemplateApi getTextfsmTemplateData GET /api/v2/textfsms/textfsm/{name}/view View textfsm template
CloudFabrixRdaPlatformApi.TextFsmTemplateApi updateTextfsm PUT /api/v2/textfsms/textfsm/{name} Update a TextFsm template
CloudFabrixRdaPlatformApi.TextFsmTemplateApi validateTextfsmTemplate POST /api/v2/textfsms/validate_template validate a textfsm template
CloudFabrixRdaPlatformApi.UserGroupsApi addUserGroup POST /api/v2/user_groups Add user group
CloudFabrixRdaPlatformApi.UserGroupsApi deleteUserGroup DELETE /api/v2/user_groups/user_group/{name} Delete user group
CloudFabrixRdaPlatformApi.UserGroupsApi editUserGroup PUT /api/v2/user_groups/user_group/{name} Edit user group
CloudFabrixRdaPlatformApi.UserGroupsApi getUserGroups GET /api/v2/user_groups Get all user groups
CloudFabrixRdaPlatformApi.UsersApi addTenantUser POST /api/v2/users Add user
CloudFabrixRdaPlatformApi.UsersApi changeUserGroup PUT /api/v2/users/user/{id}/group Change User group
CloudFabrixRdaPlatformApi.UsersApi changeUserStatus PUT /api/v2/users/user/{id}/status Change User Activation Status
CloudFabrixRdaPlatformApi.UsersApi deleteUser DELETE /api/v2/users/user/{id} Delete User
CloudFabrixRdaPlatformApi.UsersApi getCurrentUser GET /api/v2/current_user Get current logged in user details
CloudFabrixRdaPlatformApi.UsersApi getTenantUsers GET /api/v2/users Get all users
CloudFabrixRdaPlatformApi.UsersApi resetPassword POST /api/v2/users/resetpassword Reset Password will be enabled when user logged in with default password only

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

APIKeyHeader

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

About

RDAF Rest API SDK in Javascript

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages