finbourne-horizon-sdk 2.3.18

FINBOURNE Horizon API

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
InstrumentApi	create_instrument	POST /api/instrument/onboarding/create	[EARLY ACCESS] CreateInstrument: Creates and masters instruments with third party vendors.
InstrumentApi	enrich_instrument	POST /api/instrument/onboarding/enrich	[EARLY ACCESS] EnrichInstrument: Enriches an existing LUSID instrument using vendor data. Enrichment included identifiers, properties and market data.
InstrumentApi	get_open_figi_parameter_option	GET /api/instrument/onboarding/search/openfigi/parameterOptions	[EARLY ACCESS] GetOpenFigiParameterOption: Get all supported market sector values for OpenFigi search
InstrumentApi	retrieve_perm_id_result	GET /api/instrument/onboarding/search/permid/{id}	[EARLY ACCESS] RetrievePermIdResult: Retrieve PermId results from a previous query.
InstrumentApi	search_open_figi	GET /api/instrument/onboarding/search/openfigi	[EARLY ACCESS] SearchOpenFigi: Search OpenFigi for instruments that match the specified terms.
InstrumentApi	vendors	GET /api/instrument/onboarding/vendors	[EARLY ACCESS] Vendors: Gets the VendorProducts of any supported and licenced integrations for a given market sector and security type.
IntegrationsApi	create_instance	POST /api/integrations/instances	[EXPERIMENTAL] CreateInstance: Create a single integration instance.
IntegrationsApi	delete_instance	DELETE /api/integrations/instances/{instanceId}	[EXPERIMENTAL] DeleteInstance: Delete a single integration instance.
IntegrationsApi	execute_instance	POST /api/integrations/instances/{instanceId}/execute	[EXPERIMENTAL] ExecuteInstance: Execute an integration instance.
IntegrationsApi	execute_instance_with_params	POST /api/integrations/instances/{instanceId}/executewithparams	[EXPERIMENTAL] ExecuteInstanceWithParams: Execute an integration instance with runtime parameters
IntegrationsApi	get_dataflow_processor_schema	GET /api/integrations/dataflow/processors/{processorType}/schema	[EXPERIMENTAL] GetDataflowProcessorSchema: Returns processor configuration schema for a given processor type. This is used by the UI to render the configuration form for a processortype.
IntegrationsApi	get_execution_ids_for_instance	GET /api/integrations/instances/{instanceId}/executions	[EXPERIMENTAL] GetExecutionIdsForInstance: Get integration instance execution ids.
IntegrationsApi	get_instance	GET /api/integrations/instances/{instanceId}	[EXPERIMENTAL] GetInstance: Get a specified Instance for a given integration.
IntegrationsApi	get_instance_optional_property_mapping	GET /api/integrations/instances/configuration/{integration}/{instanceId}	[EXPERIMENTAL] GetInstanceOptionalPropertyMapping: Get the Optional Property Mapping for an Integration Instance
IntegrationsApi	get_integration_configuration	GET /api/integrations/configuration/{integration}	[EXPERIMENTAL] GetIntegrationConfiguration: Get the Field and Property Mapping configuration for a given integration
IntegrationsApi	get_integration_configuration_fields	GET /api/integrations/configuration/{integration}/fields	[EXPERIMENTAL] GetIntegrationConfigurationFields: Get the Field Mapping configuration for a given integration
IntegrationsApi	get_integration_configuration_properties	GET /api/integrations/configuration/{integration}/properties	[EXPERIMENTAL] GetIntegrationConfigurationProperties: Get the Property Mapping configuration for a given integration
IntegrationsApi	get_schema	GET /api/integrations/schema/{integration}	[EXPERIMENTAL] GetSchema: Get the JSON schema for the details section of an integration instance.
IntegrationsApi	list_dataflow_processors	GET /api/integrations/dataflow/processors	[EXPERIMENTAL] ListDataflowProcessors: List processor types.
IntegrationsApi	list_instances	GET /api/integrations/instances	[EXPERIMENTAL] ListInstances: List instances across all integrations.
IntegrationsApi	list_integrations	GET /api/integrations	[EXPERIMENTAL] ListIntegrations: List available integrations.
IntegrationsApi	set_instance_optional_property_mapping	PUT /api/integrations/instances/configuration/{integration}/{instanceId}	[EXPERIMENTAL] SetInstanceOptionalPropertyMapping: Set the Optional Property Mapping for an Integration Instance
IntegrationsApi	update_instance	PUT /api/integrations/instances/{instanceId}	[EXPERIMENTAL] UpdateInstance: Update a single integration instance.
LogsApi	get_integration_log_results	GET /api/logs	[EXPERIMENTAL] GetIntegrationLogResults: Get integration log results
LogsApi	insert_external_logs	POST /api/logs/{instanceid}/{runid}	[EXPERIMENTAL] InsertExternalLogs: Inserts external logs into the specified ExternalApp Integration instance execution
ProcessHistoryApi	create_complete_event	POST /api/process-history/event/complete	[EARLY ACCESS] CreateCompleteEvent: Write a completed event to the Horizon Dashboard
ProcessHistoryApi	create_update_event	POST /api/process-history/event/update	[EARLY ACCESS] CreateUpdateEvent: Write an update event to the Horizon Dashboard
ProcessHistoryApi	get_latest_runs	GET /api/process-history/$latestRuns	[EARLY ACCESS] GetLatestRuns: Get latest run for each process
ProcessHistoryApi	process_entry_updates	POST /api/process-history/entries/$query	[EARLY ACCESS] ProcessEntryUpdates: Get process entry updates for a query
ProcessHistoryApi	process_history_entries	POST /api/process-history/$query	[EARLY ACCESS] ProcessHistoryEntries: Get process history entries
RunsApi	cancel_instance	PUT /api/runs/cancel	[EXPERIMENTAL] CancelInstance: Cancels multiple instance executions.
RunsApi	get_run_results	GET /api/runs	[EXPERIMENTAL] GetRunResults: Get run results
RunsApi	rerun_instance	PUT /api/runs/{runId}/rerun	[EXPERIMENTAL] RerunInstance: Reruns a single instance execution.
RunsApi	stop_instance_execution	PUT /api/runs/{instanceId}/{runId}/stop	[EXPERIMENTAL] StopInstanceExecution: Stops a single instance execution.
TradePublicationFrameworkApi	get_tpf_file_deliveries	GET /api/trade-publication-framework/instances/{instanceId}/deliveries	[EXPERIMENTAL] GetTpfFileDeliveries: Search TPF file deliveries for a specific instance
TradePublicationFrameworkApi	get_tpf_transaction_history_search	GET /api/trade-publication-framework/transactions/search	[EXPERIMENTAL] GetTpfTransactionHistorySearch: Endpoint to search TPF transaction by transaction ID and/or instrument identifier, with filtering by instance and date range
TradePublicationFrameworkApi	get_transaction_payload	GET /api/trade-publication-framework/instances/{instanceId}/runs/{runId}/transactions/{transactionId}/payload	[EXPERIMENTAL] GetTransactionPayload: Transaction payload detail
TradePublicationFrameworkApi	list_failed_deliveries	GET /api/trade-publication-framework/instances/{instanceId}/failed	[EXPERIMENTAL] ListFailedDeliveries: List failed deliveries for a given TPF instance, filtered by resolved state, with pagination support.
TradePublicationFrameworkApi	list_instance_run_history	GET /api/trade-publication-framework/instances/{instanceId}/runs	[EXPERIMENTAL] ListInstanceRunHistory: List run history for a given TPF instance, with pagination support.
TradePublicationFrameworkApi	list_instances_with_status	GET /api/trade-publication-framework/instances	[EXPERIMENTAL] ListInstancesWithStatus: Lists all instances of the Trade Publication Framework (TPF).
TradePublicationFrameworkApi	list_run_files	GET /api/trade-publication-framework/instances/{instanceId}/runs/{runId}/files	[EXPERIMENTAL] ListRunFiles: List Files in a run
TradePublicationFrameworkApi	list_run_transactions	GET /api/trade-publication-framework/instances/{instanceId}/runs/{runId}/transactions	[EXPERIMENTAL] ListRunTransactions: List Transactions in a run.
TradePublicationFrameworkApi	replay_transactions	POST /api/trade-publication-framework/instances/{instanceId}/replay	[EXPERIMENTAL] ReplayTransactions: Replay one or more transactions through a TPF instance
TradePublicationFrameworkApi	resolve_failed_delivery	PUT /api/trade-publication-framework/instances/{instanceId}/failed/{batchReferenceId}/resolve	[EXPERIMENTAL] ResolveFailedDelivery: Resolve a failed delivery without retry
TradePublicationFrameworkApi	retry_failed_delivery	POST /api/trade-publication-framework/instances/{instanceId}/failed/retry	[EXPERIMENTAL] RetryFailedDelivery: Retry failed deliveries for Trade Publication Framework
TradePublicationFrameworkApi	retry_tpf_sftp_delivery	POST /api/trade-publication-framework/instances/{instanceId}/files/{fileId}/retry-sftp	[EXPERIMENTAL] RetryTpfSftpDelivery: Retry SFTP delivery for a previously sent TPF file
VendorApi	get_core_field_mappings_for_product_entity	GET /api/vendor/mappings/fields	[EARLY ACCESS] GetCoreFieldMappingsForProductEntity: Get core field mappings for a given vendor product's entity.
VendorApi	get_optional_mappings_for_product_entity	GET /api/vendor/mappings/optional	[EARLY ACCESS] GetOptionalMappingsForProductEntity: Get a user defined LUSID property mappings for the specified vendor / LUSID entity.
VendorApi	get_property_mappings_for_product_entity	GET /api/vendor/mappings/properties	[EARLY ACCESS] GetPropertyMappingsForProductEntity: Gets the property mappings for a given vendor product's entity
VendorApi	query_vendors	POST /api/vendor/$query	[EARLY ACCESS] QueryVendors: Query for vendors and their packages with entities and sub-entities.
VendorApi	set_optional_mappings_for_product_entity	POST /api/vendor/mappings/optional	[EARLY ACCESS] SetOptionalMappingsForProductEntity: Create a user defined LUSID property mappings for the specified vendor / LUSID entity.
VersionedConfigurationsApi	create_versioned_configuration_draft	POST /api/versionedconfiguration/{configType}/{name}/draft	[EXPERIMENTAL] CreateVersionedConfigurationDraft: Create a draft versioned configuration.
VersionedConfigurationsApi	delete_versioned_configuration_version	DELETE /api/versionedconfiguration/{configType}/{name}/{majorVersion}/{minorVersion}	[EXPERIMENTAL] DeleteVersionedConfigurationVersion: Delete a versioned configuration version.
VersionedConfigurationsApi	get_versioned_configuration	GET /api/versionedconfiguration/{configType}/{name}	[EXPERIMENTAL] GetVersionedConfiguration: Get a versioned configuration.
VersionedConfigurationsApi	get_versioned_configuration_types	GET /api/versionedconfiguration/config-types	[EXPERIMENTAL] GetVersionedConfigurationTypes: List available versioned configuration types.
VersionedConfigurationsApi	list_all_versioned_configurations	GET /api/versionedconfiguration/all	[EXPERIMENTAL] ListAllVersionedConfigurations: List all versioned configurations.
VersionedConfigurationsApi	list_versioned_configurations	GET /api/versionedconfiguration/{configType}	[EXPERIMENTAL] ListVersionedConfigurations: List versioned configurations for a config type.
VersionedConfigurationsApi	lock_versioned_configuration_version	POST /api/versionedconfiguration/{configType}/{name}/{majorVersion}/{minorVersion}/lock	[EXPERIMENTAL] LockVersionedConfigurationVersion: Lock a versioned configuration version.
VersionedConfigurationsApi	update_versioned_configuration_draft	PUT /api/versionedconfiguration/{configType}/{name}/{majorVersion}/{minorVersion}/draft	[EXPERIMENTAL] UpdateVersionedConfigurationDraft: Update a draft versioned configuration.

Documentation for Models

• AllowedParameterValue
• AuditCompleteRequest
• AuditCompleteResponse
• AuditFileDetails
• AuditUpdateRequest
• AuditUpdateResponse
• CancelRunRequest
• CreateInstanceRequest
• CreateVersionedConfigurationDraftRequest
• DestinationResponse
• EnrichmentResponse
• ExecuteInstanceResponse
• ExternalLogInsertionRequest
• ExternalLogRecord
• FailedDeliveryResponse
• FieldMapping
• FileDeliveryStatus
• FileDestinationResponse
• FileDetails
• IFieldMapping
• IIntegrationLogResponse
• IPropertyMapping
• Identifiers
• InstanceDestinations
• InstanceExecutionReferenceId
• InstanceIdentifier
• InstanceResponse
• InstanceRunResponse
• InstancesResponse
• IntegrationCancellationResponse
• IntegrationDescription
• IntegrationInstance
• IntegrationInstanceResponse
• IntegrationLogActivity
• IntegrationLogRecord
• IntegrationLogTargetRecord
• IntegrationPropertyConfiguration
• IntegrationRerunResponse
• IntegrationRunIntegration
• IntegrationRunLog
• IntegrationRunLogLink
• IntegrationRunResponse
• IntegrationRunVersion
• JSchema
• JSchemaType
• Link
• LusidEntity
• LusidField
• LusidProblemDetails
• LusidPropertyDefinition
• LusidPropertyDefinitionOverrides
• LusidPropertyDefinitionOverridesByType
• LusidPropertyDefinitionOverridesResponse
• LusidPropertyToVendorFieldMapping
• LusidValidationProblemDetails
• OnboardInstrumentRequest
• OnboardInstrumentResponse
• OpenFigiData
• OpenFigiParameterOptionName
• OpenFigiPermIdResult
• OpenFigiSearchResult
• PagedResourceListOfFailedDeliveryResponse
• PagedResourceListOfIFieldMapping
• PagedResourceListOfIIntegrationLogResponse
• PagedResourceListOfIPropertyMapping
• PagedResourceListOfInstanceRunResponse
• PagedResourceListOfIntegrationRunResponse
• PagedResourceListOfProcessInformation
• PagedResourceListOfProcessUpdateResult
• PagedResourceListOfRunFileResponse
• PagedResourceListOfTpfFileDeliveryResponse
• PagedResourceListOfTpfTransactionSearchResponse
• PagedResourceListOfTransactionResponse
• PagedResourceListOfVendorProduct
• PermIdData
• PostProcessTask
• ProcessInformation
• ProcessSummary
• ProcessUpdateResult
• ProcessorDescription
• ProcessorSchemaResponse
• PropertyMapping
• QueryRequest
• QuerySpecification
• ReplayOptions
• ReplayTransactionsRequest
• ReplayTransactionsResponse
• ResolveFailedDeliveryRequest
• ResolveFailedDeliveryResponse
• ResourceId
• RowDetails
• RunFileResponse
• TpfFailedDeliveryResponse
• TpfFileDeliveryInfo
• TpfFileDeliveryResponse
• TpfPortfolio
• TpfRetryElementResult
• TpfRetryFailedDeliveryRequest
• TpfRetrySftpResponse
• TpfTransactionSearchResponse
• TransactionPayloadResponse
• TransactionResponse
• Trigger
• UpdateInstanceRequest
• UpdateVersionedConfigurationDraftRequest
• VendorField
• VendorProduct
• VersionedConfigurationResponse
• VersionedConfigurationTypeResponse