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
- Package version: 0.21.5
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Requirements
Installation
npm
npm install @factset/sdk-utils @factset/sdk-contentfeedsdatadictionary@0.21.5
yarn
yarn add @factset/sdk-utils @factset/sdk-contentfeedsdatadictionary@0.21.5
Usage
- Generate authentication credentials.
- Setup Node.js environment
-
Install and activate Node.js >=14. If you're using nvm:
nvm install 16
nvm use 16
-
(optional) Install yarn.
- Install dependencies.
- Run the following:
const { ApiClient, NavigatorApi } = require('@factset/sdk-contentfeedsdatadictionary');
const { ConfidentialClient } = require('@factset/sdk-utils');
const apiClient = ApiClient.instance;
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');
const apiInstance = new NavigatorApi();
const basicSearchRequest = new contentfeedsdatadictionary.BasicSearchRequest();
apiInstance.navigatorBasicSearchPost(basicSearchRequest).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
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
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.