FactSet.SDK.Vermilion 1.2.0

Vermilion client library for .NET

Documentation on all available end points in the VRSAPI

This .NET package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• SDK version: 1.2.0
• Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

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

Requirements

• .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.Vermilion -v 1.2.0

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.Vermilion -Version 1.2.0

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
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

using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.Vermilion.Api;
using FactSet.SDK.Vermilion.Client;
using FactSet.SDK.Vermilion.Model;

namespace Example
{
    public static class GetAllDataSourcesExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.Vermilion.Client.Configuration();

            // 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-dotnet#authentication
            // for more information on using the ConfidentialClient class
            ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
            config.OAuth2Client = confidentialClient;

            /* Basic authentication: FactSetApiKey */
            // See https://github.com/FactSet/enterprise-sdk#api-key
            // for information how to create an API key
            // config.Username = "USERNAME-SERIAL";
            // config.Password = "API-KEY";

            var apiInstance = new DatasourceApi(config);
            var tenant = "TENANT";  // string | The code of the tenancy
            var sort = new List<string>(); // List<string> | The column to sort on. Append - to sort in descending order. If parameter is not given, no sorting will be done (optional) 
            var paginationLimit = 25;  // int? | Non-negative maximum number of entries to return. Default is 25 (optional)  (default to 25)
            var paginationOffset = 0;  // int? | Non-negative number of entries to skip. Default is 0 (optional)  (default to 0)

            try
            {
                // Lists all datasources
                DataSourceList result = apiInstance.GetAllDataSources(tenant, sort, paginationLimit, paginationOffset);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling DatasourceApi.GetAllDataSources: " + e.Message );
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
        }
    }
}

Using a Proxy

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation for Models

• Model.CreateScimUserJSONRequest
• Model.CreatedScimUserJSONResponse
• Model.CreatedScimUserJSONResponseMeta
• Model.DataSourceAllData
• Model.DataSourceDTO
• Model.DataSourceData
• Model.DataSourceDataInstance
• Model.DataSourceInstance
• Model.DataSourceInstanceRows
• Model.DataSourceList
• Model.DataSourceListMeta
• Model.DataSourceListMetaPagination
• Model.EntityDTO
• Model.EntityFieldValueDTO
• Model.EntitySelection
• Model.Error
• Model.ErrorList
• Model.GenerateScheduleResponse
• Model.RecordSetFieldValues
• Model.RecordSetFields
• Model.ReportDefinitionDTO
• Model.ReportDefinitionData
• Model.ReportDefinitionList
• Model.ReportGenerationRequest
• Model.ReportGenerationRequestBody
• Model.ReportInstanceDTO
• Model.ReportInstanceData
• Model.ReportInstanceDataResponse
• Model.ReportInstanceId
• Model.ReportInstanceList
• Model.ReportInstanceListMeta
• Model.ReportInstanceLogDTO
• Model.ReportInstanceLogList
• Model.ReportRevisionDTO
• Model.ScheduleData
• Model.ScheduleDefinition
• Model.ScheduleDefinitionOwnerRole
• Model.ScheduleDefinitionsList
• Model.ScheduleGenerationLog
• Model.ScheduleGenerationLogList
• Model.ScheduleInstanceData
• Model.ScheduleStatusUpdateResponse
• Model.SchedulesList
• Model.ScimEmail
• Model.ScimError
• Model.ScimGroup
• Model.ScimGroupListResponse
• Model.ScimGroupMember
• Model.ScimGroupPatchOperation
• Model.ScimGroupPatchOperationValue
• Model.ScimGroupPatchRequestBody
• Model.ScimMeta
• Model.ScimPhone
• Model.ScimPhoto
• Model.ScimUser
• Model.ScimUserGroup
• Model.ScimUserListResponse
• Model.ScimUserName
• Model.ScimUserPatchOperation
• Model.ScimUserPatchRequestBody
• Model.Tenancy
• Model.VersionResponseBody
• Model.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.