Samples for FSI Server API Client JS

Table of Contents

• About
• How to install
• Preperation
• Excecuting a sample file
• API Documentation

About

FSI Server API Client JS offers developers a flexible interface to control the REST OpenAPI of FSI Server.

Uploading, deleting, modifying, creating and managing files and directory structures, as well as complex tasks can be easily accomplished using this high level API client. The FSI Server web interface uses the API client to communicate with FSI Server. You can see the API in action on this demo FSI Server.

This repo contains sample files to get you started developing projects with the FSI Server API client.

How to install

Install with npm:

npm install @neptunelabs/fsi-server-api-client-samples

Install with yarn:

yarn add @neptunelabs/fsi-server-api-client-samples

Preperation

• run the following command to install the required packages:

npm install

• edit the file /src/_FSIServerVars.ts and enter the host and credentials of the FSI Server instance you want to use.

Excecuting a sample file

To run a samples type e.g.:

ts-node src/readMetaData.ts

All Samples files are non-destructive

No files on the configured FSI Server will be modified or deleted upon executing a sample.
E.g. the delete.ts sample copies files to a temporary directory on FSI Server and deletes those files afterwards.

The intention of the samples is just to provide you with a reference how to use the API in your own project.

Default directories

The file /src/_FSIServerVars.ts contains connectors and directories that are present on a stock FSI Server installation to make the samples run out of the box.
You might want to change these directories or alternatively edit the paths in the sample file(s).

API Documentation

Please refer to the API wiki for a complete documentation of the API.