@factset/sdk-universalscreening

Universal Screening client library for JavaScript

Through the Universal Screening API, you can access the power of FactSet's Universal Screening Application. Calculate and return the results of your saved Universal Screens.

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

• API version: 2.0.2
• SDK version: 2.0.0
• Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

• Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/sdk-universalscreening@2.0.0

yarn

yarn add @factset/sdk-utils @factset/sdk-universalscreening@2.0.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, JobManagementApi } = require('@factset/sdk-universalscreening');
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 JobManagementApi();
const id = 123e4567-e89b-12d3-a456-426655440000; // String | Unique identifier for a job. \"Job\" refers to a screen calculation or archival.

// Call api endpoint
apiInstance.deleteActiveJob(id).then(
  () => {
    console.log('API called successfully.');
  },
  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-universalscreening');

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

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/universal-screening/v2

Class	Method	HTTP request	Description
universalscreening.JobManagementApi	deleteActiveJob	DELETE /job/{id}
universalscreening.JobManagementApi	deleteAllActiveJobs	DELETE /jobs
universalscreening.JobManagementApi	getAllActiveJobs	GET /jobs
universalscreening.ScreeningOperationsApi	getCalculateResults	GET /job/{id}
universalscreening.ScreeningOperationsApi	pollCalculate	GET /job/{id}/status
universalscreening.ScreeningOperationsApi	submitArchiveOFDB	POST /job/archive
universalscreening.ScreeningOperationsApi	submitCalculate	POST /job/calculate

Documentation for Models

• universalscreening.ActiveJobIDs
• universalscreening.ActiveJobsData
• universalscreening.ErrorArray
• universalscreening.ErrorCode
• universalscreening.ErrorObject
• universalscreening.ErrorObjectSource
• universalscreening.PaginatedCalculationResponse
• universalscreening.PaginationResponse
• universalscreening.ResourceStatusResponse
• universalscreening.ResourceStatusResponseData
• universalscreening.ResultsMetadata
• universalscreening.ScreenArchiveOFDBParameters
• universalscreening.ScreenArchiveOFDBParametersData
• universalscreening.ScreenArchiveOFDBParametersDataArchiveOptions
• universalscreening.ScreenCalcParameters
• universalscreening.ScreenCalcParametersData

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.