API Endpoints

Get to understand the API

to test the api you can go on the tutorial site

/authorize/{provider}

PARAMETERS
GET authorize api for OAuth protocol

Responses

200 Success

/callback/{provider}

PARAMETERS
GET callback api for OAuth protocol

Responses

200 Success

/conf/

GET get all configured elements

Responses

200 Success

/conf/{project}/

PUT create a project

Responses

200 Success
POST (KO) import a zipped project

Parameters

Name Located in Description Type
file formData yaml file Array of File

Responses

200 Success
DELETE delete a project

Responses

200 Success
PARAMETERS
GET get configuration files of a project

Responses

200 Success

/conf/{project}/{file}

POST upload a text/yaml configuration file to a project

Parameters

Name Located in Description Type
yaml query yaml text String

Responses

200 Success
DELETE delete a text/yaml configuration file from project

Responses

200 Success
PARAMETERS
GET get a text/yaml configuration file from project

Responses

200 Success

/connectors/

GET get json of all configured connectors

Responses

200 Success

/datasets/

GET get json of all configured datasets

Responses

200 Success

/datasets/{dataset}/

POST get sample of a configured dataset, number of rows being configured in connector

Responses

200 Success
DELETE delete the content of a dataset (currently only working on elasticsearch datasets)

Responses

200 Success
PARAMETERS
GET get json of a configured dataset

Responses

200 Success

/datasets/{dataset}/{action}

PUT action = validation : configure the frontend to point to this dataset

Responses

200 Success
POST direct search into the dataset

Parameters

Name Located in Description Type
file formData data file : csv, ... File

Responses

200 Success
PARAMETERS
GET alternative way to get text/yaml source code including the dataset

Responses

200 Success

/datasets/{dataset}/{doc_type}/{id}/{action}

POST elasticsearch update api proxy

Parameters

Name Located in Description Type
file formData data file : csv, ... File

Responses

200 Success
PARAMETERS

/groups/

GET get all groups

Responses

200 Success

/jobs/

GET retrieve jobs list

Responses

200 Success

/login/

POST login api with user and hash

Responses

200 Success
GET return current user if logged

Responses

200 Success

/logout/

POST logout current user

Responses

200 Success

/recipes/

GET get json of all configured recipes

Responses

200 Success

/recipes/{recipe}/

PARAMETERS
GET get json of a configured recipe

Responses

200 Success

/recipes/{recipe}/{action}

PUT test, run or stop recipe

Responses

200 Success
POST apply recipe on posted data

Parameters

Name Located in Description Type
file formData data file : csv, ... File

Responses

200 Success
PARAMETERS
GET retrieve information on a recipe

Responses

200 Success

/roles/

GET get all roles

Responses

200 Success

/upload/

POST upload multiple tabular data files,

Parameters

Name Located in Description Type
file formData data file : csv, ... Array of File

Responses

200 Success
GET list uploaded resources

Responses

200 Success

/upload/{file}

DELETE deleted uploaded file

Responses

200 Success
PARAMETERS
GET get back uploaded file

Responses

200 Success

/users/

GET get list of all configured users

Responses

200 Success