What is a Data Source?

When distributing Apiro data, a data source is used specify what data should be distributed. The most common data source in Apiro is schema data. Data Sources tell Apiro where to source the data that should be distributed.

Data Source config?

Global Data Source entity (defined in its own config file and can be referenced by multiple feeds)
Local datasource entity

<?xml version="1.0" encoding="UTF-8"?>
<apiroConf version="1" xmlns="http://apiro.com/apiro/v1/root">
    <loadOrder>10</loadOrder>
    <dataSources>
        <dataSource definition="REST" execPriority="10" name="OPEN_FIGI_REST">
            <metaData>
                <item name="KEY">
                    <simpleValues>VAL_A VAL_B</simpleValues>
                </item>
            </metaData>
            <description/>
            <config>
                <![CDATA[
                      {
                          "url" : "https://api.openfigi.com/v3/mapping",
                          "method" : "POST",
                          "headers" : {
                            "X-OPENFIGI-APIKEY" : "${SYS:OPENFIGI_KEY}",
                            "Content-Type" : "application/json"
                          },
                          "jsonPayloadArray" : [ {
                            "idType" : "ID_ISIN",
                            "idValue" : "US4592001014"
                          }, {
                            "exchCode" : "AU"
                          } ]
                      }
]]>
            </config>
            <abstract>false</abstract>
            <inheritable>true</inheritable>
            <execPredicate>#GRV{ true }</execPredicate>
        </dataSource>
    </dataSources>
</apiroConf>

The provided XML configuration defines a data source named "OPEN_FIGI_REST" within a larger configuration structure, designed for accessing data from the OpenFIGI API. This data source is part of a broader system used for mapping financial instruments to their FIGI (Financial Instrument Global Identifier) identifiers.

Here's a breakdown of the key components and their purposes:

dataSources: Contains the definition of one or more data sources, which are components that provide access to data from various sources. dataSource definition="REST" execPriority="10" name="OPEN_FIGI_REST": Defines a specific data source named "OPEN_FIGI_REST" with a definition of "REST". This definition is designed to handle RESTful API requests. config: Contains the configuration details for the data source, enclosed within a CDATA section to ensure that the JSON-like structure is treated as plain text. This configuration includes: "url": Specifies the URL of the API endpoint. "method": The HTTP method to use for the request, in this case, "POST". "headers": Contains HTTP headers to be included in the request, such as the API key and content type. "jsonPayloadArray": An array of JSON objects that represent the payload to be sent with the request, including the instrument ID type and value, and an exchange code. abstract: Indicates whether the data source is abstract, which might affect how it's used or instantiated within the system. inheritable: Specifies whether the data source can be inherited by other configurations or components. execPredicate: A predicate that determines under what conditions the data source should be executed, in this case, always true.

This data source uses the REST definition, meaning it is sourcing from a rest endpoint. for a full list of all data source definitions, see data source definitions.

Inline/Local (defined in a feed config and can only exist with the feed. It cannot be referenced by other Feeds)

Data Source Definitions

Provide an exmaple of a full REST data source with all options as an xml

Provide an example of the UI showing a REST data source which is an inline entity