swagger-client

This API allows you to pull and push data with your WILCO deployment https://github.com/flightwatching/wilco-api or on www.flightwatching.com.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 3.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com//.git

(you may need to run pip with root permission: sudo pip install git+https://github.com//.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key_header
swagger_client.configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: api_key_param
swagger_client.configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api-key'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
event_id = 789 # int | the id of the event
content = 'content_example' # str | the sumUp (optional)
rule_id = 789 # int | the id of the rule that has trigged the creation (optional)
fault_code = 'fault_code_example' # str | the fault code if the analysis is linked to a fault code (optional)
d = '2013-10-20T19:20:30+01:00' # datetime | the date where the analysis has to locate. if not set, the event computed date is used (optional)
severity = 'severity_example' # str | the severity of the analysis (optional)
flight_phase = 'flight_phase_example' # str |  (optional)

try:
    # create an analysis from the event passed. should use insert message. see https://github.com/flightwatching/fleet-monitor/issues/55
    api_instance.create_analysis(event_id, content=content, rule_id=rule_id, fault_code=fault_code, d=d, severity=severity, flight_phase=flight_phase)
except ApiException as e:
    print("Exception when calling DefaultApi->create_analysis: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://demo.flightwatching.com/fleet

Class	Method	HTTP request	Description
DefaultApi	create_analysis	POST /apiv3/events/{eventId}/createAnalysis	create an analysis from the event passed. should use insert message. see https://github.com/flightwatching/fleet-monitor/issues/55
DefaultApi	create_dashboard	POST /apiv3/dashboards	creates the dashboard
DefaultApi	create_dashboard_rule	POST /apiv3/dashboards/{dbid}/rules	creates a dashboard rule
DefaultApi	create_dashboard_svg	POST /apiv3/dashboards/{dbid}/svg	Returns the SVG for a dashboard
DefaultApi	create_dashboard_symbols	POST /apiv3/symbols	Returns all the dashboard symbols
DefaultApi	create_event	POST /apiv3/events	creates an event
DefaultApi	create_event_samples	POST /apiv3/events/{eventId}/samples	Returns the samples of an event
DefaultApi	create_faultcode	POST /apiv3/faultcodes	Creates a fault code from the body
DefaultApi	create_fwot	POST /apiv3/fwots	Returns all the fwots paginated. If the connected user has an airline, the list is filtered for this airline
DefaultApi	create_fwot_property	POST /apiv3/{pluralCategory}/{reg}/property	add a new property to the fwot. If null passed in the value arg, the prop is removed
DefaultApi	create_layout	POST /apiv3/layouts/{layoutId}	modifies a layout stored in WILCO
DefaultApi	create_layout_event	POST /apiv3/events/{eventId}/layout	Creates a layout from a message
DefaultApi	create_layouts	POST /apiv3/layouts	Returns list of layouts stored in WILCO
DefaultApi	create_parameters	POST /apiv3/parameters	Returns the parameters for the given search string
DefaultApi	create_simulate_push_pull	POST /apiv3/layouts/{pullLayoutId}/test	Calls the URL service and simulates the call to the IFT with the returned content in the right variable. In the body you will need a json structure {formula:'<the formula>'}
DefaultApi	create_symbol	POST /apiv3/symbols/{symbolId}	Returns/create/updates all the dashboard symbols. to delete a symbol function, empty its name
DefaultApi	create_symbol_svg_example	POST /apiv3/symbols/{symbolId}/svgExample	Returns the SVG example for a symbol
DefaultApi	create_test_ift	POST /apiv3/ifts/test	returns the logs for simulating the passed formula against past evtId. In the body you will need a json structure {formula:'<the formula>', msgId:3652, language:JS_NODEJS}
DefaultApi	create_toggle_event	POST /apiv3/events/{eventId}/toggle	Updates an event
DefaultApi	create_toggle_event1	POST /apiv3/{pluralCategory}/{reg}/events/{eventId}/toggle	Updates an event
DefaultApi	create_trends	POST /apiv3/trendbundles	Returns list of trends stored in WILCO
DefaultApi	create_uplink	POST /apiv3/layouts/{layoutId}/uplink	uplink the with the layout
DefaultApi	create_uplink_same	POST /apiv3/{pluralCategory}/{reg}/events/{eventId}/uplinkSame	uplink the fwot to get the same message as the event passed.uplinks only if the event has an uplinkable layout
DefaultApi	create_webhook	POST /apiv3/layouts/webhook/{webhookId}	endpoint for push layouts webhooks
DefaultApi	delete_dashboard_rule	DELETE /apiv3/dashboards/{dbid}/rules/{id}	deletes the dashboard rule
DefaultApi	delete_dashboard_symbols	DELETE /apiv3/symbols	Returns all the dashboard symbols
DefaultApi	delete_dashboards_dbid	DELETE /apiv3/dashboards/{dbid}	trashes the dashboard
DefaultApi	delete_event	DELETE /apiv3/events/{eventId}	Returns an event from the ID
DefaultApi	delete_layout	DELETE /apiv3/layouts/{layoutId}	marks a layout as trashed
DefaultApi	delete_parameter	DELETE /apiv3/parameters/{id}	returns a parameter. You can PUT or GET. DELETE not yet supported
DefaultApi	delete_symbol	DELETE /apiv3/symbols/{symbolId}	Returns/create/updates all the dashboard symbols. to delete a symbol function, empty its name
DefaultApi	delete_trend	DELETE /apiv3/trendbundles/{bundleId}	get, update or delete a trend
DefaultApi	get_admin_links	GET /apiv3/adminLinks	returns a list of links to admin features
DefaultApi	get_blocking_listen	GET /apiv3/events/listenNewMessages	The method blocks until something happends in the message queue: creation, new message, fault, rule detected something, user did something (manual close, clear, recall warning...). no more than 100 messages from the after parameter
DefaultApi	get_bookmark	GET /apiv3/bookmarks/{bookmark}/photo	Returns the bookmark image
DefaultApi	get_bookmarks	GET /apiv3/bookmarks	Returns list of bookmarks stored in WILCO
DefaultApi	get_categories	GET /apiv3/categories	Returns all the categories
DefaultApi	get_config	GET /apiv3/config	check the status of the server
DefaultApi	get_constants	GET /apiv3/constants	Returns all the constants
DefaultApi	get_dashboard	GET /apiv3/dashboards/{id}	Returns the dashboard
DefaultApi	get_dashboard_rule	GET /apiv3/dashboards/rules/{id}	Returns the dashboard rule
DefaultApi	get_dashboard_rule1	GET /apiv3/dashboards/{dbid}/rules/{id}	Returns the dashboard rule
DefaultApi	get_dashboard_svg	GET /apiv3/dashboards/{dbid}/svg	Returns the SVG for a dashboard
DefaultApi	get_dashboard_symbols	GET /apiv3/symbols	Returns all the dashboard symbols
DefaultApi	get_event	GET /apiv3/events/{eventId}	Returns an event from the ID
DefaultApi	get_event1	GET /apiv3/{pluralCategory}/{reg}/events/{eventId}	Returns an event from the ID
DefaultApi	get_event_param	GET /apiv3/events/{eventId}/parameters/{name}	Returns param for this name, in this event
DefaultApi	get_event_param1	GET /apiv3/{pluralCategory}/{reg}/events/{eventId}/parameters/{name}	Returns param for this name, in this event
DefaultApi	get_event_params	GET /apiv3/events/{eventId}/parameters	Returns the params involved in an event
DefaultApi	get_event_params1	GET /apiv3/{pluralCategory}/{reg}/events/{eventId}/parameters	Returns the params involved in an event
DefaultApi	get_event_samples	GET /apiv3/events/{eventId}/samples	Returns the samples of an event
DefaultApi	get_event_samples1	GET /apiv3/{pluralCategory}/{reg}/events/{eventId}/samples	Returns the samples of an event
DefaultApi	get_faultcodes	GET /apiv3/faultcodes	Returns the fault codes for the given fwot type
DefaultApi	get_fwot	GET /apiv3/{pluralCategory}/{reg}	Returns the fwot
DefaultApi	get_fwot_events	GET /apiv3/events	Returns some events of an fwot according to some filters
DefaultApi	get_fwot_events1	GET /apiv3/{pluralCategory}/{reg}/events	Returns some events of an fwot according to some filters
DefaultApi	get_fwot_image	GET /apiv3/{pluralCategory}/{reg}/photo	Returns the fwot image
DefaultApi	get_fwots	GET /apiv3/{pluralCategory}	Returns all the fwots paginated. If the connected user has an airline, the list is filtered for this airline
DefaultApi	get_fwots1	GET /apiv3/fwots	Returns all the fwots paginated. If the connected user has an airline, the list is filtered for this airline
DefaultApi	get_ift	GET /apiv3/ifts/{id}	updates (PUT) and/or returns(GET) the ift
DefaultApi	get_ifts	GET /apiv3/ifts	Returns the ifts for faultcodes, layouts, parameters or robots
DefaultApi	get_ifts1	GET /apiv3/ifts/{category}	Returns the ifts for faultcodes, layouts, parameters or robots
DefaultApi	get_last_event	GET /apiv3/events/last/{count}	all last events
DefaultApi	get_last_fwot_event	GET /apiv3/{pluralCategory}/{reg}/events/last	Returns the last event for a fwot
DefaultApi	get_layout	GET /apiv3/layouts/{layoutId}	Returns a layout stored in WILCO
DefaultApi	get_layouts	GET /apiv3/layouts	Returns list of layouts stored in WILCO
DefaultApi	get_layouts_layout_id_spider	GET /apiv3/layouts/{layoutId}/spider	Tunnels the layout EXT URL. If not an ExternalSourceLayout, returns a BAD REQUEST
DefaultApi	get_login	GET /apiv3/login	login to be authenticated
DefaultApi	get_logout	GET /apiv3/logout	log out from the current session
DefaultApi	get_next_event	GET /apiv3/{pluralCategory}/{reg}/events/{eventId}/next	Returns the next events type as the given one
DefaultApi	get_parameter	GET /apiv3/parameters/{id}	returns a parameter. You can PUT or GET. DELETE not yet supported
DefaultApi	get_parameter1	GET /apiv3/parameters/{actype}/{name}	Returns the parameter
DefaultApi	get_parameter2	GET /apiv3/{pluralCategory}/{reg}/parameters/{name}	Returns the parameter
DefaultApi	get_parameters	GET /apiv3/parameters	Returns the parameters for the given search string
DefaultApi	get_parameters1	GET /apiv3/parameters/{actype}	Returns all parameters for an fwot type
DefaultApi	get_plural_category_reg_refresh	GET /apiv3/{pluralCategory}/{reg}/refresh	refresh the cache of the fwot
DefaultApi	get_previous_event	GET /apiv3/{pluralCategory}/{reg}/events/{eventId}/prev	Returns the previous events type as the given one
DefaultApi	get_raw	GET /apiv3/{pluralCategory}/{reg}/events/{eventId}/raw	returns the raw data for a message. empty string if not exists
DefaultApi	get_sample	GET /apiv3/samples/{sampleId}	Returns a sample
DefaultApi	get_samples	GET /apiv3/samples	Returns list of samples stored in WILCO
DefaultApi	get_samples1	GET /apiv3/parameters/{actype}/{name}/samples	Returns a sample csv table as required in dygraphs for the fwot type. It can be filtered on filter parameter values.
DefaultApi	get_samples2	GET /apiv3/{pluralCategory}/{reg}/samples/{name}	Returns list of samples stored in WILCO
DefaultApi	get_samples3	GET /apiv3/{pluralCategory}/{reg}/samples	Returns list of samples stored in WILCO
DefaultApi	get_stats	GET /apiv3/stats	fetches some statistics on the running server
DefaultApi	get_status	GET /apiv3/status	check the status of the server
DefaultApi	get_symbol	GET /apiv3/symbols/{symbolId}	Returns/create/updates all the dashboard symbols. to delete a symbol function, empty its name
DefaultApi	get_symbol_svg_example	GET /apiv3/symbols/{symbolId}/svgExample	Returns the SVG example for a symbol
DefaultApi	get_terms_and_conditions	GET /apiv3/TnCs.html	returns the HTML for the terms and conditions
DefaultApi	get_trend	GET /apiv3/trendbundles/{bundleId}	get, update or delete a trend
DefaultApi	get_trends	GET /apiv3/trendbundles	Returns list of trends stored in WILCO
DefaultApi	get_user	GET /apiv3/profile	Returns profile of the current user
DefaultApi	get_users	GET /apiv3/users	fetches the list of users
DefaultApi	post_acars	POST /apiv3/acars	posts some raw data. if the decoder is not passed, then they are tried to find the first matching one
DefaultApi	post_acars_parser_name	POST /apiv3/acars/{parserName}	posts some raw data. if the decoder is not passed, then they are tried to find the first matching one
DefaultApi	put_insert_message	PUT /apiv3/insertMessage	interface to update a message with the WILCO format. Deprecated. Use PUT:event
DefaultApi	update_batch_reprocess	PUT /apiv3/events/{eventId}/reprocess/batch	allows to reprocess all the events with the same layout. It deletes and recreates the matching messages, samples and analysis. THIS CAN BE VEEERRY LONG and DANGEROUS. It processes the last week only taking the event date as ref date
DefaultApi	update_dashboard	PUT /apiv3/dashboards/{id}	modifies the dashboard
DefaultApi	update_dashboard_rule	PUT /apiv3/dashboards/{dbid}/rules/{id}	modifies the dashboard rule
DefaultApi	update_dashboard_symbols	PUT /apiv3/symbols	Returns all the dashboard symbols
DefaultApi	update_event	PUT /apiv3/events/{eventId}	Returns an event from the ID
DefaultApi	update_fwot	PUT /apiv3/{pluralCategory}/{reg}	Updates the fwot
DefaultApi	update_fwot_position	PUT /apiv3/{pluralCategory}/{reg}/location	sets the fwot position
DefaultApi	update_ift	PUT /apiv3/ifts/{id}	updates (PUT) and/or returns(GET) the ift
DefaultApi	update_parameter	PUT /apiv3/parameters/{id}	returns a parameter. You can PUT or GET. DELETE not yet supported
DefaultApi	update_reprocess	PUT /apiv3/events/{eventId}/reprocess	allows to reprocess the event. It deletes the message, samples and analysis and recomputes it
DefaultApi	update_symbol	PUT /apiv3/symbols/{symbolId}	Returns/create/updates all the dashboard symbols. to delete a symbol function, empty its name
DefaultApi	update_tag	PUT /apiv3/events/{eventId}/tag	tags an event
DefaultApi	update_trend	PUT /apiv3/trendbundles/{bundleId}	get, update or delete a trend
DefaultApi	update_un_tag	PUT /apiv3/events/{eventId}/untag	untags an event
DefaultApi	update_webhook	PUT /apiv3/layouts/webhook/{webhookId}	endpoint for push layouts webhooks

Documentation For Models

• BookmarkV3IO
• ConstantV3IO
• DashboardSymbolFunctionV3IO
• DashboardSymbolV3IO
• DashboardV3IO
• ErrorDao
• EventV3IO
• ExtSource
• FwotV3IO
• IeiParamV3IO
• IeiV3IO
• IftV3IO
• LayoutV3IO
• Map
• ParameterV3IO
• RuleV3IO
• SampleV3IO
• StatsV3IO
• String
• TagV3IO
• TrendBundleV3IO
• UserV3IO

Documentation For Authorization

api_key_header

• Type: API key
• API key parameter name: api-key
• Location: HTTP header

api_key_param

• Type: API key
• API key parameter name: api-key
• Location: URL query string

Author

[email protected]