FactSet.SDK.FactSetConcordance
0.23.0
Prefix Reserved
See the version list below for details.
dotnet add package FactSet.SDK.FactSetConcordance --version 0.23.0
NuGet\Install-Package FactSet.SDK.FactSetConcordance -Version 0.23.0
<PackageReference Include="FactSet.SDK.FactSetConcordance" Version="0.23.0" />
paket add FactSet.SDK.FactSetConcordance --version 0.23.0
#r "nuget: FactSet.SDK.FactSetConcordance, 0.23.0"
// Install FactSet.SDK.FactSetConcordance as a Cake Addin #addin nuget:?package=FactSet.SDK.FactSetConcordance&version=0.23.0 // Install FactSet.SDK.FactSetConcordance as a Cake Tool #tool nuget:?package=FactSet.SDK.FactSetConcordance&version=0.23.0
FactSet Concordance client library for .NET
The FactSet Concordance API enables Application Developers and Data Scientists to programmatically discover the FactSet Identifier for a specific Entity or Person based on attributes, such as name, URL, and location.FactSet Identifiers are mapped to industry-standard identifiers, as well as to a comprehensive set of reference data and unique content, to enhance the ability to quickly connect content sets.<p>
Using the submitted attributes, the FactSet Concordance API leverages FactSet’s extensive Entity Master, People, and Symbology databases to return potential candidate matches and a proposed match. The result is a concorded FactSet Identifier that can then be used as input throughout FactSet's expanding catalog of Content using our Content APIs or Standard DataFeeds.</p>
<b>There are two types of workflows supported in the API:</b>
<b>Entity & People Match:</b> The first workflow follows traditional API conventions in that a request is accepted and a response is returned synchronously enabling the concordance of up to 25 names in a single request. The response returns a list of 20 candidates as well as a proposed match.
<b>Entity & People Match - Bulk:</b> The second workflow allows you to input a large list of names within a .CSV file in a single request With this workflow, a task is created for uploading a set of queries. Once the task has completed, the client retrieves the concordance results through the /entity-decisions or /people-decisions endpoint. Note that in the Bulk workflow, only the matches for the records are returned. Candidates are not included.
Once the service has provided a list of concorded FactSet Identifiers, you can then use our Entity Mappings and People Mappings endpoints to further review the universe of mapped identifiers or modify existing records. </p>
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 2.6.0
- Package version: 0.23.0
- Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen
Requirements
- .NET Standard >= 2.0
Installation
.NET CLI
dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.FactSetConcordance
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetConcordance
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- Run the following:
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.FactSetConcordance.Api;
using FactSet.SDK.FactSetConcordance.Client;
using FactSet.SDK.FactSetConcordance.Model;
namespace Example
{
public static class GetEntityMappingDeleteForListExample
{
public static async Task Main()
{
var config = new FactSet.SDK.FactSetConcordance.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
// 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 EntityMappingsApi(config);
var entityMappingDeleteRequest = new EntityMappingDeleteRequest(); // EntityMappingDeleteRequest | A request to delete entity mappings specified by the client
try
{
// Deletes mapping specified by the client.
EntityMappingDeleteResponse result = apiInstance.GetEntityMappingDeleteForList(entityMappingDeleteRequest);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling EntityMappingsApi.GetEntityMappingDeleteForList: " + 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 https://api.factset.com/content
Class | Method | HTTP request | Description |
---|---|---|---|
EntityMappingsApi | GetEntityMappingDeleteForList | POST /factset-concordance/v2/entity-mapping-delete | Deletes mapping specified by the client. |
EntityMappingsApi | GetEntityMappingForList | POST /factset-concordance/v2/entity-mapping | Saves a single-mapping specified by the client. |
EntityMappingsApi | GetEntityUniverse | GET /factset-concordance/v2/entity-universe | Retrieve all saved mappings within a requested universe |
EntityMappingsApi | GetEntityUniverseForList | POST /factset-concordance/v2/entity-universe | Retrieve all saved mappings within a requested universe or large list of client ids |
EntityMatchApi | GetEntityMatch | GET /factset-concordance/v2/entity-match | Get Entity Candidates and Matches for a single name and attributes. |
EntityMatchApi | GetEntityMatchForList | POST /factset-concordance/v2/entity-match | Get a list of Entity Candidates and Matches for a requested list of up to 25 names and attributes. |
EntityMatchBulkApi | GetEntityDecisions | GET /factset-concordance/v2/entity-decisions | Get the decisions of matches for the requested taskId. |
EntityMatchBulkApi | GetEntityTaskForList | POST /factset-concordance/v2/entity-task | Input a file with names and attributes, creating a taskId. |
EntityMatchBulkApi | GetEntityTaskStatus | GET /factset-concordance/v2/entity-task-status | Gets the status of the requested taskId or all tasks for a User |
PeopleMappingApi | GetPeopleMappingDeleteForList | POST /factset-concordance/v2/people-mapping-delete | Deletes mapping specified by the client. |
PeopleMappingApi | GetPeopleMappingForList | POST /factset-concordance/v2/people-mapping | Saves a single-mapping specified by the client. |
PeopleMappingApi | GetPeopleUniverse | GET /factset-concordance/v2/people-universe | Retrieve all saved mappings within a requested universe |
PeopleMappingApi | GetPeopleUniverseForList | POST /factset-concordance/v2/people-universe | Retrieve all saved mappings within a requested universe or large list of client ids |
PeopleMatchApi | GetPeopleMatch | GET /factset-concordance/v2/people-match | Find potential people matches given a person's name.People matches can be retrieved using person's name and other attributes like firstname, middlename and lastname. |
PeopleMatchApi | GetPeopleMatchForList | POST /factset-concordance/v2/people-match | Find potential people matches given a person's name. |
PeopleMatchBulkApi | GetPeopleDecisions | GET /factset-concordance/v2/people-decisions | Get the decisions of matches for the requested taskId. |
PeopleMatchBulkApi | GetPeopleTaskForList | POST /factset-concordance/v2/people-task | Create a People Concordance Task. |
PeopleMatchBulkApi | GetPeopleTaskStatus | GET /factset-concordance/v2/people-task-status | Get the Status of the People Tasks. |
SnowflakeApi | GetSnowflakeEntityMatchForList | POST /factset-concordance/v2/snowflake-entity-match | Perform an entity search and return a snowflake-friendly response. Up to 25 Names per request. |
SnowflakeApi | SnowflakeEntityMappingPost | POST /factset-concordance/v2/snowflake-entity-mapping | Save entity mappings to a universe |
UniversesApi | GetEntityUniverseStatistics | GET /factset-concordance/v2/entity-universe-statistics | Get statistics on a given universe |
UniversesApi | GetUniverseForList | POST /factset-concordance/v2/universe | Create a new universe |
UniversesApi | GetUniverseStatistics | GET /factset-concordance/v2/universe-statistics | Get statistics on a given universe |
UniversesApi | GetUniverses | GET /factset-concordance/v2/universes | Fetch metadata for universes |
UniversesApi | GetUpdateUniverseForList | POST /factset-concordance/v2/update-universe | Update metadata for an existing universe |
Documentation for Models
- Model.CreateUniverseRequest
- Model.EntityDecisionsResponse
- Model.EntityMapping
- Model.EntityMappingDeleteRequest
- Model.EntityMappingDeleteResponse
- Model.EntityMappingRequest
- Model.EntityMappingResponse
- Model.EntityMatch
- Model.EntityMatchRequest
- Model.EntityMatchRequestInput
- Model.EntityMatchesResponse
- Model.EntityResponse
- Model.EntityTaskResponse
- Model.EntityTaskStatus
- Model.EntityTaskStatusResponse
- Model.EntityUniverseRequest
- Model.EntityUniverseResponse
- Model.EntityUniverseStatisticsResponse
- Model.ErrorResponse
- Model.ErrorResponseSubErrors
- Model.MapStatus
- Model.PeopleDecisions
- Model.PeopleDecisionsResponse
- Model.PeopleMapping
- Model.PeopleMappingDeleteResponse
- Model.PeopleMappingRequest
- Model.PeopleMappingResponse
- Model.PeopleMatch
- Model.PeopleMatchRequest
- Model.PeopleMatchRequestInput
- Model.PeopleMatchesResponse
- Model.PeopleTask
- Model.PeopleTaskResponse
- Model.PeopleTaskStatus
- Model.PeopleTaskStatusResponse
- Model.PeopleUniverseRequest
- Model.PeopleUniverseResponse
- Model.SnowflakeEntityMappingRequest
- Model.SnowflakeEntityMappingResponse
- Model.SnowflakeEntityMatchRequest
- Model.SnowflakeEntityMatchResponse
- Model.Universe
- Model.UniverseMeta
- Model.UniverseMetaResponse
- Model.UniverseStatistics
- Model.UniverseStatisticsResponse
- Model.UniversesResponse
- Model.UpdateUniverseRequest
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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- FactSet.SDK.Utils (>= 1.0.0)
- JsonSubTypes (>= 1.8.0)
- Newtonsoft.Json (>= 13.0.1)
- Polly (>= 7.2.2)
- RestSharp (>= 106.15.0)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0 | 71 | 10/30/2024 |
0.24.5 | 103 | 7/18/2024 |
0.24.4 | 98 | 7/11/2024 |
0.24.3 | 116 | 4/10/2024 |
0.24.2 | 188 | 12/29/2023 |
0.24.1 | 221 | 10/25/2023 |
0.24.0 | 155 | 9/12/2023 |
0.23.4 | 176 | 8/30/2023 |
0.23.3 | 138 | 8/11/2023 |
0.23.2 | 172 | 6/6/2023 |
0.23.1 | 189 | 5/11/2023 |
0.23.0 | 213 | 4/25/2023 |
0.22.0 | 197 | 4/12/2023 |
0.21.6 | 270 | 3/1/2023 |
0.21.5 | 279 | 2/24/2023 |
0.21.4 | 315 | 12/13/2022 |
0.21.3 | 359 | 11/3/2022 |
0.21.2 | 399 | 10/24/2022 |
0.21.1 | 414 | 8/31/2022 |
0.21.0 | 435 | 7/21/2022 |
0.20.1 | 444 | 6/1/2022 |
0.20.0 | 425 | 5/24/2022 |
0.9.1 | 461 | 2/14/2022 |
0.9.0 | 451 | 2/2/2022 |
0.8.4 | 406 | 8/31/2022 |
0.8.3 | 423 | 7/21/2022 |
0.8.2 | 420 | 5/24/2022 |
0.8.1 | 446 | 2/14/2022 |
0.8.0 | 460 | 2/2/2022 |
Refer to Changelog on GitHub source repository