@factset/sdk-vermilion

Vermilion client library for JavaScript

Documentation on all available end points in the VRSAPI

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

• API version: 1.0.0
• SDK version: 1.1.0
• Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

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

Requirements

• Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-vermilion@1.1.0

yarn

yarn add @factset/sdk-utils @factset/sdk-vermilion@1.1.0

Usage

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

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

      nvm install 16
      nvm use 16

   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, DatasourceApi } = require('@factset/sdk-vermilion');
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 DatasourceApi();
const tenant = TENANT; // String | The code of the tenancy
const opts = {
  'sort': ["name"], // [String] | The column to sort on. Append - to sort in descending order. If parameter is not given, no sorting will be done
  'paginationLimit': 10, // Number | Non-negative maximum number of entries to return. Default is 25
  'paginationOffset': 0 // Number | Non-negative number of entries to skip. Default is 0
};

// Call api endpoint
apiInstance.getAllDataSources(tenant, opts).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 http://localhost

Class	Method	HTTP request	Description
vermilion.DatasourceApi	getAllDataSources	GET /v1/{tenant}/data-sources	Lists all datasources
vermilion.DatasourceApi	getDataSourceByCode	GET /v1/{tenant}/data-sources/{dataSourceCode}	Gets a datasource
vermilion.DatasourceApi	getDataSourceData	GET /v1/{tenant}/data-sources/{dataSourceCode}/data	Gets the data for the datasource
vermilion.EntityApi	getEntityValuesByCode	GET /v1/{tenant}/entities/{entityCode}/values	Gets the entity values
vermilion.ReportApi	getAllReportDefinitions	GET /v1/{tenant}/reports	Gets all report definitions
vermilion.ReportApi	getReportDefinitionByCode	GET /v1/{tenant}/reports/{reportDefinitionCode}	Gets a report definition
vermilion.ReportInstanceApi	cancelReportGeneration	DELETE /v1/{tenant}/report-instances/{reportInstanceId}	Cancels a report generation
vermilion.ReportInstanceApi	downloadReportFile	GET /v1/{tenant}/report-instances/{reportInstanceId}/results/{reportFileName}	Gets the generated file
vermilion.ReportInstanceApi	getAllReportInstances	GET /v1/{tenant}/report-instances	Gets a list of report instances
vermilion.ReportInstanceApi	getReportGenerationLogs	GET /v1/{tenant}/report-instances/{reportInstanceId}/logs	Gets a list of logs for the report instance generation
vermilion.ReportInstanceApi	getReportInstanceById	GET /v1/{tenant}/report-instances/{reportInstanceId}	Gets a report instance based on the ID
vermilion.ReportInstanceApi	startReportGeneration	POST /v1/report-instances/generate	Generates a report
vermilion.SCIMApi	createGroup	POST /scim/v2/Groups	Creates a role
vermilion.SCIMApi	createUser	POST /scim/v2/Users	Creates a user
vermilion.SCIMApi	deleteGroupById	DELETE /scim/v2/Groups/{groupId}	Deletes a VRS role
vermilion.SCIMApi	deleteUserById	DELETE /scim/v2/Users/{userId}	Deletes a VRS user
vermilion.SCIMApi	getAllGroups	GET /scim/v2/Groups	Retrieves a list of VRS role
vermilion.SCIMApi	getAllUsers	GET /scim/v2/Users	Retrieves a list of VRS users
vermilion.SCIMApi	getGroupById	GET /scim/v2/Groups/{groupId}	Retrieves a VRS role
vermilion.SCIMApi	getUserById	GET /scim/v2/Users/{userId}	Retrieves a VRS User
vermilion.SCIMApi	patchGroupById	PATCH /scim/v2/Groups/{groupId}	Add or remove a user to/from a group
vermilion.SCIMApi	patchUserById	PATCH /scim/v2/Users/{userId}	Add or remove VRS user attributes
vermilion.SCIMApi	updateGroupById	PUT /scim/v2/Groups/{groupId}	Updates a VRS Group
vermilion.SCIMApi	updateUserById	PUT /scim/v2/Users/{userId}	Updates a VRS user
vermilion.VersionApi	getVersion	GET /v1/version	Gets the version of VRS,WRS and DBServer

Documentation for Models

• vermilion.CreateScimUserJSONRequest
• vermilion.CreatedScimUserJSONResponse
• vermilion.CreatedScimUserJSONResponseMeta
• vermilion.DataSourceAllData
• vermilion.DataSourceDTO
• vermilion.DataSourceData
• vermilion.DataSourceDataInstance
• vermilion.DataSourceInstance
• vermilion.DataSourceInstanceRows
• vermilion.DataSourceList
• vermilion.DataSourceListMeta
• vermilion.DataSourceListMetaPagination
• vermilion.EntityDTO
• vermilion.EntityFieldValueDTO
• vermilion.EntitySelection
• vermilion.Error
• vermilion.ErrorList
• vermilion.RecordSetFieldValues
• vermilion.RecordSetFields
• vermilion.ReportDefinitionDTO
• vermilion.ReportDefinitionData
• vermilion.ReportDefinitionList
• vermilion.ReportGenerationRequest
• vermilion.ReportGenerationRequestBody
• vermilion.ReportInstanceDTO
• vermilion.ReportInstanceData
• vermilion.ReportInstanceDataResponse
• vermilion.ReportInstanceId
• vermilion.ReportInstanceList
• vermilion.ReportInstanceListMeta
• vermilion.ReportInstanceLogDTO
• vermilion.ReportInstanceLogList
• vermilion.ReportRevisionDTO
• vermilion.ScimEmail
• vermilion.ScimError
• vermilion.ScimGroup
• vermilion.ScimGroupListResponse
• vermilion.ScimGroupMember
• vermilion.ScimGroupPatchOperation
• vermilion.ScimGroupPatchOperationValue
• vermilion.ScimGroupPatchRequestBody
• vermilion.ScimMeta
• vermilion.ScimPhone
• vermilion.ScimPhoto
• vermilion.ScimUser
• vermilion.ScimUserGroup
• vermilion.ScimUserListResponse
• vermilion.ScimUserName
• vermilion.ScimUserPatchOperation
• vermilion.ScimUserPatchRequestBody
• vermilion.Tenancy
• vermilion.VersionResponseBody
• vermilion.VersionResponseBodyData

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.