luminesce-sdk 2.1.164

FINBOURNE Luminesce Web API

Documentation for API Endpoints

All URIs are relative to https://fbn-prd.lusid.com/honeycomb

Class	Method	HTTP request	Description
ApplicationMetadataApi	get_services_as_access_controlled_resources	GET /api/metadata/access/resources	GetServicesAsAccessControlledResources: Get resources available for access control
BinaryDownloadingApi	download_binary	GET /api/Download/download	[EXPERIMENTAL] DownloadBinary: Download a Luminesce Binary you may run on-site
BinaryDownloadingApi	get_binary_versions	GET /api/Download/versions	[EXPERIMENTAL] GetBinaryVersions: List available versions of binaries
CertificateManagementApi	download_certificate	GET /api/Certificate/certificate	[EXPERIMENTAL] DownloadCertificate: Download domain or your personal certificates
CertificateManagementApi	list_certificates	GET /api/Certificate/certificates	[EXPERIMENTAL] ListCertificates: List previously minted certificates
CertificateManagementApi	manage_certificate	PUT /api/Certificate/manage	[EXPERIMENTAL] ManageCertificate: Create / Renew / Revoke a certificate
CurrentTableFieldCatalogApi	get_catalog	GET /api/Catalog	GetCatalog: Get a Flattened Table/Field Catalog
CurrentTableFieldCatalogApi	get_fields	GET /api/Catalog/fields	GetFields: List field and parameters for providers
CurrentTableFieldCatalogApi	get_providers	GET /api/Catalog/providers	GetProviders: List available providers
HealthCheckingEndpointApi	fake_node_reclaim	GET /fakeNodeReclaim	[INTERNAL] FakeNodeReclaim: Helps testing of AWS node reclaim behaviour
HistoricallyExecutedQueriesApi	cancel_history	DELETE /api/History/{executionId}	CancelHistory: Cancel / Clear data from a history search
HistoricallyExecutedQueriesApi	fetch_history_result_histogram	GET /api/History/{executionId}/histogram	FetchHistoryResultHistogram: Make a histogram of results of a history search
HistoricallyExecutedQueriesApi	fetch_history_result_json	GET /api/History/{executionId}/json	FetchHistoryResultJson: Fetch JSON results from a query history search
HistoricallyExecutedQueriesApi	get_history	GET /api/History	GetHistory: Start a background history search
HistoricallyExecutedQueriesApi	get_progress_of_history	GET /api/History/{executionId}	GetProgressOfHistory: View progress of a history search
MultiQueryExecutionApi	cancel_multi_query	DELETE /api/MultiQueryBackground/{executionId}	CancelMultiQuery: Cancel / Clear a previously started query-set
MultiQueryExecutionApi	get_progress_of_multi_query	GET /api/MultiQueryBackground/{executionId}	GetProgressOfMultiQuery: View progress of the entire query-set load
MultiQueryExecutionApi	start_queries	PUT /api/MultiQueryBackground	StartQueries: Run a given set of Sql queries in the background
SqlBackgroundExecutionApi	cancel_query	DELETE /api/SqlBackground/{executionId}	CancelQuery: Cancel / Clear data from a previously run query
SqlBackgroundExecutionApi	fetch_query_result_csv	GET /api/SqlBackground/{executionId}/csv	FetchQueryResultCsv: Fetch the result of a query as CSV
SqlBackgroundExecutionApi	fetch_query_result_excel	GET /api/SqlBackground/{executionId}/excel	FetchQueryResultExcel: Fetch the result of a query as an Excel file
SqlBackgroundExecutionApi	fetch_query_result_histogram	GET /api/SqlBackground/{executionId}/histogram	FetchQueryResultHistogram: Construct a histogram of the result of a query
SqlBackgroundExecutionApi	fetch_query_result_json	GET /api/SqlBackground/{executionId}/json	FetchQueryResultJson: Fetch the result of a query as a JSON string
SqlBackgroundExecutionApi	fetch_query_result_json_proper	GET /api/SqlBackground/{executionId}/jsonProper	FetchQueryResultJsonProper: Fetch the result of a query as JSON
SqlBackgroundExecutionApi	fetch_query_result_parquet	GET /api/SqlBackground/{executionId}/parquet	FetchQueryResultParquet: Fetch the result of a query as Parquet
SqlBackgroundExecutionApi	fetch_query_result_pipe	GET /api/SqlBackground/{executionId}/pipe	FetchQueryResultPipe: Fetch the result of a query as pipe-delimited
SqlBackgroundExecutionApi	fetch_query_result_sqlite	GET /api/SqlBackground/{executionId}/sqlite	FetchQueryResultSqlite: Fetch the result of a query as SqLite
SqlBackgroundExecutionApi	fetch_query_result_xml	GET /api/SqlBackground/{executionId}/xml	FetchQueryResultXml: Fetch the result of a query as XML
SqlBackgroundExecutionApi	get_progress_of	GET /api/SqlBackground/{executionId}	GetProgressOf: View query progress up to this point
SqlBackgroundExecutionApi	start_query	PUT /api/SqlBackground	StartQuery: Start to Execute Sql in the background
SqlDesignApi	get_provider_template_for_export	GET /api/Sql/providertemplateforexport	GetProviderTemplateForExport: Makes a fields template for file importing via a writer
SqlDesignApi	put_case_statement_design_sql_to_design	PUT /api/Sql/tocasestatementdesign	[EXPERIMENTAL] PutCaseStatementDesignSqlToDesign: Convert SQL to a case statement design object
SqlDesignApi	put_case_statement_design_to_sql	PUT /api/Sql/fromcasestatementdesign	[EXPERIMENTAL] PutCaseStatementDesignToSql: Convert a case statement design object to SQL
SqlDesignApi	put_file_read_design_to_sql	PUT /api/Sql/fromfilereaddesign	[EXPERIMENTAL] PutFileReadDesignToSql: Make file read SQL from a design object
SqlDesignApi	put_inlined_properties_design_sql_to_design	PUT /api/Sql/toinlinedpropertiesdesign	[EXPERIMENTAL] PutInlinedPropertiesDesignSqlToDesign: Make an inlined properties design from SQL
SqlDesignApi	put_inlined_properties_design_to_sql	PUT /api/Sql/frominlinedpropertiesdesign	[EXPERIMENTAL] PutInlinedPropertiesDesignToSql: Make inlined properties SQL from a design object
SqlDesignApi	put_intellisense	PUT /api/Sql/intellisense	PutIntellisense: Make intellisense prompts given an SQL snip-it
SqlDesignApi	put_intellisense_error	PUT /api/Sql/intellisenseError	PutIntellisenseError: Get error ranges from SQL
SqlDesignApi	put_query_design_to_sql	PUT /api/Sql/fromdesign	[EXPERIMENTAL] PutQueryDesignToSql: Make SQL from a structured query design
SqlDesignApi	put_query_to_format	PUT /api/Sql/pretty	PutQueryToFormat: Format SQL into a more readable form
SqlDesignApi	put_sql_to_extract_scalar_parameters	PUT /api/Sql/extractscalarparameters	[EXPERIMENTAL] PutSqlToExtractScalarParameters: Extract scalar parameter information from SQL
SqlDesignApi	put_sql_to_file_read_design	PUT /api/Sql/tofilereaddesign	[EXPERIMENTAL] PutSqlToFileReadDesign: Make a design object from file-read SQL
SqlDesignApi	put_sql_to_query_design	PUT /api/Sql/todesign	[EXPERIMENTAL] PutSqlToQueryDesign: Make a SQL-design object from SQL if possible
SqlDesignApi	put_sql_to_view_design	PUT /api/Sql/toviewdesign	[EXPERIMENTAL] PutSqlToViewDesign: Make a view-design from view creation SQL
SqlDesignApi	put_sql_to_writer_design	PUT /api/Sql/towriterdesign	[EXPERIMENTAL] PutSqlToWriterDesign: Make a SQL-writer-design object from SQL
SqlDesignApi	put_view_design_to_sql	PUT /api/Sql/fromviewdesign	[EXPERIMENTAL] PutViewDesignToSql: Make view creation sql from a view-design
SqlDesignApi	put_writer_design_to_sql	PUT /api/Sql/fromwriterdesign	[EXPERIMENTAL] PutWriterDesignToSql: Make writer SQL from a writer-design object
SqlExecutionApi	get_by_query_csv	GET /api/Sql/csv/{query}	GetByQueryCsv: Execute Sql from the url returning CSV
SqlExecutionApi	get_by_query_excel	GET /api/Sql/excel/{query}	GetByQueryExcel: Execute Sql from the url returning an Excel file
SqlExecutionApi	get_by_query_json	GET /api/Sql/json/{query}	GetByQueryJson: Execute Sql from the url returning JSON
SqlExecutionApi	get_by_query_parquet	GET /api/Sql/parquet/{query}	GetByQueryParquet: Execute Sql from the url returning a Parquet file
SqlExecutionApi	get_by_query_pipe	GET /api/Sql/pipe/{query}	GetByQueryPipe: Execute Sql from the url returning pipe-delimited
SqlExecutionApi	get_by_query_sqlite	GET /api/Sql/sqlite/{query}	GetByQuerySqlite: Execute Sql from the url returning SqLite DB
SqlExecutionApi	get_by_query_xml	GET /api/Sql/xml/{query}	GetByQueryXml: Execute Sql from the url returning XML
SqlExecutionApi	put_by_query_csv	PUT /api/Sql/csv	PutByQueryCsv: Execute Sql from the body returning CSV
SqlExecutionApi	put_by_query_excel	PUT /api/Sql/excel	PutByQueryExcel: Execute Sql from the body making an Excel file
SqlExecutionApi	put_by_query_json	PUT /api/Sql/json	PutByQueryJson: Execute Sql from the body returning JSON
SqlExecutionApi	put_by_query_parquet	PUT /api/Sql/parquet	PutByQueryParquet: Execute Sql from the body making a Parquet file
SqlExecutionApi	put_by_query_pipe	PUT /api/Sql/pipe	PutByQueryPipe: Execute Sql from the body making pipe-delimited
SqlExecutionApi	put_by_query_sqlite	PUT /api/Sql/sqlite	PutByQuerySqlite: Execute Sql from the body returning SqLite DB
SqlExecutionApi	put_by_query_xml	PUT /api/Sql/xml	PutByQueryXml: Execute Sql from the body returning XML

Documentation for Models

• AccessControlledAction
• AccessControlledResource
• AccessControlledResourceIdentifierPartSchemaAttribute
• ActionId
• AggregateFunction
• Aggregation
• AutoDetectType
• AvailableField
• AvailableParameter
• BackgroundMultiQueryProgressResponse
• BackgroundMultiQueryResponse
• BackgroundQueryCancelResponse
• BackgroundQueryProgressResponse
• BackgroundQueryResponse
• BackgroundQueryState
• CaseStatementDesign
• CaseStatementItem
• CertificateAction
• CertificateFileType
• CertificateState
• CertificateStatus
• CertificateType
• Column
• ColumnInfo
• ConditionAttributes
• ConvertToViewData
• CursorPosition
• DataType
• ErrorHighlightItem
• ErrorHighlightRequest
• ErrorHighlightResponse
• ExpressionWithAlias
• FeedbackEventArgs
• FeedbackLevel
• FieldDesign
• FieldType
• FileReaderBuilderDef
• FileReaderBuilderResponse
• FilterTermDesign
• IdSelectorDefinition
• InlinedPropertyDesign
• InlinedPropertyItem
• IntellisenseItem
• IntellisenseRequest
• IntellisenseResponse
• IntellisenseType
• Link
• LuminesceBinaryType
• LusidProblemDetails
• MappableField
• MappingFlags
• MultiQueryDefinitionType
• OptionsCsv
• OptionsExcel
• OptionsParquet
• OptionsSqLite
• OptionsXml
• OrderByDirection
• OrderByTermDesign
• QueryDesign
• QueryDesignerBinaryOperator
• ResourceListOfAccessControlledResource
• ScalarParameter
• Source
• SourceType
• TaskStatus
• ViewParameter
• WriterDesign