@factset/sdk-contentfeedsdatadictionary

Content Feeds Data Dictionary client library for JavaScript

An API for interacting with CTS Data Dictionary.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

• API version: 0.2
• SDK version: 0.22.0
• Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

Requirements

• Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/sdk-contentfeedsdatadictionary@0.22.0

yarn

yarn add @factset/sdk-utils @factset/sdk-contentfeedsdatadictionary@0.22.0

Usage

1. Generate authentication credentials.
2. Setup Node.js environment

   1. Install and activate Node.js >=18. If you're using nvm:

      nvm install 18
      nvm use 18
      

   2. (optional) Install yarn.

3. Install dependencies.
4. Run the following:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, NavigatorApi } = require('@factset/sdk-contentfeedsdatadictionary');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new NavigatorApi();
const basicSearchRequest = new contentfeedsdatadictionary.BasicSearchRequest(); // BasicSearchRequest | A list of search terms (each term must be at least two characters).

// Call api endpoint
apiInstance.navigatorBasicSearchPost(basicSearchRequest).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Using a Proxy

To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:

const { ApiClient } = require('@factset/sdk-contentfeedsdatadictionary');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[e-mail]:8080');

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/data-dictionary

Class	Method	HTTP request	Description
contentfeedsdatadictionary.NavigatorApi	navigatorBasicSearchPost	POST /navigator/basic_search	Returns the data items (along with the products they belong to) that contain at least one of the search terms as a substring of either their name or description.
contentfeedsdatadictionary.NavigatorApi	navigatorDataItemsProductIdGet	GET /navigator/data_items/{Product_id}	Get the list of data items associated with a product for Navigator.
contentfeedsdatadictionary.NavigatorApi	navigatorProductsGet	GET /navigator/products	Get the list of products for Navigator.
contentfeedsdatadictionary.NavigatorApi	navigatorSourcesDataItemIdGet	GET /navigator/sources/{DataItem_id}	Get a list of sources where the specified data item can be found, for each delivery method, filtered to the appearances of the given data item within the specified product.
contentfeedsdatadictionary.NavigatorApi	navigatorSourcesGet	GET /navigator/sources	Get a list of sources by delivery method for the given product_id
contentfeedsdatadictionary.NavigatorApi	navigatorTableFieldsTableIdGet	GET /navigator/table_fields/{Table_id}	Get the list of fields associated with a table for Navigator, and the code information for the specified data item, if applicable.

Documentation for Models

• contentfeedsdatadictionary.ApiEndpoint
• contentfeedsdatadictionary.BasicSearchRequest
• contentfeedsdatadictionary.BasicSearchResponse
• contentfeedsdatadictionary.BasicSearchResponseResults
• contentfeedsdatadictionary.DataItem
• contentfeedsdatadictionary.NavigatorSourcesResponse
• contentfeedsdatadictionary.Product
• contentfeedsdatadictionary.ReferenceGroup
• contentfeedsdatadictionary.Table
• contentfeedsdatadictionary.TableCodeFieldInfoResponse
• contentfeedsdatadictionary.TableCodeInfo
• contentfeedsdatadictionary.TableField

Documentation for Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.