irncontacts.ContactsApi

All URIs are relative to https://api.factset.com/research/irn

Method	HTTP request	Description
createContact	POST /v1/contacts	Create a contact
deleteContact	DELETE /v1/contacts/{contactId}	Delete a contact
getContact	GET /v1/contacts/{contactId}	Get all custom field and standard field details on a specific contact
getContactEvents	GET /v1/contacts/{contactId}/events	Get a contact’s audit history
getContactNotes	GET /v1/contacts/{contactId}/about	Get the About field content for a specific contact
getContactRecords	GET /v1/contacts/{contactId}/records	Get all notes and meetings where a specific contact was tagged
getContactRelationships	GET /v1/contacts/{contactId}/relationships	Returns a list of a contact’s relationships
getContacts	GET /v1/contacts	Get list of all contacts in your group along with some of their standard field data
patchContact	PATCH /v1/contacts/{contactId}	Edit a contact’s standard field and custom field data

createContact

NewItemDto createContact(opts)

Create a contact

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const opts = {
  'contactSaveDto': new irncontacts.ContactSaveDto() // ContactSaveDto | contactSaveDto object to save
};

// Call api endpoint
apiInstance.createContact(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
contactSaveDto	ContactSaveDto	contactSaveDto object to save	[optional]

Return type

NewItemDto

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: application/json

deleteContact

deleteContact(contactId)

Delete a contact

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const contactId = "contactId_example"; // String | contactId to delete associated record

// Call api endpoint
apiInstance.deleteContact(contactId).then(
  () => {
    console.log('API called successfully.');
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
contactId	String	contactId to delete associated record

Return type

null (empty response body)

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getContact

ContactDto getContact(contactId)

Get all custom field and standard field details on a specific contact

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const contactId = "contactId_example"; // String | contactId to get associated record

// Call api endpoint
apiInstance.getContact(contactId).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
contactId	String	contactId to get associated record

Return type

ContactDto

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getContactEvents

[ContactEventDto] getContactEvents(contactId)

Get a contact’s audit history

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const contactId = "contactId_example"; // String | contactId to get associated records

// Call api endpoint
apiInstance.getContactEvents(contactId).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
contactId	String	contactId to get associated records

Return type

[ContactEventDto]

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getContactNotes

String getContactNotes(contactId)

Get the About field content for a specific contact

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const contactId = "contactId_example"; // String | contactId of associated record

// Call api endpoint
apiInstance.getContactNotes(contactId).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
contactId	String	contactId of associated record

Return type

String

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getContactRecords

[RecordPreviewDto] getContactRecords(contactId)

Get all notes and meetings where a specific contact was tagged

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const contactId = "contactId_example"; // String | contactId to get associated records

// Call api endpoint
apiInstance.getContactRecords(contactId).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
contactId	String	contactId to get associated records

Return type

[RecordPreviewDto]

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getContactRelationships

[ContactRelationshipDto] getContactRelationships(contactId)

Returns a list of a contact’s relationships

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const contactId = "contactId_example"; // String | contactId to get associated records

// Call api endpoint
apiInstance.getContactRelationships(contactId).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
contactId	String	contactId to get associated records

Return type

[ContactRelationshipDto]

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

getContacts

[ContactSummaryDto] getContacts(opts)

Get list of all contacts in your group along with some of their standard field data

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const opts = {
  'fullName': "fullName_example", // String | Filter results on fullName
  'emailAddress': "emailAddress_example", // String | Filter results on emailAddress
  'identifier': "identifier_example", // String | Filter results on identifier
  'employerName': "employerName_example", // String | Filter results on employerName
  'customFieldValues': false, // Boolean | Includes custom field values in response if true
  'search': "search_example", // String | Filter results on the combination of fullName, emailAddress, identifier and employerName
  'sort': "sort_example", // String | 
  'includeLastMeetingDate': false, // Boolean | If true, returns when they were last tagged as an attendee in an IRN meeting
  'limit': 0 // Number | Restrict number of records returned
};

// Call api endpoint
apiInstance.getContacts(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
fullName	String	Filter results on fullName	[optional]
emailAddress	String	Filter results on emailAddress	[optional]
identifier	String	Filter results on identifier	[optional]
employerName	String	Filter results on employerName	[optional]
customFieldValues	Boolean	Includes custom field values in response if true	[optional] [default to false]
search	String	Filter results on the combination of fullName, emailAddress, identifier and employerName	[optional]
sort	String		[optional]
includeLastMeetingDate	Boolean	If true, returns when they were last tagged as an attendee in an IRN meeting	[optional] [default to false]
limit	Number	Restrict number of records returned	[optional] [default to 0]

Return type

[ContactSummaryDto]

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

patchContact

patchContact(contactId, opts)

Edit a contact’s standard field and custom field data

Example

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, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const contactId = "contactId_example"; // String | contactId to update associated record
const opts = {
  'operation': [new irncontacts.Operation()] // [Operation] | contactSaveDtoPatch object to update
};

// Call api endpoint
apiInstance.patchContact(contactId, opts).then(
  () => {
    console.log('API called successfully.');
  },
  error => {
    console.error(error);
  },
);

Parameters

Name	Type	Description	Notes
contactId	String	contactId to update associated record
operation	[Operation]	contactSaveDtoPatch object to update	[optional]

Return type

null (empty response body)

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: application/json

Files

ContactsApi.md

Latest commit

History

ContactsApi.md

File metadata and controls

irncontacts.ContactsApi

createContact

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

deleteContact

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getContact

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getContactEvents

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getContactNotes

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getContactRecords

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getContactRelationships

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

getContacts

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers

patchContact

Example

Example Code

Parameters

Return type

Authorization

HTTP request headers