IRN Notes client library for .NET
$ dotnet add package FactSet.SDK.IRNNotesAllows users to extract, create, update and configure IRN data.
This .NET package is automatically generated by the OpenAPI Generator project:
dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.IRNNotes -v 2.0.7
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.IRNNotes -Version 2.0.7
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.IRNNotes.Api;
using FactSet.SDK.IRNNotes.Client;
using FactSet.SDK.IRNNotes.Model;
namespace Example
{
public static class CreateAttachmentExample
{
public static async Task Main()
{
var config = new FactSet.SDK.IRNNotes.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 AttachmentsApi(config);
var noteId = "noteId_example"; // Guid |
var file = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt")); // System.IO.Stream |
try
{
// Create an attachment for an existing note
NewItemDto result = apiInstance.CreateAttachment(noteId, file);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling AttachmentsApi.CreateAttachment: " + e.Message );
Console.WriteLine("Status Code: "+ e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
}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;All URIs are relative to https://api.factset.com/research/irn
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AttachmentsApi | CreateAttachment | POST /v1/notes/{noteId}/attachments | Create an attachment for an existing note |
| AttachmentsApi | DownloadAttachment | GET /v1/notes/{noteId}/attachments/{attachmentId}/download | Download an attachment from a Note |
| AttachmentsApi | GetAttachments | GET /v1/notes/{noteId}/attachments | Get all the attachments belonging to a note |
| AttachmentsApi | SoftDeleteNoteAttachment | DELETE /v1/notes/{noteId}/attachments/{attachmentId} | Delete attachment from note |
| CommentsApi | CreateComment | POST /v1/notes/{noteId}/comments | Create a comment to a Note |
| CommentsApi | CreateCommentAttachment | POST /v1/notes/{noteId}/comments/{commentId}/attachments | Create a comment attachment to a Note |
| CommentsApi | DeleteComment | DELETE /v1/notes/{noteId}/comments/{commentId} | Delete a Comment from a Note |
| CommentsApi | DownloadCommentAttachmentForComment | GET /v1/notes/{noteId}/comments/{commentId}/attachments/{attachmentId}/download | Download single attachment detail of a comment belonging to a note |
| CommentsApi | GetComment | GET /v1/notes/{noteId}/comments/{commentId} | Get details of a comment belonging to a note |
| CommentsApi | GetCommentAttachments | GET /v1/notes/{noteId}/comments/{commentId}/attachments | Get attachments summary of a comment belonging to a note |
| CommentsApi | GetComments | GET /v1/notes/{noteId}/comments | Get all comments for a note |
| CommentsApi | PatchComment | PATCH /v1/notes/{noteId}/comments/{commentId} | Edit a comment for a note |
| EventsApi | GetAllEvents | GET /v1/events | Get all the record events in the specified date range filtered on the given types |
| EventsApi | GetEvents | GET /v1/notes/{noteId}/events | Get all the record events that belong to a note |
| EventsApi | GetRecordEvent | GET /v1/notes/{noteId}/events/{recordEventId} | Get details of a record event of a note |
| IdentifiersApi | GetIdentifiers | GET /v1/identifiers | Get all the identifier details for given identifiers |
| NotesApi | CreateNote | POST /v1/notes | Create a note |
| NotesApi | DeleteNote | DELETE /v1/notes/{noteId} | Delete a Note |
| NotesApi | GetNote | GET /v1/notes/{noteId} | Get details of a note |
| NotesApi | GetNotes | GET /v1/notes | Get all the notes in the specified date range filtered on the given identifiers |
| NotesApi | UpdateNote | PUT /v1/notes/{noteId} | Update a note |
Please refer to the contributing guide.
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.