AppsApi.md

FnJs.AppsApi

All URIs are relative to https://127.0.0.1:8080/v2

Method	HTTP request	Description
createApp	POST /apps	Create A New Application
deleteApp	DELETE /apps/{appID}	Delete An Application
getApp	GET /apps/{appID}	Get Information For An Application
listApps	GET /apps	Get A List Of Applications
updateApp	PUT /apps/{appID}	Update an Application

createApp

App createApp(body)

Create A New Application

Creates a new Application, returning the complete entity.

Example

var FnJs = require('fn_js');

var apiInstance = new FnJs.AppsApi();

var body = new FnJs.App(); // App | Application data to insert.


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

Parameters

Name	Type	Description	Notes
body	App	Application data to insert.

Return type

App

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteApp

deleteApp(appID)

Delete An Application

Delete the specified Application.

Example

var FnJs = require('fn_js');

var apiInstance = new FnJs.AppsApi();

var appID = "appID_example"; // String | Opaque, unique Application ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteApp(appID, callback);

Parameters

Name	Type	Description	Notes
appID	String	Opaque, unique Application ID.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

getApp

App getApp(appID)

Get Information For An Application

Returns more details about an Application, such as statistics.

Example

var FnJs = require('fn_js');

var apiInstance = new FnJs.AppsApi();

var appID = "appID_example"; // String | Opaque, unique Application ID.


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

Parameters

Name	Type	Description	Notes
appID	String	Opaque, unique Application ID.

Return type

App

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

listApps

AppList listApps(opts)

Get A List Of Applications

Get a filtered list of Applications in alphabetical order.

Example

var FnJs = require('fn_js');

var apiInstance = new FnJs.AppsApi();

var opts = { 
  'cursor': "cursor_example", // String | Cursor from previous response.next_cursor to begin results after, if any.
  'perPage': 56, // Number | Number of results to return, defaults to 30. Max of 100.
  'name': "name_example" // String | The Application name to filter by.
};

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

Parameters

Name	Type	Description	Notes
cursor	String	Cursor from previous response.next_cursor to begin results after, if any.	[optional]
perPage	Number	Number of results to return, defaults to 30. Max of 100.	[optional]
name	String	The Application name to filter by.	[optional]

Return type

AppList

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateApp

App updateApp(appIDbody)

Update an Application

Updates an Application via merging the provided values.

Example

var FnJs = require('fn_js');

var apiInstance = new FnJs.AppsApi();

var appID = "appID_example"; // String | Opaque, unique Application ID.

var body = new FnJs.App(); // App | Application data to merge with current values.


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

Parameters

Name	Type	Description	Notes
appID	String	Opaque, unique Application ID.
body	App	Application data to merge with current values.

Return type

App

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json