@datafire/wealthport

Client library for Wealthport API

Installation and Usage

npm install --save @datafire/wealthport

let wealthport = require('@datafire/wealthport').create({
  "Using HTTP Header": "",
  "Using URL Query Parameter": ""
});

.then(data => {
  console.log(data);
});

Description

Onedot provides a simple, lightweight and open Web API based on the Open API 2.0 standard (https://www.openapis.org). Our APIs offer a variety of operations related to managing Sources, Folders, Orders and Recipes. There are operations to submit and track Jobs, upload and download data files and many more.

Actions

retrieveFolders

Retrieves all Folders in the Data Inventory.

wealthport.retrieveFolders(null, context)

Input

This action has no parameters

Output

• output array
  • items Existing_Folder

createFolder

Creates the specified Folder in the Data Inventory.

wealthport.createFolder({}, context)

Input

• input object
  • body Folder_Request

Output

Output schema unknown

deleteFolder

Deletes the specified Folder and all contained Sources from the Data Inventory.

wealthport.deleteFolder({
  "id": ""
}, context)

Input

• input object
  • id required string: Folder ID of the Folder to delete, including any Sources contained

Output

Output schema unknown

retrieveFolder

Retrieves the specified Folder.

wealthport.retrieveFolder({
  "id": ""
}, context)

Input

• input object
  • id required string: Folder ID of the Folder to retrieve

Output

• output Existing_Folder

updateFolder

Updates the specified Folder.

wealthport.updateFolder({
  "id": ""
}, context)

Input

• input object
  • body Folder_Request
  • id required string: Folder ID of the Folder to update

Output

Output schema unknown

deleteFolderSources

Deletes all Sources in the specified Folder.

wealthport.deleteFolderSources({
  "id": ""
}, context)

Input

• input object
  • id required string: Folder ID of the Folder to delete all Sources from

Output

Output schema unknown

retrieveFolderSources

Retrieves all Sources of the specified Folder.

wealthport.retrieveFolderSources({
  "id": ""
}, context)

Input

• input object
  • id required string: Folder ID of the Folder to retrieve its Sources from

Output

• output Existing_Source

getResult

Returns the result of a finished Job.

wealthport.getResult({
  "id": ""
}, context)

Input

• input object
  • id required string: Job ID of the job to retrieve its result

Output

• output string

getStatus

Retrieves the status of a Job.

wealthport.getStatus({
  "id": ""
}, context)

Input

• input object
  • id required string: Job ID of the job to retrieve its status

Output

• output string

retrieveOrders

Retrieves all previously submitted Orders.

wealthport.retrieveOrders(null, context)

Input

This action has no parameters

Output

• output array
  • items Existing_Order

createOrder

Creates a new Order to be submitted.Orders reference one or more Sources, e.g. uploaded files, as well as one or more Folders (which again can contain Sources).The Recipe describes what to do with the referenced sources and where to publish the processing result to.

wealthport.createOrder({}, context)

Input

• input object
  • body Order_Request

Output

Output schema unknown

deleteOrder

Deletes the specified Order.

wealthport.deleteOrder({
  "id": ""
}, context)

Input

• input object
  • id required string: Order ID of the order to delete

Output

Output schema unknown

retrieveOrder

Retrieves the specified Order.

wealthport.retrieveOrder({
  "id": ""
}, context)

Input

• input object
  • id required string: Order ID of the order to retrieve

Output

• output Existing_Order

updateOrder

Updates the specified Order.

wealthport.updateOrder({
  "id": ""
}, context)

Input

• input object
  • body Order_Request
  • id required string: Order ID of the order to update

Output

Output schema unknown

submitOrder

Submits the specified Order for processing and launches a corresponding job.

wealthport.submitOrder({
  "id": ""
}, context)

Input

• input object
  • id required string: Order ID of the order to submit for processing

Output

• output string

retrieveRecipes

Retrieves all available Recipes.

wealthport.retrieveRecipes(null, context)

Input

This action has no parameters

Output

• output array
  • items Existing_Recipe

retrieveRecipe

Retrieves the specified Recipe.

wealthport.retrieveRecipe({
  "id": ""
}, context)

Input

• input object
  • id required string: Recipe ID of the recipe to retrieve

Output

• output Existing_Recipe

retrieveInstructions

Retrieves the instructions of the specified Recipe.

wealthport.retrieveInstructions({
  "id": ""
}, context)

Input

• input object
  • id required string: Recipe ID of the recipe whose instructions to retrieve

Output

• output string

updateInstructions

Updates the instructions of the specified Recipe.

wealthport.updateInstructions({
  "id": ""
}, context)

Input

• input object
  • id required string: Recipe ID of the recipe whose instructions to update
  • body string

Output

Output schema unknown

retrieveSources

Retrieves all Sources stored in the Data Inventory.

wealthport.retrieveSources(null, context)

Input

This action has no parameters

Output

• output array
  • items Existing_Source

createSource

Creates the specified Source.Sources are either uploaded files or a reference to a database. They are referenced in orders to specify which data needs processing.Most clients should probably use the Upload File API which implicitly creates a new source on successful file upload.

wealthport.createSource({}, context)

Input

• input object
  • body Source_Request

Output

Output schema unknown

getUploadUrl

Initiates a file upload and returns the URL where to upload the file to.Calling this API generates a secure, unique and time-restricted URL where the file can be uploaded to. The URL is available in the Location HTTP header of the response. The temporal validity of the URL is available in the Cache-Control HTTP header of the response.Clients may perform a HTTP PUT request on the URL to upload the file using a form where a file sample.csv is passed as property file=sample.csv. For security reasons, clients must pass all HTTP headers as returned by the X-WP-Upload-Headers in the response, together with their values. This procedure ensures a secure, encrypted file upload.Note that calling this API automatically generates a Source, there is no need to call the Create Source API.

wealthport.getUploadUrl({
  "name": ""
}, context)

Input

• input object
  • name required string: Name of the source to create. The name must correspond to the exact file name of the file being uploaded.
  • source string: Existing source ID to create a new version from
  • folder string: Folder ID where to upload source to
  • contentType string: MIME type of the source file
  • encoding string: Encoding of the source file

Output

• output string

deleteSource

Deletes the specified Source.

wealthport.deleteSource({
  "id": ""
}, context)

Input

• input object
  • id required string: Source ID of the Source to delete

Output

Output schema unknown

retrieveSource

Retrieves the specified Source.

wealthport.retrieveSource({
  "id": ""
}, context)

Input

• input object
  • id required string: Source ID of the source to retrieve

Output

• output Existing_Source

updateSource

Updates the specified Source.

wealthport.updateSource({
  "id": ""
}, context)

Input

• input object
  • body Source_Request
  • id required string: Source ID of Source to update

Output

Output schema unknown

getDownloadUrl

Initiates a file download and returns the URL where to download the file from.Calling this API generates a secure, unique and time-restricted URL where the file can be downloaded from. The URL is available in the Location HTTP header of the response. The time restriction of the URL is availablein the Cache-Control HTTP header of the response.Clients may perform a HTTP GET request on the URL to download the file.

wealthport.getDownloadUrl({
  "id": ""
}, context)

Input

• input object
  • id required string: Source ID of file to download

Output

• output string

Definitions

Archivable_Object

• Archivable_Object object
  • archived boolean
  • id required string

Existing_Folder

Existing_Order

Existing_Recipe

Existing_Source

Folder_Request

Order_Request

Source_Request