oasislmf.platform_api.client

Module Contents

Classes

ApiEndpoint	Used to Implement the default requests common to all Oasis API
JsonEndpoint	Used for JSON data End points.
FileEndpoint	File Resources Endpoint for Upload / Downloading
API_models	Used to Implement the default requests common to all Oasis API
API_portfolios	Used to Implement the default requests common to all Oasis API
API_analyses	Used to Implement the default requests common to all Oasis API
APIClient

class oasislmf.platform_api.client.ApiEndpoint(session, url_endpoint, logger=None)

Bases: object

Used to Implement the default requests common to all Oasis API End points.

create(data)

get(ID=None)

delete(ID)

search(metadata={})

class oasislmf.platform_api.client.JsonEndpoint(session, url_endpoint, url_resource, logger=None)

Bases: object

Used for JSON data End points.

get(ID)

post(ID, data)

delete(ID)

download(ID, file_path, overwrite=True)

class oasislmf.platform_api.client.FileEndpoint(session, url_endpoint, url_resource, logger=None)

Bases: object

File Resources Endpoint for Upload / Downloading

upload(ID, file_path, content_type=None)

download(ID, file_path, overwrite=True, chuck_size=1024)

get(ID)

get_dataframe(ID)

Return file endpoint as dict of pandas Dataframes:

either ‘application/gzip’: search and extract all csv or ‘text/csv’: return as dataframe

post(ID, data_object, content_type='application/json')

post_dataframe(ID, data_frame)

delete(ID)

class oasislmf.platform_api.client.API_models(session, url_endpoint)

Bases: ApiEndpoint

Used to Implement the default requests common to all Oasis API End points.

data_files(ID)

create(supplier_id, model_id, version_id, data_files=[])

update(ID, supplier_id, model_id, version_id, data_files=[])

class oasislmf.platform_api.client.API_portfolios(session, url_endpoint)

Bases: ApiEndpoint

Used to Implement the default requests common to all Oasis API End points.

create(name)

update(ID, name)

create_analyses(ID, name, model_id)

Create new analyses from Exisiting portfolio

class oasislmf.platform_api.client.API_analyses(session, url_endpoint)

Bases: ApiEndpoint

Used to Implement the default requests common to all Oasis API End points.

create(name, portfolio_id, model_id, data_files=[])

update(ID, name, portfolio_id, model_id, data_files=[])

status(ID)

generate(ID)

run(ID)

generate_and_run(ID)

cancel_analysis_run(ID)

cancel_generate_inputs(ID)

cancel(ID)

copy(ID)

data_files(ID)

storage_links(ID)

sub_task_list(ID)

class oasislmf.platform_api.client.APIClient(api_url='http://localhost:8000', api_ver='V2', username='admin', password='password', timeout=25, logger=None, **kwargs)

Bases: object

oed_peril_codes()

server_info()

healthcheck()

upload_inputs(portfolio_name=None, portfolio_id=None, location_fp=None, accounts_fp=None, ri_info_fp=None, ri_scope_fp=None)

upload_settings(analyses_id, settings)

Upload an analyses run settings to an API

Method to post JSON data or upload a settings file containing JSON data

Parameters

param analyses_id:

Analyses settings {id} from, v1/analyses/{id}/settings

type analyses_id:

int

param settings:

Either a valid filepath or dictionary holding the settings

type settings:

[str, dict]

return:

:rtype None

create_analysis(portfolio_id, model_id, analysis_name=None, analysis_settings_fp=None)

run_generate(analysis_id, poll_interval=5)

Generates the inputs for the analysis based on the portfolio. The analysis must have one of the following statuses, NEW, INPUTS_GENERATION_ERROR, INPUTS_GENERATION_CANCELLED, READY, RUN_COMPLETED, RUN_CANCELLED or RUN_ERROR.

run_analysis(analysis_id, analysis_settings_fp=None, poll_interval=5)

Runs all the analysis. The analysis must have one of the following statuses, NEW, RUN_COMPLETED, RUN_CANCELLED or RUN_ERROR

download_output(analysis_id, download_path='', filename=None, clean_up=False, overwrite=True)

cancel_generate(analysis_id)

Cancels a currently inputs generation. The analysis status must be GENERATING_INPUTS

cancel_analysis(analysis_id)

Cancels a currently running analysis. The analysis must have one of the following statuses, PENDING or STARTED