Infinite_blue_platform_rest_v20 NPM

infinite_blue_platform_rest_v20

InfiniteBluePlatformRestV20 - JavaScript client for infinite_blue_platform_rest_v20 Rest v2.0 APIs This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0
Package version: 1.0
Build package: io.swagger.codegen.v3.generators.javascript.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 infinite_blue_platform_rest_v20 --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.

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 InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

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

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = new InfiniteBluePlatformRestV20.Body6(); // {Body6} Authentication Proifle Record

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAuthenticationProfile(body, callback);

Documentation for API Endpoints

All URIs are relative to /prod1/api2/

Class	Method	HTTP request	Description
InfiniteBluePlatformRestV20.AdminApi	createAuthenticationProfile	POST /admin/authenticationprofiles	Creates an Authentication Profile
InfiniteBluePlatformRestV20.AdminApi	deleteAuthenticationProfile	DELETE /admin/authenticationprofiles/{authenticationProfileId}	Delete an authentication profile with given id
InfiniteBluePlatformRestV20.AdminApi	getApplicationPermissions	GET /admin/applications/{appIntegrationName}/permissions	Retrieves application's access permission.
InfiniteBluePlatformRestV20.AdminApi	getAuthenticationProfileById	GET /admin/authenticationprofiles/{authenticationProfileId}	Return settings of an authentication profile based on the given authentication profile ID for viewing.
InfiniteBluePlatformRestV20.AdminApi	getAuthenticationProfiles	GET /admin/authenticationprofiles	Return all authentication profiles list with each profile settings for viewing
InfiniteBluePlatformRestV20.AdminApi	getFieldPermissions	GET /admin/objects/{objIntegrationName}/fields/{fieldIntegrationName}/permissions	Retrieves field's access permissions.
InfiniteBluePlatformRestV20.AdminApi	getObjectPermissions	GET /admin/objects/{objIntegrationName}/permissions/	Retrieves object's access permissions.
InfiniteBluePlatformRestV20.AdminApi	getViewPermissions	GET /admin/objects/{objIntegrationName}/views/{viewIntegrationName}/permissions	Retrieves the view's access permission.
InfiniteBluePlatformRestV20.AdminApi	updateApplicationPermissions	PUT /admin/applications/{appIntegrationName}/permissions	Updates application's access permission.
InfiniteBluePlatformRestV20.AdminApi	updateAuhenticationProfileById	PUT /admin/authenticationprofiles/{authenticationProfileId}	Update an authentication profile by authentication profile ID
InfiniteBluePlatformRestV20.AdminApi	updateFieldPermissions	PUT /admin/objects/{objIntegrationName}/fields/{fieldIntegrationName}/permissions	Updates the field's access permissions.
InfiniteBluePlatformRestV20.AdminApi	updateObjectPermissions	PUT /admin/objects/{objIntegrationName}/permissions/	Updates the object's access permissions.
InfiniteBluePlatformRestV20.AdminApi	updateViewPermissions	PUT /admin/objects/{objIntegrationName}/views/{viewIntegrationName}/permissions	Updates view's access permission.
InfiniteBluePlatformRestV20.CustomMethodApi	doDeleteOnCustomMethod	DELETE /custom/{customMethodName}	DELETE operation on business method
InfiniteBluePlatformRestV20.CustomMethodApi	doGetOnCustomMethod	GET /custom/{customMethodName}	GET operation on business method
InfiniteBluePlatformRestV20.CustomMethodApi	doPostOnCustomMethod	POST /custom/{customMethodName}	POST operation on business method
InfiniteBluePlatformRestV20.CustomMethodApi	doPutOnCustomMethod	PUT /custom/{customMethodName}	PUT operation on business method
InfiniteBluePlatformRestV20.CustomersApi	createCustomerRecord	POST /data/customers	Creates customer record.
InfiniteBluePlatformRestV20.CustomersApi	deleteCustomerRecord	DELETE /data/customers/{recordId}	Delete customer record.
InfiniteBluePlatformRestV20.CustomersApi	getCustomerRecordById	GET /data/customers/{recordId}	Get customer record with matching record ID.
InfiniteBluePlatformRestV20.CustomersApi	getCustomerRecords	GET /data/customers	Get customer records.
InfiniteBluePlatformRestV20.CustomersApi	getCustomerRecordsCount	GET /data/customers/count	Retrieves the total number of customer records in a view.
InfiniteBluePlatformRestV20.CustomersApi	updateCustomerRecord	PUT /data/customers/{recordId}	Updates an existing customer record.
InfiniteBluePlatformRestV20.MetaApi	getApplicationByName	GET /meta/applications/{appIntegrationName}	Retrieves the full description of the application for a given application integration name.
InfiniteBluePlatformRestV20.MetaApi	getApplications	GET /meta/applications	Retrieves the full description of all the applications.
InfiniteBluePlatformRestV20.MetaApi	getBatchJobByName	GET /meta/batchJobs/{batchJobIntegrationName}	Retrieves the full description the batch job for the given integration name.
InfiniteBluePlatformRestV20.MetaApi	getBatchJobs	GET /meta/batchJobs	Retrieves the full description of all batch jobs.
InfiniteBluePlatformRestV20.MetaApi	getDataObjectByName	GET /meta/objects/{objectIntegrationName}	Retrieves the full description of all objects for the given object integration name.
InfiniteBluePlatformRestV20.MetaApi	getDataObjects	GET /meta/objects	Retrieves the full description of all objects.
InfiniteBluePlatformRestV20.MetaApi	getFieldByName	GET /meta/objects/{objectIntegrationName}/fields/{fieldIntegrationName}	Retrieves the full description of a field definition.
InfiniteBluePlatformRestV20.MetaApi	getFields	GET /meta/objects/{objectIntegrationName}/fields	Retrieves the full description of all the fields in a given object definition.
InfiniteBluePlatformRestV20.MetaApi	getPortalByName	GET /meta/portals/{portalIntegrationName}	Retrieves the full description of the portals for a given portal integration name.
InfiniteBluePlatformRestV20.MetaApi	getPortals	GET /meta/portals	Retrieves the full description of all the portals.
InfiniteBluePlatformRestV20.MetaApi	getRelationshipByName	GET /meta/objects/{objectIntegrationName}/relationships/{relIntegrationName}	Retrieves the full description of a relationship definition.
InfiniteBluePlatformRestV20.MetaApi	getRelationships	GET /meta/objects/{objectIntegrationName}/relationships	Retrieves the full description of all relationships for the given object integration name.
InfiniteBluePlatformRestV20.MetaApi	getRoleByName	GET /meta/roles/{roleIntegrationName}	Retrieves the full description of the role for a given integration name.
InfiniteBluePlatformRestV20.MetaApi	getRoles	GET /meta/roles/	Retrieves the full description of all the roles for a given object definition.
InfiniteBluePlatformRestV20.MetaApi	getTriggerByName	GET /meta/objects/{objectIntegrationName}/triggers/{triggerIntegrationName}	Retrieves the full description of the trigger.
InfiniteBluePlatformRestV20.MetaApi	getTriggers	GET /meta/objects/{objectIntegrationName}/triggers	Retrieves the full description of all triggers for a given object definition.
InfiniteBluePlatformRestV20.MetaApi	getViewByName	GET /meta/objects/{objectIntegrationName}/views/{viewIntegrationName}	Retrieves the full description of a view definition.
InfiniteBluePlatformRestV20.MetaApi	getViews	GET /meta/objects/{objectIntegrationName}/views	Retrieves the full description of all the views in a given object.
InfiniteBluePlatformRestV20.RecordApi	createDataRecord	POST /data/{objectIntegrationName}	Creates a new record.
InfiniteBluePlatformRestV20.RecordApi	deleteDataRecord	DELETE /data/{objectIntegrationName}/{recordId}	Moves an object record to recycle bin.
InfiniteBluePlatformRestV20.RecordApi	getDataField	GET /data/{objectIntegrationName}/{recordId}/fields/{fieldIntegrationName}	Retrieves the value of a single field from a specific record.
InfiniteBluePlatformRestV20.RecordApi	getDataRecords	GET /data/{objectIntegrationName}	Retrieves all records of the object.
InfiniteBluePlatformRestV20.RecordApi	getRecordById	GET /data/{objectIntegrationName}/{recordId}	Retrieves all field data for a given record.
InfiniteBluePlatformRestV20.RecordApi	getRecordsCount	GET /data/{objectIntegrationName}/count	Retrieves the total number of records in a view.
InfiniteBluePlatformRestV20.RecordApi	updateDataField	POST /data/{objectIntegrationName}/{recordId}/fields/{fieldIntegrationName}	Sets the value of a single field for a specific record.
InfiniteBluePlatformRestV20.RecordApi	updateDataRecord	PUT /data/{objectIntegrationName}/{recordId}	Updates an existing record.
InfiniteBluePlatformRestV20.UserResourceApi	loginUser	POST /user/login	Logs user into the system
InfiniteBluePlatformRestV20.UserResourceApi	logoutUser	GET /user/logout	Logs out current logged in user session
InfiniteBluePlatformRestV20.UsersApi	createUserRecord	POST /data/users	Creates a user record
InfiniteBluePlatformRestV20.UsersApi	deleteUserRecord	DELETE /data/users/{loginNameOrRecordId}	Deletes a user record.
InfiniteBluePlatformRestV20.UsersApi	getLDFIDs	GET /data/users/{loginNameOrRecordId}/ldfInfo	Get LDF IDs corresponding to each of the dimensions - $ORG_LOCN, $ORG_DEPT and $ORG_FUNC
InfiniteBluePlatformRestV20.UsersApi	getUserRecord	GET /data/users/{loginNameOrRecordId}	Get user record given loginName or user ID.
InfiniteBluePlatformRestV20.UsersApi	getUserRecords	GET /data/users	Get user records.
InfiniteBluePlatformRestV20.UsersApi	getUserRecordsCount	GET /data/users/count	Retrieves the total number of User records in a view.
InfiniteBluePlatformRestV20.UsersApi	updateUserRecord	PUT /data/users/{loginNameOrRecordId}	Updates an existing user record.

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: JWT
Location: HTTP header

basic_auth

Type: HTTP basic authentication

babel babel-cli superagent

@infinitebrahmanuniverse/nolb-infi @everything-registry/sub-chunk-1912 @zalastax/nolb-infi

1.0.0

4 years ago