Class NSListAgent

Collection of all services that work with Lists. These are typical lists of data shown in dropdown-list, checkbox lists, etc.

Syntax

Examples

NSListAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSListAgent()

Collection of all services that work with Lists. These are typical lists of data shown in dropdown-list, checkbox lists, etc.

Introduced or updated in version: 7

Declaration

NSListAgent

Examples

NSListAgent agent;
agent.callMethod(arg1, arg2);

Methods

AddFromListDefinition(Integer,NSListItemEntity)

Saves a new list item for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity AddFromListDefinition(Integer udListDefinitionId, NSListItemEntity item)

Parameters

Type	Name	Description
Integer	udListDefinitionId
NSListItemEntity	item

Returns

Type	Description
NSListItemEntity

Examples

NSListAgent agent;
Integer udListDefinitionId;
NSListItemEntity item;
NSListItemEntity res = agent.AddFromListDefinition(udListDefinitionId, item);

AddFromListName(String,NSListItemEntity)

Saves a new list item for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity AddFromListName(String udListDefinitionName, NSListItemEntity item)

Parameters

Type	Name	Description
String	udListDefinitionName
NSListItemEntity	item

Returns

Type	Description
NSListItemEntity

Examples

NSListAgent agent;
String udListDefinitionName;
NSListItemEntity item;
NSListItemEntity res = agent.AddFromListName(udListDefinitionName, item);

AddHierarchyToPath(Integer,String,String)

Adds a hierarchy item to a path

Introduced or updated in version: 7

Declaration

NSHierarchyEntity AddHierarchyToPath(Integer domain, String path, String name)

Parameters

Type	Name	Description
Integer	domain	See Domain.
String	path	Hierarchy path to parent item
String	name	Name of node to add.

Returns

Type	Description
NSHierarchyEntity

Examples

NSListAgent agent;
Integer domain;
String path;
String name;
NSHierarchyEntity res = agent.AddHierarchyToPath(domain, path, name);

ChangeCurrency(Float,String,String)

Recalculates the amount to the new currency.

Introduced or updated in version: 7

Declaration

Float ChangeCurrency(Float amount, String fromCurrency, String toCurrency)

Parameters

Type	Name	Description
Float	amount
String	fromCurrency
String	toCurrency

Returns

Type	Description
Float

Examples

NSListAgent agent;
Float amount;
String fromCurrency;
String toCurrency;
Float res = agent.ChangeCurrency(amount, fromCurrency, toCurrency);

CreateDefaultAmountClassEntity()

Sets default values into a new NSAmountClassEntity.

Introduced or updated in version: 7.5

Declaration

NSAmountClassEntity CreateDefaultAmountClassEntity()

Returns

Type	Description
NSAmountClassEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSAmountClassEntity thing = agent.CreateDefaultAmountClassEntity();
thing = agent.SaveAmountClassEntity(thing);

CreateDefaultCountry()

Gets a new country

Introduced or updated in version: 7.5

Declaration

NSCountry CreateDefaultCountry()

Returns

Type	Description
NSCountry

Examples

NSListAgent agent;
NSCountry res = agent.CreateDefaultCountry();

CreateDefaultCurrencyEntity()

Sets default values into a new NSCurrencyEntity.

Introduced or updated in version: 7.5

Declaration

NSCurrencyEntity CreateDefaultCurrencyEntity()

Returns

Type	Description
NSCurrencyEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSCurrencyEntity thing = agent.CreateDefaultCurrencyEntity();
thing = agent.SaveCurrencyEntity(thing);

CreateDefaultDocumentTemplateEntity()

Sets default values into a new NSDocumentTemplateEntity.

Introduced or updated in version: 7.5

Declaration

NSDocumentTemplateEntity CreateDefaultDocumentTemplateEntity()

Returns

Type	Description
NSDocumentTemplateEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSDocumentTemplateEntity thing = agent.CreateDefaultDocumentTemplateEntity();
thing = agent.SaveDocumentTemplateEntity(thing);

CreateDefaultDocumentTemplateLanguage(Integer,String)

Creates a new document template language based on an existing template

Introduced or updated in version: 7.5

Declaration

Void CreateDefaultDocumentTemplateLanguage(Integer documentTemplateId, String languageCode)

Parameters

Type	Name	Description
Integer	documentTemplateId
String	languageCode

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer documentTemplateId;
String languageCode;
agent.CreateDefaultDocumentTemplateLanguage(documentTemplateId, languageCode);

CreateDefaultExtAppEntity()

Sets default values into a new NSExtAppEntity.

Introduced or updated in version: 8.0sr3

Declaration

NSExtAppEntity CreateDefaultExtAppEntity()

Returns

Type	Description
NSExtAppEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSExtAppEntity thing = agent.CreateDefaultExtAppEntity();
thing = agent.SaveExtAppEntity(thing);

CreateDefaultHeadingEntity()

Sets default values into a new NSHeadingEntity.

Introduced or updated in version: 7.5

Declaration

NSHeadingEntity CreateDefaultHeadingEntity()

Returns

Type	Description
NSHeadingEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSHeadingEntity thing = agent.CreateDefaultHeadingEntity();
thing = agent.SaveHeadingEntity(thing);

CreateDefaultHeadingFromListDefinition(Integer)

Gets a heading for the specified list definition

Introduced or updated in version: 7.5

Declaration

NSHeadingEntity CreateDefaultHeadingFromListDefinition(Integer udListDefinitionId)

Parameters

Type	Name	Description
Integer	udListDefinitionId

Returns

Type	Description
NSHeadingEntity

Examples

NSListAgent agent;
Integer udListDefinitionId;
NSHeadingEntity res = agent.CreateDefaultHeadingFromListDefinition(udListDefinitionId);

CreateDefaultHierarchyEntity()

Sets default values into a new NSHierarchyEntity.

Introduced or updated in version: 7

Declaration

NSHierarchyEntity CreateDefaultHierarchyEntity()

Returns

Type	Description
NSHierarchyEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSHierarchyEntity thing = agent.CreateDefaultHierarchyEntity();
thing = agent.SaveHierarchyEntity(thing);

CreateDefaultListEntity()

Sets default values into a new NSListEntity.

Introduced or updated in version: 7.5

Declaration

NSListEntity CreateDefaultListEntity()

Returns

Type	Description
NSListEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSListEntity thing = agent.CreateDefaultListEntity();
thing = agent.SaveListEntity(thing);

CreateDefaultListItemEntity()

Sets default values into a new NSListItemEntity.

Introduced or updated in version: 7.5

Declaration

NSListItemEntity CreateDefaultListItemEntity()

Returns

Type	Description
NSListItemEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSListItemEntity thing = agent.CreateDefaultListItemEntity();
thing = agent.SaveListItemEntity(thing);

CreateDefaultProjectTypeEntity()

Sets default values into a new NSProjectTypeEntity.

Introduced or updated in version: 7.5

Declaration

NSProjectTypeEntity CreateDefaultProjectTypeEntity()

Returns

Type	Description
NSProjectTypeEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSProjectTypeEntity thing = agent.CreateDefaultProjectTypeEntity();
thing = agent.SaveProjectTypeEntity(thing);

CreateDefaultRelationDefinitionEntity()

Sets default values into a new NSRelationDefinitionEntity.

Introduced or updated in version: 7.5

Declaration

NSRelationDefinitionEntity CreateDefaultRelationDefinitionEntity()

Returns

Type	Description
NSRelationDefinitionEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSRelationDefinitionEntity thing = agent.CreateDefaultRelationDefinitionEntity();
thing = agent.SaveRelationDefinitionEntity(thing);

CreateDefaultResourceEntity()

Sets default values into a new NSResourceEntity.

Introduced or updated in version: 7.5

Declaration

NSResourceEntity CreateDefaultResourceEntity()

Returns

Type	Description
NSResourceEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSResourceEntity thing = agent.CreateDefaultResourceEntity();
thing = agent.SaveResourceEntity(thing);

CreateDefaultSaleStageEntity()

Sets default values into a new NSSaleStageEntity.

Introduced or updated in version: 7.5

Declaration

NSSaleStageEntity CreateDefaultSaleStageEntity()

Returns

Type	Description
NSSaleStageEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSSaleStageEntity thing = agent.CreateDefaultSaleStageEntity();
thing = agent.SaveSaleStageEntity(thing);

CreateDefaultSaleTypeEntity()

Sets default values into a new NSSaleTypeEntity.

Introduced or updated in version: 7.5

Declaration

NSSaleTypeEntity CreateDefaultSaleTypeEntity()

Returns

Type	Description
NSSaleTypeEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSSaleTypeEntity thing = agent.CreateDefaultSaleTypeEntity();
thing = agent.SaveSaleTypeEntity(thing);

CreateDefaultTicketCategoryEntity()

Sets default values into a new NSTicketCategoryEntity.

Introduced or updated in version: 8.5R08

Declaration

NSTicketCategoryEntity CreateDefaultTicketCategoryEntity()

Returns

Type	Description
NSTicketCategoryEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSTicketCategoryEntity thing = agent.CreateDefaultTicketCategoryEntity();
thing = agent.SaveTicketCategoryEntity(thing);

CreateDefaultTicketPriorityEntity()

Sets default values into a new NSTicketPriorityEntity.

Introduced or updated in version: 8.5R08

Declaration

NSTicketPriorityEntity CreateDefaultTicketPriorityEntity()

Returns

Type	Description
NSTicketPriorityEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSTicketPriorityEntity thing = agent.CreateDefaultTicketPriorityEntity();
thing = agent.SaveTicketPriorityEntity(thing);

CreateDefaultTicketStatusEntity()

Sets default values into a new NSTicketStatusEntity.

Introduced or updated in version: 8.5R08

Declaration

NSTicketStatusEntity CreateDefaultTicketStatusEntity()

Returns

Type	Description
NSTicketStatusEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSTicketStatusEntity thing = agent.CreateDefaultTicketStatusEntity();
thing = agent.SaveTicketStatusEntity(thing);

CreateDefaultWebPanelEntity()

Sets default values into a new NSWebPanelEntity.

Introduced or updated in version: 7.5

Declaration

NSWebPanelEntity CreateDefaultWebPanelEntity()

Returns

Type	Description
NSWebPanelEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSListAgent agent;
NSWebPanelEntity thing = agent.CreateDefaultWebPanelEntity();
thing = agent.SaveWebPanelEntity(thing);

DeleteAllFromListDefinition(Integer)

Marks all items in the list deleted

Introduced or updated in version: 8.2

Declaration

Void DeleteAllFromListDefinition(Integer udListDefinitionId)

Parameters

Type	Name	Description
Integer	udListDefinitionId

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer udListDefinitionId;
agent.DeleteAllFromListDefinition(udListDefinitionId);

DeleteAllFromListName(String)

Marks all items in the list deleted

Introduced or updated in version: 8.2

Declaration

Void DeleteAllFromListName(String udListDefinitionName)

Parameters

Type	Name	Description
String	udListDefinitionName

Returns

Type	Description
Void

Examples

NSListAgent agent;
String udListDefinitionName;
agent.DeleteAllFromListName(udListDefinitionName);

DeleteAllHeadingsFromListDefinition(Integer)

Deletes all headings for list resolved by the provided ID.

Introduced or updated in version: 8.2

Declaration

Void DeleteAllHeadingsFromListDefinition(Integer id)

Parameters

Type	Name	Description
Integer	id

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer id;
agent.DeleteAllHeadingsFromListDefinition(id);

DeleteAllHeadingsFromName(String)

Deletes all headings for list resolved by the provided name.

Introduced or updated in version: 8.2

Declaration

Void DeleteAllHeadingsFromName(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Void

Examples

NSListAgent agent;
String name;
agent.DeleteAllHeadingsFromName(name);

DeleteAppWebPanels()

Permanently delete all web panels owned by your app.

Introduced or updated in version: 8.0sr3

Declaration

Void DeleteAppWebPanels()

Returns

Type	Description
Void

Remarks

Works in Online only, for registered Apps that send a valid ApplicationToken; otherwise nothing happens

Examples

NSListAgent agent;
agent.DeleteAppWebPanels();

DeleteDocumentTemplateLanguage(Integer,String)

Deletes language variant of the document template

Introduced or updated in version: 7.5

Declaration

Void DeleteDocumentTemplateLanguage(Integer documentTemplateId, String languageCode)

Parameters

Type	Name	Description
Integer	documentTemplateId
String	languageCode

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer documentTemplateId;
String languageCode;
agent.DeleteDocumentTemplateLanguage(documentTemplateId, languageCode);

DeleteFromListDefinition(Integer,Integer)

Deletes a list item from the specified list definition

Introduced or updated in version: 8.2

Declaration

Void DeleteFromListDefinition(Integer id, Integer udListDefinitionId)

Parameters

Type	Name	Description
Integer	id
Integer	udListDefinitionId

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer id;
Integer udListDefinitionId;
agent.DeleteFromListDefinition(id, udListDefinitionId);

DeleteFromListName(Integer,String)

Deletes a list item from the specified list definition

Introduced or updated in version: 8.2

Declaration

Void DeleteFromListName(Integer id, String udListDefinitionName)

Parameters

Type	Name	Description
Integer	id
String	udListDefinitionName

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer id;
String udListDefinitionName;
agent.DeleteFromListName(id, udListDefinitionName);

DeleteHierarchyEntity(Integer)

Deletes the NSHierarchyEntity

Introduced or updated in version: 7

Declaration

DeleteHierarchyEntity(Integer hierarchyEntity)

Parameters

Type	Name	Description
Integer	hierarchyEntity

Returns

Type	Description
Void

Examples

NSListAgent agent;
agent.DeleteHierarchyEntity(123);

DeleteHierarchyFromPath(Integer,String)

Removes a hierarchy item and its children from a path

Introduced or updated in version: 7

Declaration

Void DeleteHierarchyFromPath(Integer domain, String path)

Parameters

Type	Name	Description
Integer	domain	See Domain.
String	path

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer domain;
String path;
agent.DeleteHierarchyFromPath(domain, path);

DeleteListEntity(Integer)

Deletes the NSListEntity

Introduced or updated in version: 8.2

Declaration

DeleteListEntity(Integer listEntity)

Parameters

Type	Name	Description
Integer	listEntity

Returns

Type	Description
Void

Examples

NSListAgent agent;
agent.DeleteListEntity(123);

DeleteListEntityByName(String)

Deletes an NSListEntity resolved by the provided name.

Introduced or updated in version: 8.2

Declaration

Void DeleteListEntityByName(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Void

Examples

NSListAgent agent;
String name;
agent.DeleteListEntityByName(name);

DeleteProjectStatus(Integer)

Deletes a project status

Introduced or updated in version: 7.5

Declaration

Void DeleteProjectStatus(Integer projectStatusId)

Parameters

Type	Name	Description
Integer	projectStatusId

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer projectStatusId;
agent.DeleteProjectStatus(projectStatusId);

DeleteResourceEntity(Integer)

Deletes the NSResourceEntity

Introduced or updated in version: 7.5

Declaration

DeleteResourceEntity(Integer resourceEntity)

Parameters

Type	Name	Description
Integer	resourceEntity	The identity of the ResourceEntity to delete.

Returns

Type	Description
Void

Examples

NSListAgent agent;
agent.DeleteResourceEntity(123);

DeleteTicketCategoryEntity(Integer)

Deletes the NSTicketCategoryEntity

Introduced or updated in version: 8.5R08

Declaration

DeleteTicketCategoryEntity(Integer ticketCategoryEntity)

Parameters

Type	Name	Description
Integer	ticketCategoryEntity

Returns

Type	Description
Void

Examples

NSListAgent agent;
agent.DeleteTicketCategoryEntity(123);

DeleteTicketPriorityEntity(Integer)

Deletes the NSTicketPriorityEntity

Introduced or updated in version: 8.5R08

Declaration

DeleteTicketPriorityEntity(Integer ticketPriorityEntity)

Parameters

Type	Name	Description
Integer	ticketPriorityEntity

Returns

Type	Description
Void

Examples

NSListAgent agent;
agent.DeleteTicketPriorityEntity(123);

DeleteTicketStatusEntity(Integer)

Deletes the NSTicketStatusEntity

Introduced or updated in version: 8.5R08

Declaration

DeleteTicketStatusEntity(Integer ticketStatusEntity)

Parameters

Type	Name	Description
Integer	ticketStatusEntity

Returns

Type	Description
Void

Examples

NSListAgent agent;
agent.DeleteTicketStatusEntity(123);

DeleteWebPanel(Integer)

Hard-delete (real, permanent DELETE in the database) the given web panel. Use with care!

Introduced or updated in version: 8.0sr3

Declaration

Void DeleteWebPanel(Integer id)

Parameters

Type	Name	Description
Integer	id

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer id;
agent.DeleteWebPanel(id);

GenerateNavigationUrl(Integer,String)

Generates the navigation URL to be used to navigate to the panel

Introduced or updated in version: 7.5

Declaration

String GenerateNavigationUrl(Integer visibleIn, String windowName)

Parameters

Type	Name	Description
Integer	visibleIn
String	windowName

Returns

Type	Description
String	See Navigation

Examples

NSListAgent agent;
Integer visibleIn;
String windowName;
String res = agent.GenerateNavigationUrl(visibleIn, windowName);

GetAllCountries(Bool)

Returns all available countries a contact or person could belong to.

Introduced or updated in version: 8.2

Declaration

NSCountry[] GetAllCountries(Bool includeDeleted)

Parameters

Type	Name	Description
Bool	includeDeleted

Returns

Type	Description
NSCountry[]

Examples

NSListAgent agent;
Bool includeDeleted;
NSCountry[] res = agent.GetAllCountries(includeDeleted);

GetAllCurrencies(Bool)

Returns all currencies

Introduced or updated in version: 8.2

Declaration

NSCurrencyEntity[] GetAllCurrencies(Bool includeDeleted)

Parameters

Type	Name	Description
Bool	includeDeleted

Returns

Type	Description
NSCurrencyEntity[]

Examples

NSListAgent agent;
Bool includeDeleted;
NSCurrencyEntity[] res = agent.GetAllCurrencies(includeDeleted);

GetAllDocumentTemplates(Bool)

Returns all templates

Introduced or updated in version: 8.2

Declaration

NSDocumentTemplateEntity[] GetAllDocumentTemplates(Bool includeDeleted)

Parameters

Type	Name	Description
Bool	includeDeleted

Returns

Type	Description
NSDocumentTemplateEntity[]

Examples

NSListAgent agent;
Bool includeDeleted;
NSDocumentTemplateEntity[] res = agent.GetAllDocumentTemplates(includeDeleted);

GetAllDomains()

Gets list of all domains

Introduced or updated in version: 7

Declaration

Integer[] GetAllDomains()

Returns

Type	Description
Integer[]	Domain types (scripts, extra tables, etc).

Examples

NSListAgent agent;
Integer[] res = agent.GetAllDomains();

GetAllFromListDefinition(Integer,Bool)

Gets all list items for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity[] GetAllFromListDefinition(Integer udListDefinitionId, Bool includeDeleted)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Bool	includeDeleted

Returns

Type	Description
NSListItemEntity[]

Examples

NSListAgent agent;
Integer udListDefinitionId;
Bool includeDeleted;
NSListItemEntity[] res = agent.GetAllFromListDefinition(udListDefinitionId, includeDeleted);

GetAllFromListName(String,Bool)

Gets all list items for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity[] GetAllFromListName(String udListDefinitionName, Bool includeDeleted)

Parameters

Type	Name	Description
String	udListDefinitionName
Bool	includeDeleted

Returns

Type	Description
NSListItemEntity[]

Examples

NSListAgent agent;
String udListDefinitionName;
Bool includeDeleted;
NSListItemEntity[] res = agent.GetAllFromListName(udListDefinitionName, includeDeleted);

GetAllInDomain(Integer,Bool)

Gets all items in a domain

Introduced or updated in version: 7

Declaration

NSHierarchyEntity[] GetAllInDomain(Integer domain, Bool children)

Parameters

Type	Name	Description
Integer	domain	See Domain.
Bool	children

Returns

Type	Description
NSHierarchyEntity[]

Examples

NSListAgent agent;
Integer domain;
Bool children;
NSHierarchyEntity[] res = agent.GetAllInDomain(domain, children);

GetAllSaleStages(Bool)

Returns all ratings

Introduced or updated in version: 8.2

Declaration

NSSaleStageEntity[] GetAllSaleStages(Bool includeDeleted)

Parameters

Type	Name	Description
Bool	includeDeleted

Returns

Type	Description
NSSaleStageEntity[]

Examples

NSListAgent agent;
Bool includeDeleted;
NSSaleStageEntity[] res = agent.GetAllSaleStages(includeDeleted);

GetAllSaleType()

Returns all sale types as simple list items

Introduced or updated in version: 8.5R08

Declaration

NSSaleType[] GetAllSaleType()

Returns

Type	Description
NSSaleType[]

Examples

NSListAgent agent;
NSSaleType[] res = agent.GetAllSaleType();

GetAllSaleTypeEntities(Bool)

Returns all sale types as entities with stakeholders, guide and quote properties

Introduced or updated in version: 8.5R08

Declaration

NSSaleTypeEntity[] GetAllSaleTypeEntities(Bool includeDeleted)

Parameters

Type	Name	Description
Bool	includeDeleted

Returns

Type	Description
NSSaleTypeEntity[]

Examples

NSListAgent agent;
Bool includeDeleted;
NSSaleTypeEntity[] res = agent.GetAllSaleTypeEntities(includeDeleted);

GetAllTasks(Bool)

Returns all appointment tasks

Introduced or updated in version: 8.2

Declaration

NSTaskListItem[] GetAllTasks(Bool includeDeleted)

Parameters

Type	Name	Description
Bool	includeDeleted

Returns

Type	Description
NSTaskListItem[]

Examples

NSListAgent agent;
Bool includeDeleted;
NSTaskListItem[] res = agent.GetAllTasks(includeDeleted);

GetAllTicketPriorities(Bool)

Returns all available ticket priorities.

Introduced or updated in version: 8.5R08

Declaration

NSTicketPriorityEntity[] GetAllTicketPriorities(Bool includeDeleted)

Parameters

Type	Name	Description
Bool	includeDeleted

Returns

Type	Description
NSTicketPriorityEntity[]

Examples

NSListAgent agent;
Bool includeDeleted;
NSTicketPriorityEntity[] res = agent.GetAllTicketPriorities(includeDeleted);

GetAmountClassEntity(Integer)

Gets an NSAmountClassEntity object.

Introduced or updated in version: 7.5

Declaration

NSAmountClassEntity GetAmountClassEntity(Integer amountClassEntityId)

Parameters

Type	Name	Description
Integer	amountClassEntityId

Returns

Type	Description
NSAmountClassEntity

Examples

NSListAgent agent;
NSAmountClassEntity thing = agent.GetAmountClassEntity(123);

GetAppWebPanels()

Gets all web panels owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken

Introduced or updated in version: 8.0sr3

Declaration

NSWebPanelEntity[] GetAppWebPanels()

Returns

Type	Description
NSWebPanelEntity[]

Examples

NSListAgent agent;
NSWebPanelEntity[] res = agent.GetAppWebPanels();

GetBaseCurrency()

Gets the base currency, used for calculating exchange rates

Introduced or updated in version: 7.5

Declaration

NSCurrencyEntity GetBaseCurrency()

Returns

Type	Description
NSCurrencyEntity

Examples

NSListAgent agent;
NSCurrencyEntity res = agent.GetBaseCurrency();

GetBusiness(Integer)

Gets an NSBusiness object.

Introduced or updated in version: 7

Declaration

NSBusiness GetBusiness(Integer businessId)

Parameters

Type	Name	Description
Integer	businessId

Returns

Type	Description
NSBusiness

Examples

NSListAgent agent;
NSBusiness thing = agent.GetBusiness(123);

GetBusinesses()

Returns all available businesses that a contact could have.

Introduced or updated in version: 7

Declaration

NSBusiness[] GetBusinesses()

Returns

Type	Description
NSBusiness[]

Examples

NSListAgent agent;
NSBusiness[] res = agent.GetBusinesses();

GetBusinessList(Integer[])

Gets an array of NSBusiness objects.

Introduced or updated in version: 7

Declaration

NSBusiness[] GetBusinessList(Integer[]  businessIds)

Parameters

Type	Name	Description
Integer[]	businessIds

Returns

Type	Description
NSBusiness[]

Examples

Integer[] ids;
NSListAgent agent;
NSBusiness[] list = agent.GetBusinessList(ids);

GetCategories()

Returns all categories a contact could belong to

Introduced or updated in version: 7

Declaration

NSCategory[] GetCategories()

Returns

Type	Description
NSCategory[]

Examples

NSListAgent agent;
NSCategory[] res = agent.GetCategories();

GetCategory(Integer)

Gets an NSCategory object.

Introduced or updated in version: 7

Declaration

NSCategory GetCategory(Integer categoryId)

Parameters

Type	Name	Description
Integer	categoryId

Returns

Type	Description
NSCategory

Examples

NSListAgent agent;
NSCategory thing = agent.GetCategory(123);

GetCategoryList(Integer[])

Gets an array of NSCategory objects.

Introduced or updated in version: 7

Declaration

NSCategory[] GetCategoryList(Integer[] categoryIds)

Parameters

Type	Name	Description
Integer[]	categoryIds

Returns

Type	Description
NSCategory[]

Examples

Integer[] ids;
NSListAgent agent;
NSCategory[] res = agent.GetCategoryList(ids);

GetCompetitor(Integer)

Gets an NSCompetitor object.

Introduced or updated in version: 7

Declaration

NSCompetitor GetCompetitor(Integer competitorId)

Parameters

Type	Name	Description
Integer	competitorId

Returns

Type	Description
NSCompetitor

Examples

NSListAgent agent;
NSCompetitor thing = agent.GetCompetitor(123);

GetCompetitorList(Integer[])

Gets an array of NSCompetitor objects.

Introduced or updated in version: 7

Declaration

NSCompetitor[] GetCompetitorList(Integer[]  competitorIds)

Parameters

Type	Name	Description
Integer[]	competitorIds

Returns

Type	Description
NSCompetitor[]

Examples

Integer[] ids;
NSListAgent agent;
NSCompetitor[] res = agent.GetCompetitorList(ids);

GetCompetitors()

Returns all competitors

Introduced or updated in version: 7

Declaration

NSCompetitor[] GetCompetitors()

Returns

Type	Description
NSCompetitor[]

Examples

NSListAgent agent;
NSCompetitor[] res = agent.GetCompetitors();

GetConsentPurpose(Integer)

Gets an NSConsentPurpose object.

Introduced or updated in version: 8.2

Declaration

NSConsentPurpose GetConsentPurpose(Integer consentPurposeId)

Parameters

Type	Name	Description
Integer	consentPurposeId

Returns

Type	Description
NSConsentPurpose

Examples

NSListAgent agent;
NSConsentPurpose thing = agent.GetConsentPurpose(123);

GetConsentPurposeList(Integer[])

Gets an array of NSConsentPurpose objects.

Introduced or updated in version: 8.2

Declaration

NSConsentPurpose[] GetConsentPurposeList(Integer[]  consentPurposeIds)

Parameters

Type	Name	Description
Integer[]	consentPurposeIds

Returns

Type	Description
NSConsentPurpose[]

Examples

Integer[] ids;
NSListAgent agent;
NSConsentPurpose[] res = agent.GetConsentPurposeList(ids);

GetConsentPurposes()

Returns all defined purposes.

Introduced or updated in version: 8.2

Declaration

NSConsentPurpose[] GetConsentPurposes()

Returns

Type	Description
NSConsentPurpose[]

Examples

NSListAgent agent;
NSConsentPurpose[] res = agent.GetConsentPurposes();

GetConsentSource(Integer)

Gets an NSConsentSource object.

Introduced or updated in version: 8.2

Declaration

NSConsentSource GetConsentSource(Integer consentSourceId)

Parameters

Type	Name	Description
Integer	consentSourceId

Returns

Type	Description
NSConsentSource

Examples

NSListAgent agent;
NSConsentSource thing = agent.GetConsentSource(123);

GetConsentSourceList(Integer[])

Gets an array of NSConsentSource objects.

Introduced or updated in version: 8.2

Declaration

NSConsentSource[] GetConsentSourceList(Integer[]  consentSourceIds)

Parameters

Type	Name	Description
Integer[]	consentSourceIds

Returns

Type	Description
NSConsentSource[]

Examples

Integer[] ids;
NSListAgent agent;
NSConsentSource[] res = agent.GetConsentSourceList(ids);

GetConsentSources()

Returns all defined Sources.

Introduced or updated in version: 8.2

Declaration

NSConsentSource[] GetConsentSources()

Returns

Type	Description
NSConsentSource[]

Examples

NSListAgent agent;
NSConsentSource[] res = agent.GetConsentSources();

GetCountries()

Returns all available countries a contact or person could belong to.

Introduced or updated in version: 7

Declaration

NSCountry[] GetCountries()

Returns

Type	Description
NSCountry[]

Examples

NSListAgent agent;
NSCountry[] res = agent.GetCountries();

GetCountry(Integer)

Gets an NSCountry object.

Introduced or updated in version: 7

Declaration

NSCountry GetCountry(Integer countryId)

Parameters

Type	Name	Description
Integer	countryId

Returns

Type	Description
NSCountry

Examples

NSListAgent agent;
NSCountry thing = agent.GetCountry(123);

GetCountryList(Integer[])

Gets an array of NSCountry objects.

Introduced or updated in version: 7

Declaration

NSCountry[] GetCountryList(Integer[]  countryIds)

Parameters

Type	Name	Description
Integer[]	countryIds

Returns

Type	Description
NSCountry[]

Examples

Integer[] ids;
NSListAgent agent;
NSCountry[] res = agent.GetCountryList(ids);

GetCredited(Integer)

Gets an NSCredited object.

Introduced or updated in version: 7

Declaration

NSCredited GetCredited(Integer creditedId)

Parameters

Type	Name	Description
Integer	creditedId

Returns

Type	Description
NSCredited

Examples

NSListAgent agent;
NSCredited thing = agent.GetCredited(123);

GetCreditedList(Integer[])

Gets an array of NSCredited objects.

Introduced or updated in version: 7

Declaration

NSCredited[] GetCreditedList(Integer[] creditedIds)

Parameters

Type	Name	Description
Integer[]	creditedIds

Returns

Type	Description
NSCredited[]

Examples

Integer[] ids;
NSListAgent agent;
NSCredited[] res = agent.GetCreditedList(ids);

GetCrediteds()

Returns all credited

Introduced or updated in version: 7

Declaration

NSCredited[] GetCrediteds()

Returns

Type	Description
NSCredited[]

GetCurrencies()

Returns all currencies

Introduced or updated in version: 7

Declaration

NSCurrency[] GetCurrencies()

Returns

Type	Description
NSCurrency[]

Examples

NSListAgent agent;
NSCurrency[] res = agent.GetCurrencies();

GetCurrency(Integer)

Gets an NSCurrency object.

Introduced or updated in version: 7

Declaration

NSCurrency GetCurrency(Integer currencyId)

Parameters

Type	Name	Description
Integer	currencyId

Returns

Type	Description
NSCurrency

Examples

NSListAgent agent;
NSCurrency thing = agent.GetCurrency(123);

GetCurrencyEntity(Integer)

Gets an NSCurrencyEntity object.

Introduced or updated in version: 7.5

Declaration

NSCurrencyEntity GetCurrencyEntity(Integer currencyEntityId)

Parameters

Type	Name	Description
Integer	currencyEntityId

Returns

Type	Description
NSCurrencyEntity

Examples

NSListAgent agent;
NSCurrencyEntity thing = agent.GetCurrencyEntity(123);

GetCurrencyList(Integer[])

Gets an array of NSCurrency objects.

Introduced or updated in version: 7

Declaration

NSCurrency[] GetCurrencyList(Integer[]  currencyIds)

Parameters

Type	Name	Description
Integer[]	currencyIds

Returns

Type	Description
NSCurrency[]

Examples

Integer[] ids;
NSListAgent agent;
NSCurrency[] res = agent.GetCurrencyList(ids);

GetCustomerLanguage(Integer)

Gets an NSCustomerLanguage object.

Introduced or updated in version: 7

Declaration

NSCustomerLanguage GetCustomerLanguage(Integer customerLanguageId)

Parameters

Type	Name	Description
Integer	customerLanguageId

Returns

Type	Description
NSCustomerLanguage

Examples

NSListAgent agent;
NSCustomerLanguage thing = agent.GetCustomerLanguage(123);

GetCustomerLanguageList(Integer[])

Gets an array of NSCustomerLanguage objects.

Introduced or updated in version: 7

Declaration

NSCustomerLanguage[] GetCustomerLanguageList(Integer[]  customerLanguageIds)

Parameters

Type	Name	Description
Integer[]	customerLanguageIds

Returns

Type	Description
NSCustomerLanguage[]

Examples

Integer[] ids;
NSListAgent agent;
NSCustomerLanguage[] res = agent.GetCustomerLanguageList(ids);

GetCustomerLanguages()

Introduced or updated in version: 7

Declaration

NSCustomerLanguage[] GetCustomerLanguages()

Returns

Type	Description
NSCustomerLanguage[]

Examples

NSListAgent agent;
NSCustomerLanguage[] res = agent.GetCustomerLanguages();

GetDeliveryTerm(Integer)

Gets an NSDeliveryTerm object.

Introduced or updated in version: 8.0sr3

Declaration

NSDeliveryTerm GetDeliveryTerm(Integer deliveryTermId)

Parameters

Type	Name	Description
Integer	deliveryTermId

Returns

Type	Description
NSDeliveryTerm

Examples

NSListAgent agent;
NSDeliveryTerm thing = agent.GetDeliveryTerm(123);

GetDeliveryTerms()

Returns all DeliveryTerms in SuperOffice database.

Introduced or updated in version: 8.0sr3

Declaration

NSDeliveryTerm[] GetDeliveryTerms()

Returns

Type	Description
NSDeliveryTerm[]

Examples

NSListAgent agent;
NSDeliveryTerm[] res = agent.GetDeliveryTerms();

GetDeliveryType(Integer)

Gets an NSDeliveryType object.

Introduced or updated in version: 8.0sr3

Declaration

NSDeliveryType GetDeliveryType(Integer deliveryTypeId)

Parameters

Type	Name	Description
Integer	deliveryTypeId

Returns

Type	Description
NSDeliveryType

Examples

NSListAgent agent;
NSDeliveryType thing = agent.GetDeliveryType(123);

GetDeliveryTypes()

Returns all DeliveryTypes in SuperOffice database.

Introduced or updated in version: 8.0sr3

Declaration

NSDeliveryType[] GetDeliveryTypes()

Returns

Type	Description
NSDeliveryType[]

Examples

NSListAgent agent;
NSDeliveryType[] res = agent.GetDeliveryTypes();

GetDepartment(Integer)

Gets an NSDepartment object.

Introduced or updated in version: 7

Declaration

NSDepartment GetDepartment(Integer departmentId)

Parameters

Type	Name	Description
Integer	departmentId

Returns

Type	Description
NSDepartment

Examples

NSListAgent agent;
NSDepartment thing = agent.GetDepartment(123);

GetDepartmentList(Integer[])

Gets an array of Department objects.

Introduced or updated in version: 7

Declaration

NSDepartment[] GetDepartmentList(Integer[]  departmentIds)

Parameters

Type	Name	Description
Integer[]	departmentIds

Returns

Type	Description
NSDepartment[]

Examples

Integer[] ids;
NSListAgent agent;
NSDepartment[] res = agent.GetDepartmentList(ids);

GetDepartments()

Gets all departments/user groups for the internal phone list with the user's colleagues.

Introduced or updated in version: 7

Declaration

NSDepartment[] GetDepartments()

Returns

Type	Description
NSDepartment[]

Examples

NSListAgent agent;
NSDepartment[] res = agent.GetDepartments();

GetDocumentTemplate(Integer)

Gets an NSDocumentTemplate object.

Introduced or updated in version: 7

Declaration

NSDocumentTemplate GetDocumentTemplate(Integer documentTemplateId)

Parameters

Type	Name	Description
Integer	documentTemplateId

Returns

Type	Description
NSDocumentTemplate

Examples

NSListAgent agent;
NSDocumentTemplate thing = agent.GetDocumentTemplate(123);

GetDocumentTemplateEntity(Integer)

Gets an NSDocumentTemplateEntity object.

Introduced or updated in version: 7.5

Declaration

NSDocumentTemplateEntity GetDocumentTemplateEntity(Integer documentTemplateEntityId)

Parameters

Type	Name	Description
Integer	documentTemplateEntityId

Returns

Type	Description
NSDocumentTemplateEntity

Examples

NSListAgent agent;
NSDocumentTemplateEntity thing = agent.GetDocumentTemplateEntity(123);

GetDocumentTemplateExtension(Integer)

Gets the file extension for the document template

Introduced or updated in version: 7.5

Declaration

String GetDocumentTemplateExtension(Integer documentTemplateId)

Parameters

Type	Name	Description
Integer	documentTemplateId

Returns

Type	Description
String

Examples

NSListAgent agent;
Integer documentTemplateId;
String res = agent.GetDocumentTemplateExtension(documentTemplateId);

GetDocumentTemplateLanguages(Integer)

Gets the supported language variations for a document template

Introduced or updated in version: 7.5

Declaration

String[] GetDocumentTemplateLanguages(Integer documentTemplateId)

Parameters

Type	Name	Description
Integer	documentTemplateId

Returns

Type	Description
String[]

Examples

NSListAgent agent;
Integer documentTemplateId;
String[] res = agent.GetDocumentTemplateLanguages(documentTemplateId);

GetDocumentTemplateList(Integer[])

Gets an array of NSDocumentTemplate objects.

Introduced or updated in version: 7

Declaration

NSDocumentTemplate[] GetDocumentTemplateList(Integer[]  documentTemplateIds)

Parameters

Type	Name	Description
Integer[]	documentTemplateIds

Returns

Type	Description
NSDocumentTemplate[]

Examples

Integer[] ids;
NSListAgent agent;
NSDocumentTemplate[] res = agent.GetDocumentTemplateList(ids);

GetDocumentTemplateProperties(Integer,String[])

Retrieves a list of key-value pairs of document template propertiesGets document template properties..

Map GetDocumentTemplateProperties(Integer documentTemplateId, String[] requestedProperties)

Introduced or updated in version: 7.5

Declaration

Map GetDocumentTemplateProperties(Integer documentTemplateId, string[] requestedProperties)

Parameters

Type	Name	Description
Integer	documentTemplateId	The primary key ID of the document template
String[]	requestedProperties	An array of properties to get the values for.

Returns

Type	Description
Map	key-value pairs with the requested properties.

Examples

NSListAgent agent;
Integer documentTemplateId;
String[] requestedProperties;
Map res = agent.GetDocumentTemplateProperties(documentTemplateId, requestedProperties);

GetDocumentTemplates()

Returns all available document templates

Introduced or updated in version: 7

Declaration

NSDocumentTemplate[] GetDocumentTemplates()

Returns

Type	Description
NSDocumentTemplate[]

Examples

NSListAgent agent;
NSDocumentTemplate[] res = agent.GetDocumentTemplates();

GetDocumentTemplatesTasks()

The appointment's task is a Document template item when the appointment is a document.

Introduced or updated in version: 7

Declaration

NSTask[] GetDocumentTemplatesTasks()

Returns

Type	Description
NSTask[]

Examples

NSListAgent agent;
NSTask[] res = agent.GetDocumentTemplatesTasks();

GetDocumentTemplateStreamFromId(Integer,String)

Retrieves a stream to a document template based on its ID

Introduced or updated in version: 8.2

Declaration

NSStream GetDocumentTemplateStreamFromId(Integer documentTemplateId, String languageCode)

Parameters

Type	Name	Description
Integer	documentTemplateId
String	languageCode

Returns

Type	Description
NSStream

Examples

NSListAgent agent;
Integer documentTemplateId;
String languageCode;
NSStream res = agent.GetDocumentTemplateStreamFromId(documentTemplateId, languageCode);

GetDocumentTemplateTask(Integer)

Returns a Document Template list item as a TaskListItem.

Introduced or updated in version: 7

Declaration

NSTask GetDocumentTemplateTask(Integer documentTemplateId)

Parameters

Type	Name	Description
Integer	documentTemplateId

Returns

Type	Description
NSTask

Remarks

The appointment's task is a Document template item when the appointment is a document.

Examples

NSListAgent agent;
Integer documentTemplateId;
NSTask res = agent.GetDocumentTemplateTask(documentTemplateId);

GetDocumentTemplateUrl(Integer,Bool,String)

Gets a url to the document template

Introduced or updated in version: 7.5

Declaration

String GetDocumentTemplateUrl(Integer documentTemplateId, Bool writableUrl, String languageCode)

Parameters

Type	Name	Description
Integer	documentTemplateId
Bool	writableUrl
String	languageCode

Returns

Type	Description
String

Examples

NSListAgent agent;
Integer documentTemplateId;
Bool writableUrl;
String languageCode;
String res = agent.GetDocumentTemplateUrl(documentTemplateId, writableUrl, languageCode);

GetDocumentTemplateUsedInProjectStage(Integer)

Gets a String array of names in project guide that this template is used in

Introduced or updated in version: 7.5

Declaration

String[] GetDocumentTemplateUsedInProjectStage(Integer documentTemplateId)

Parameters

Type	Name	Description
Integer	documentTemplateId

Returns

Type	Description
String[]

Examples

NSListAgent agent;
Integer documentTemplateId;
String[] res = agent.GetDocumentTemplateUsedInProjectStage(documentTemplateId);

GetDocumentTemplateUsedInSalesStage(Integer)

Gets a String array of names in sales guide that this template is used in

Introduced or updated in version: 7.5

Declaration

String[] GetDocumentTemplateUsedInSalesStage(Integer documentTemplateId)

Parameters

Type	Name	Description
Integer	documentTemplateId

Returns

Type	Description
String[]

Examples

NSListAgent agent;
Integer documentTemplateId;
String[] res = agent.GetDocumentTemplateUsedInSalesStage(documentTemplateId);

GetDocumentTypesForPlugin(Integer)

Gets a list of document types supported by a given document plugin. Use the document template type when creating a new template.

Introduced or updated in version: 8.2

Declaration

Map GetDocumentTypesForPlugin(Integer pluginId)

Parameters

Type	Name	Description
Integer	pluginId

Returns

Type	Description
Map

Examples

NSListAgent agent;
Integer pluginId;
Map res = agent.GetDocumentTypesForPlugin(pluginId);

GetEmarketingStrictMode()

Gets the value of the Emarketing strict mode setting

Introduced or updated in version: 8.2

Declaration

Bool GetEmarketingStrictMode()

Returns

Type	Description
Bool

Examples

NSListAgent agent;
Bool res = agent.GetEmarketingStrictMode();

GetExtAppEntity(Integer)

Gets an NSExtAppEntity object.

Introduced or updated in version: 8.0sr3

Declaration

NSExtAppEntity GetExtAppEntity(Integer extAppEntityId)

Parameters

Type	Name	Description
Integer	extAppEntityId

Returns

Type	Description
NSExtAppEntity

Examples

NSListAgent agent;
NSExtAppEntity thing = agent.GetExtAppEntity(123);

GetFromListDefinition(Integer,Integer)

Gets a list item for the specified list definition

Introduced or updated in version: 7.5

Declaration

NSListItemEntity GetFromListDefinition(Integer id, Integer udListDefinitionId)

Parameters

Type	Name	Description
Integer	id
Integer	udListDefinitionId

Returns

Type	Description
NSListItemEntity

Examples

NSListAgent agent;
Integer id;
Integer udListDefinitionId;
NSListItemEntity res = agent.GetFromListDefinition(id, udListDefinitionId);

GetFromListName(Integer,String)

Gets a list item for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity GetFromListName(Integer id, String udListDefinitionName)

Parameters

Type	Name	Description
Integer	id
String	udListDefinitionName

Returns

Type	Description
NSListItemEntity

Examples

NSListAgent agent;
Integer id;
String udListDefinitionName;
NSListItemEntity res = agent.GetFromListName(id, udListDefinitionName);

GetHeadingEntity(Integer)

Gets an NSHeadingEntity object.

Introduced or updated in version: 7.5

Declaration

NSHeadingEntity GetHeadingEntity(Integer headingEntityId)

Parameters

Type	Name	Description
Integer	headingEntityId

Returns

Type	Description
NSHeadingEntity

Examples

NSListAgent agent;
NSHeadingEntity thing = agent.GetHeadingEntity(123);

GetHeadings(Integer,Integer,Bool)

Gets a selectable MDO list of the headings for this list item

Introduced or updated in version: 7.5

Declaration

NSSelectableMDOListItem[] GetHeadings(Integer udListDefinitionId, Integer listItemId, Bool showDeleted)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	listItemId
Bool	showDeleted

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

NSListAgent agent;
Integer udListDefinitionId;
Integer listItemId;
Bool showDeleted;
NSSelectableMDOListItem[] res = agent.GetHeadings(udListDefinitionId, listItemId, showDeleted);

GetHeadingsForListItemFromListName(String,Integer,Bool)

Gets a selectable MDO list of the headings for this list item

Introduced or updated in version: 8.2

Declaration

NSSelectableMDOListItem[] GetHeadingsForListItemFromListName(String udListDefinitionName, Integer listItemId, Bool showDeleted)

Parameters

Type	Name	Description
String	udListDefinitionName
Integer	listItemId
Bool	showDeleted

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

NSListAgent agent;
String udListDefinitionName;
Integer listItemId;
Bool showDeleted;
NSSelectableMDOListItem[] res = agent.GetHeadingsForListItemFromListName(udListDefinitionName, listItemId, showDeleted);

GetHeadingsFromListDefinition(Integer)

Gets headings for list resolved by the provided ID.

Introduced or updated in version: 8.2

Declaration

NSHeadingEntity[] GetHeadingsFromListDefinition(Integer id)

Parameters

Type	Name	Description
Integer	id

Returns

Type	Description
NSHeadingEntity[]

Examples

NSListAgent agent;
Integer id;
NSHeadingEntity[] res = agent.GetHeadingsFromListDefinition(id);

GetHeadingsFromName(String)

Gets headings for list resolved by the provided name.

Introduced or updated in version: 8.2

Declaration

NSHeadingEntity[] GetHeadingsFromName(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
NSHeadingEntity[]

Examples

NSListAgent agent;
String name;
NSHeadingEntity[] res = agent.GetHeadingsFromName(name);

GetHierarchyEntity(Integer)

Gets an NSHierarchyEntity object.

Introduced or updated in version: 7

Declaration

NSHierarchyEntity GetHierarchyEntity(Integer hierarchyEntityId)

Parameters

Type	Name	Description
Integer	hierarchyEntityId

Returns

Type	Description
NSHierarchyEntity

Examples

NSListAgent agent;
NSHierarchyEntity thing = agent.GetHierarchyEntity(123);

GetHierarchyFromPath(Integer,String,Bool)

Gets a hierarchy item from a path

Introduced or updated in version: 7

Declaration

NSHierarchyEntity GetHierarchyFromPath(Integer domain, String path, Bool children)

Parameters

Type	Name	Description
Integer	domain	See Domain.
String	path
Bool	children

Returns

Type	Description
NSHierarchyEntity

Examples

NSListAgent agent;
Integer domain;
String path;
Bool children;
NSHierarchyEntity res = agent.GetHierarchyFromPath(domain, path, children);

GetInstalledLanguages()

Returns the list of all languages installed in this database.

Introduced or updated in version: 7

Declaration

NSLanguageInfo[] GetInstalledLanguages()

Returns

Type	Description
NSLanguageInfo[]

Examples

NSListAgent agent;
NSLanguageInfo[] res = agent.GetInstalledLanguages();

GetLanguageInfo(Integer)

Gets an NSLanguageInfo object.

Introduced or updated in version: 7

Declaration

NSLanguageInfo GetLanguageInfo(Integer languageInfoId)

Parameters

Type	Name	Description
Integer	languageInfoId

Returns

Type	Description
NSLanguageInfo

Examples

NSListAgent agent;
NSLanguageInfo thing = agent.GetLanguageInfo(123);

GetLanguageInfoList(Integer[])

Gets an array of NSLanguageInfo objects.

Introduced or updated in version: 7

Declaration

NSLanguageInfo[] GetLanguageInfoList(Integer[]  languageInfoIds)

Parameters

Type	Name	Description
Integer[]	languageInfoIds

Returns

Type	Description
NSLanguageInfo[]

Examples

Integer[] ids;
NSListAgent agent;
NSLanguageInfo[] res = agent.GetLanguageInfoList(ids);

GetLegalBase(Integer)

Gets an NSLegalBase object.

Introduced or updated in version: 8.2

Declaration

NSLegalBase GetLegalBase(Integer legalBaseId)

Parameters

Type	Name	Description
Integer	legalBaseId

Returns

Type	Description
NSLegalBase

Examples

NSListAgent agent;
NSLegalBase thing = agent.GetLegalBase(123);

GetLegalBaseList(Integer[])

Gets an array of NSLegalBase objects.

Introduced or updated in version: 8.2

Declaration

NSLegalBase[] GetLegalBaseList(Integer[]  legalBaseIds)

Parameters

Type	Name	Description
Integer[]	legalBaseIds

Returns

Type	Description
NSLegalBase[]

Examples

Integer[] ids;
NSListAgent agent;
NSLegalBase[] res = agent.GetLegalBaseList(ids);

GetLegalBases()

Returns all defined bases.

Introduced or updated in version: 8.2

Declaration

NSLegalBase[] GetLegalBases()

Returns

Type	Description
NSLegalBase[]

Examples

NSListAgent agent;
NSLegalBase[] res = agent.GetLegalBases();

GetLink(Integer)

Gets an NSLink object.

Introduced or updated in version: 7

Declaration

NSLink GetLink(Integer linkId)

Parameters

Type	Name	Description
Integer	linkId

Returns

Type	Description
NSLink

Examples

NSListAgent agent;
NSLink thing = agent.GetLink(123);

GetLinkList(Integer[])

Gets an array of Link objects.

Introduced or updated in version: 7

Declaration

NSLink[] GetLinkList(Integer[]  linkIds)

Parameters

Type	Name	Description
Integer[]	linkIds

Returns

Type	Description
NSLink[]

Examples

Integer[] ids;
NSListAgent agent;
NSLink[] res = agent.GetLinkList(ids);

GetListDefinitions(Bool)

Gets a list of the lists, built-in and user-defined.

Introduced or updated in version: 8.2

Declaration

NSListEntity[] GetListDefinitions(Bool includeDeleted)

Parameters

Type	Name	Description
Bool	includeDeleted

Returns

Type	Description
NSListEntity[]

Examples

NSListAgent agent;
Bool includeDeleted;
NSListEntity[] res = agent.GetListDefinitions(includeDeleted);

GetListEntity(Integer)

Gets an NSListEntity object.

Introduced or updated in version: 7.5

Declaration

NSListEntity GetListEntity(Integer listEntityId)

Parameters

Type	Name	Description
Integer	listEntityId

Returns

Type	Description
NSListEntity

Examples

NSListAgent agent;
NSListEntity thing = agent.GetListEntity(123);

GetListEntityByName(String)

Gets an NSListEntity resolved by the provided name.

Introduced or updated in version: 8.2

Declaration

NSListEntity GetListEntityByName(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
NSListEntity

Examples

NSListAgent agent;
String name;
NSListEntity res = agent.GetListEntityByName(name);

GetListItemsForHeading(Integer,Integer)

Introduced or updated in version: 8.2

Declaration

NSSelectableMDOListItem[] GetListItemsForHeading(Integer udListDefinitionId, Integer headingId)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	headingId

Returns

Type	Description
NSSelectableMDOListItem[]	List of list items that is selected if under this heading.

Examples

NSListAgent agent;
Integer udListDefinitionId;
Integer headingId;
NSSelectableMDOListItem[] res = agent.GetListItemsForHeading(udListDefinitionId, headingId);

GetListItemsForHeadingFromListName(String,Integer)

Introduced or updated in version: 8.2

Declaration

NSSelectableMDOListItem[] GetListItemsForHeadingFromListName(String udListDefinitionName, Integer headingId)

Parameters

Type	Name	Description
String	udListDefinitionName
Integer	headingId

Returns

Type	Description
NSSelectableMDOListItem[]	List of list items that is selected if under this heading.

Examples

NSListAgent agent;
String udListDefinitionName;
Integer headingId;
NSSelectableMDOListItem[] res = agent.GetListItemsForHeadingFromListName(udListDefinitionName, headingId);

GetListItemsForUserGroup(Integer,Integer)

Introduced or updated in version: 8.2

Declaration

NSSelectableMDOListItem[] GetListItemsForUserGroup(Integer udListDefinitionId, Integer groupId)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	groupId

Returns

Type	Description
NSSelectableMDOListItem[]	List of list items that is visible in the usergroup.

Examples

NSListAgent agent;
Integer udListDefinitionId;
Integer groupId;
NSSelectableMDOListItem[] res = agent.GetListItemsForUserGroup(udListDefinitionId, groupId);

GetListItemsForUserGroupFromListName(String,Integer)

Introduced or updated in version: 8.2

Declaration

NSSelectableMDOListItem[] GetListItemsForUserGroupFromListName(String udListDefinitionName, Integer groupId)

Parameters

Type	Name	Description
String	udListDefinitionName
Integer	groupId

Returns

Type	Description
NSSelectableMDOListItem[]	List of list items that is visible in the usergroup.

Examples

NSListAgent agent;
String udListDefinitionName;
Integer groupId;
NSSelectableMDOListItem[] res = agent.GetListItemsForUserGroupFromListName(udListDefinitionName, groupId);

GetLocalizedText(Integer)

Gets an NSLocalizedText object.

Introduced or updated in version: 7

Declaration

NSLocalizedText GetLocalizedText(Integer localizedTextId)

Parameters

Type	Name	Description
Integer	localizedTextId

Returns

Type	Description
NSLocalizedText

Examples

NSListAgent agent;
NSLocalizedText thing = agent.GetLocalizedText(123);

GetLocalizedTextByType(Integer,Integer,Integer)

Returns a localized text based on the resource ID for the selected language.

Introduced or updated in version: 7

Declaration

NSLocalizedText GetLocalizedTextByType(Integer textType, Integer resourceId, Integer languageId)

Parameters

Type	Name	Description
Integer	textType
Integer	resourceId
Integer	languageId

Returns

Type	Description
NSLocalizedText

Examples

NSListAgent agent;
Integer textType;
Integer resourceId;
Integer languageId;
NSLocalizedText res = agent.GetLocalizedTextByType(textType, resourceId, languageId);

GetLocalizedTextList(Integer[])

Gets an array of NSLocalizedText objects.

Introduced or updated in version: 7

Declaration

NSLocalizedText[] GetLocalizedTextList(Integer[]  localizedTextIds)

Parameters

Type	Name	Description
Integer[]	localizedTextIds

Returns

Type	Description
NSLocalizedText[]

Examples

Integer[] ids;
NSListAgent agent;
NSLocalizedText[] res = agent.GetLocalizedTextList(ids);

GetLocalizedTexts()

Gets all localized texts in the CRM database.

Introduced or updated in version: 7

Declaration

NSLocalizedText[] GetLocalizedTexts()

Returns

Type	Description
NSLocalizedText[]

Examples

NSListAgent agent;
NSLocalizedText[] res = agent.GetLocalizedTexts();

GetLocalizedTextsByLanguageId(Integer)

Gets all localized text belonging to a specific language.

Introduced or updated in version: 7

Declaration

NSLocalizedText[] GetLocalizedTextsByLanguageId(Integer languageId)

Parameters

Type	Name	Description
Integer	languageId

Returns

Type	Description
NSLocalizedText[]

Examples

NSListAgent agent;
Integer languageId;
NSLocalizedText[] res = agent.GetLocalizedTextsByLanguageId(languageId);

GetLocalizedTextsByType(Integer[])

Gets localized text by their typeGets localized text by their type.

Introduced or updated in version: 7

Declaration

NSLocalizedText[] GetLocalizedTextsByType(Integer[] textTypes)

Parameters

Type	Name	Description
Integer[]	textTypes	Array of localized text types. If null, all texts are returned. See LocalizedTextType.

Returns

Type	Description
NSLocalizedText[]

Examples

NSListAgent agent;
LocalizedTextType[] textTypes;
NSLocalizedText[] res = agent.GetLocalizedTextsByType(textTypes);

GetMrMrs(Integer)

Gets an NSMrMrs object.

Introduced or updated in version: 7

Declaration

NSMrMrs GetMrMrs(Integer mrMrsId)

Parameters

Type	Name	Description
Integer	mrMrsId

Returns

Type	Description
NSMrMrs

Examples

NSListAgent agent;
NSMrMrs thing = agent.GetMrMrs(123);

GetMrMrses()

Returns all Items from the NSMrMrs table sorted by their value.

Introduced or updated in version: 7

Declaration

NSMrMrs[] GetMrMrses()

Returns

Type	Description
NSMrMrs[]

Examples

NSListAgent agent;
NSMrMrs[] res = agent.GetMrMrses();

GetMrMrsList(Integer[])

Gets an array of NSMrMrs objects.

Introduced or updated in version: 7

Declaration

NSMrMrs[] GetMrMrsList(Integer[]  mrMrsIds)

Parameters

Type	Name	Description
Integer[]	mrMrsIds

Returns

Type	Description
NSMrMrs[]

Examples

Integer[] ids;
NSListAgent agent;
NSMrMrs[] res = agent.GetMrMrsList(ids);

GetOurCurrency()

Gets the Our currency object if currency is enabled

Introduced or updated in version: 7

Declaration

NSCurrency GetOurCurrency()

Returns

Type	Description
NSCurrency

Examples

NSListAgent agent;
NSCurrency res = agent.GetOurCurrency();

GetOwnerCompanysCurrency()

Gets the currency of the user's owner company

Introduced or updated in version: 7

Declaration

NSCurrency GetOwnerCompanysCurrency()

Returns

Type	Description
NSCurrency

Examples

NSListAgent agent;
NSCurrency res = agent.GetOwnerCompanysCurrency();

GetPaymentTerm(Integer)

Gets an NSPaymentTerm object.

Introduced or updated in version: 8.0sr3

Declaration

NSPaymentTerm GetPaymentTerm(Integer paymentTermId)

Parameters

Type	Name	Description
Integer	paymentTermId

Returns

Type	Description
NSPaymentTerm

Examples

NSListAgent agent;
NSPaymentTerm thing = agent.GetPaymentTerm(123);

GetPaymentTerms()

Returns all PaymentTerms in SuperOffice database.

Introduced or updated in version: 8.0sr3

Declaration

NSPaymentTerm[] GetPaymentTerms()

Returns

Type	Description
NSPaymentTerm[]

Examples

NSListAgent agent;
NSPaymentTerm[] res = agent.GetPaymentTerms();

GetPaymentType(Integer)

Gets an NSPaymentType object.

Introduced or updated in version: 8.0sr3

Declaration

NSPaymentType GetPaymentType(Integer paymentTypeId)

Parameters

Type	Name	Description
Integer	paymentTypeId

Returns

Type	Description
NSPaymentType

Examples

NSListAgent agent;
NSPaymentType thing = agent.GetPaymentType(123);

GetPaymentTypes()

Returns all PaymentTypes in SuperOffice database.

Introduced or updated in version: 8.0sr3

Declaration

NSPaymentType[] GetPaymentTypes()

Returns

Type	Description
NSPaymentType[]

Examples

NSListAgent agent;
NSPaymentType[] res = agent.GetPaymentTypes();

GetPluginCapabilities(Integer)

Gets a list of plugin-dependent capabilities for a given document archive plugin.

Introduced or updated in version: 8.2

Declaration

Map GetPluginCapabilities(Integer pluginId)

Parameters

Type	Name	Description
Integer	pluginId

Returns

Type	Description
Map

Remarks

A standard set of properties is defined in SuperOffice.CRM.Documents.Constants.Capabilities.

Examples

NSListAgent agent;
Integer pluginId;
Map res = agent.GetPluginCapabilities(pluginId);

GetPluginList()

Gets a list of installed document plugins

Introduced or updated in version: 8.2

Declaration

Map GetPluginList()

Returns

Type	Description
Map

Examples

NSListAgent agent;
Map res = agent.GetPluginList();

GetPosition(Integer)

Gets an NSPosition object.

Introduced or updated in version: 7

Declaration

NSPosition GetPosition(Integer positionId)

Parameters

Type	Name	Description
Integer	positionId

Returns

Type	Description
NSPosition

Examples

NSListAgent agent;
NSPosition thing = agent.GetPosition(123);

GetPositionList(Integer[])

Gets an array of NSPosition objects.

Introduced or updated in version: 7

Declaration

NSPosition[] GetPositionList(Integer[]  positionIds)

Parameters

Type	Name	Description
Integer[]	positionIds

Returns

Type	Description
NSPosition[]

Examples

Integer[] ids;
NSListAgent agent;
NSPosition[] res = agent.GetPositionList(ids);

GetPositions()

Returns all the positions a person could have.

Introduced or updated in version: 7

Declaration

NSPosition[] GetPositions()

Returns

Type	Description
NSPosition[]

Examples

NSListAgent agent;
NSPosition[] res = agent.GetPositions();

GetPriorities()

Returns all priorities an appointment could have.

Introduced or updated in version: 7

Declaration

NSPriority[] GetPriorities()

Returns

Type	Description
NSPriority[]

Examples

NSListAgent agent;
NSPriority[] res = agent.GetPriorities();

GetPriority(Integer)

Gets an NSPriority object.

Introduced or updated in version: 7

Declaration

NSPriority GetPriority(Integer priorityId)

Parameters

Type	Name	Description
Integer	priorityId

Returns

Type	Description
NSPriority

Examples

NSListAgent agent;
NSPriority thing = agent.GetPriority(123);

GetPriorityList(Integer[])

Gets an array of Priority objects.

Introduced or updated in version: 7

Declaration

NSPriority[] GetPriorityList(Integer[]  priorityIds)

Parameters

Type	Name	Description
Integer[]	priorityIds

Returns

Type	Description
NSPriority[]

Examples

Integer[] ids;
NSListAgent agent;
NSPriority[] res = agent.GetPriorityList(ids);

GetProductCategories()

Returns all ProductCategories in SuperOffice list.

Introduced or updated in version: 8.0sr3

Declaration

NSProductCategory[] GetProductCategories()

Returns

Type	Description
NSProductCategory[]

Examples

NSListAgent agent;
NSProductCategory[] res = agent.GetProductCategories();

GetProductCategory(Integer)

Gets an NSProductCategory object.

Introduced or updated in version: 8.0sr3

Declaration

NSProductCategory GetProductCategory(Integer productCategoryId)

Parameters

Type	Name	Description
Integer	productCategoryId

Returns

Type	Description
NSProductCategory

Examples

NSListAgent agent;
NSProductCategory thing = agent.GetProductCategory(123);

GetProductFamilies()

Returns all NSProductFamily in SuperOffice list.

Introduced or updated in version: 8.0sr3

Declaration

NSProductFamily[] GetProductFamilies()

Returns

Type	Description
NSProductFamily[]

Examples

NSListAgent agent;
NSProductFamily[] res = agent.GetProductFamilies();

GetProductFamily(Integer)

Gets an NSProductFamily object.

Introduced or updated in version: 8.0sr3

Declaration

NSProductFamily GetProductFamily(Integer productFamilyId)

Parameters

Type	Name	Description
Integer	productFamilyId

Returns

Type	Description
NSProductFamily

Examples

NSListAgent agent;
NSProductFamily thing = agent.GetProductFamily(123);

GetProductType(Integer)

Gets an NSProductType object.

Introduced or updated in version: 8.0sr3

Declaration

NSProductType GetProductType(Integer productTypeId)

Parameters

Type	Name	Description
Integer	productTypeId

Returns

Type	Description
NSProductType

Examples

NSListAgent agent;
NSProductType thing = agent.GetProductType(123);

GetProductTypes()

Returns all ProductTypes in SuperOffice list.

Introduced or updated in version: 8.0sr3

Declaration

NSProductType[] GetProductTypes()

Returns

Type	Description
NSProductType[]

Examples

NSListAgent agent;
NSProductType[] res = agent.GetProductTypes();

GetProjectStatus(Integer)

Gets an NSProjectStatus object.

Introduced or updated in version: 7

Declaration

NSProjectStatus GetProjectStatus(Integer projectStatusId)

Parameters

Type	Name	Description
Integer	projectStatusId

Returns

Type	Description
NSProjectStatus

Examples

NSListAgent agent;
NSProjectStatus thing = agent.GetProjectStatus(123);

GetProjectStatuses()

Gets all items from the Project Status (ProjStatus) table.

Introduced or updated in version: 7

Declaration

NSProjectStatus[] GetProjectStatuses()

Returns

Type	Description
NSProjectStatus[]

Examples

NSListAgent agent;
NSProjectStatus[] res = agent.GetProjectStatuses();

GetProjectStatusList(Integer[])

Gets an array of NSProjectStatus objects.

Introduced or updated in version: 7

Declaration

NSProjectStatus[] GetProjectStatusList(Integer[]  projectStatusIds)

Parameters

Type	Name	Description
Integer[]	projectStatusIds

Returns

Type	Description
NSProjectStatus[]

Examples

Integer[] ids;
NSListAgent agent;
NSProjectStatus[] res = agent.GetProjectStatusList(ids);

GetProjectType(Integer)

Gets an NSProjectType object.

Introduced or updated in version: 7

Declaration

NSProjectType GetProjectType(Integer projectTypeId)

Parameters

Type	Name	Description
Integer	projectTypeId

Returns

Type	Description
NSProjectType

Examples

NSListAgent agent;
NSProjectType thing = agent.GetProjectType(123);

GetProjectTypeEntity(Integer)

Gets an NSProjectTypeEntity object.

Introduced or updated in version: 7.5

Declaration

NSProjectTypeEntity GetProjectTypeEntity(Integer projectTypeEntityId)

Parameters

Type	Name	Description
Integer	projectTypeEntityId

Returns

Type	Description
NSProjectTypeEntity

Examples

NSListAgent agent;
NSProjectTypeEntity thing = agent.GetProjectTypeEntity(123);

GetProjectTypeList(Integer[])

Gets an array of NSProjectType objects.

Introduced or updated in version: 7

Declaration

NSProjectType[] GetProjectTypeList(Integer[]  projectTypeIds)

Parameters

Type	Name	Description
Integer[]	projectTypeIds

Returns

Type	Description
NSProjectType[]

Examples

Integer[] ids;
NSListAgent agent;
NSProjectType[] res = agent.GetProjectTypeList(ids);

GetProjectTypes()

Gets all items from the Project Type (ProjType) table.

Introduced or updated in version: 7

Declaration

NSProjectType[] GetProjectTypes()

Returns

Type	Description
NSProjectType[]

Examples

NSListAgent agent;
NSProjectType[] res = agent.GetProjectTypes();

GetQuickReplies()

Method to return all quick replies for a given associate

Introduced or updated in version: 8.2

Declaration

NSQuickReply[] GetQuickReplies()

Returns

Type	Description
NSQuickReply[]

Examples

NSListAgent agent;
NSQuickReply[] res = agent.GetQuickReplies();

GetRating(Integer)

Gets an NSRating object.

Introduced or updated in version: 7

Declaration

NSRating GetRating(Integer ratingId)

Parameters

Type	Name	Description
Integer	ratingId

Returns

Type	Description
NSRating

Examples

NSListAgent agent;
NSRating thing = agent.GetRating(123);

GetRatingList(Integer[])

Gets an array of NSRating objects.

Introduced or updated in version: 7

Declaration

NSRating[] GetRatingList(Integer[]  ratingIds)

Parameters

Type	Name	Description
Integer[]	ratingIds

Returns

Type	Description
NSRating[]

Examples

Integer[] ids;
NSListAgent agent;
NSRating[] res = agent.GetRatingList(ids);

GetRatings()

Returns all ratings

Introduced or updated in version: 7

Declaration

NSRating[] GetRatings()

Returns

Type	Description
NSRating[]

Examples

NSListAgent agent;
NSRating[] res = agent.GetRatings();

GetReason(Integer)

Gets an NSReason object.

Introduced or updated in version: 7

Declaration

NSReason GetReason(Integer reasonId)

Parameters

Type	Name	Description
Integer	reasonId	The identifier of the NSReason object.

Returns

Type	Description
NSReason

Examples

NSListAgent agent;
NSReason thing = agent.GetReason(123);

GetReasonList(Integer[])

Gets an array of NSReason objects.

Introduced or updated in version: 7

Declaration

NSReason[] GetReasonList(Integer[]  reasonIds)

Parameters

Type	Name	Description
Integer[]	reasonIds	The identifiers of the NSReason objects.

Returns

Type	Description
NSReason[]

Examples

Integer[] ids;
NSListAgent agent;
NSReason[] res = agent.GetReasonList(ids);

GetReasons()

Returns all reasons

Introduced or updated in version: 7

Declaration

NSReason[] GetReasons()

Returns

Type	Description
NSReason[]

Examples

NSListAgent agent;
NSReason[] res = agent.GetReasons();

GetReasonSold(Integer)

Gets an NSReasonSold object.

Introduced or updated in version: 7

Declaration

NSReasonSold GetReasonSold(Integer reasonSoldId)

Parameters

Type	Name	Description
Integer	reasonSoldId	The identifier of the NSReasonSold object.

Returns

Type	Description
NSReasonSold

Examples

NSListAgent agent;
NSReasonSold thing = agent.GetReasonSold(123);

GetReasonSoldList(Integer[])

Gets an array of ReasonSold objects.

Introduced or updated in version: 7

Declaration

NSReasonSold[] GetReasonSoldList(Integer[]  reasonSoldIds)

Parameters

Type	Name	Description
Integer[]	reasonSoldIds	The identifiers of the NSReasonSold objects.

Returns

Type	Description
NSReasonSold[]

Examples

Integer[] ids;
NSListAgent agent;
NSReasonSold[] res = agent.GetReasonSoldList(ids);

GetReasonStalled(Integer)

Gets an NSReasonStalled object.

Introduced or updated in version: 7

Declaration

NSReasonStalled GetReasonStalled(Integer reasonStalledId)

Parameters

Type	Name	Description
Integer	reasonStalledId	The identifier of the NSReasonStalled object.

Returns

Type	Description
NSReasonStalled

Examples

NSListAgent agent;
NSReasonStalled thing = agent.GetReasonStalled(123);

GetReasonStalledList(Integer[])

Gets an array of ReasonStalled objects.

Introduced or updated in version: 7

Declaration

NSReasonStalled[] GetReasonStalledList(Integer[]  reasonStalledIds)

Parameters

Type	Name	Description
Integer[]	reasonStalledIds	The identifiers of the NSReasonStalled objects.

Returns

Type	Description
NSReasonStalled[]

Examples

Integer[] ids;
NSListAgent agent;
NSReasonStalled[] res = agent.GetReasonStalledList(ids);

GetRelationDefinitionEntity(Integer)

Gets an NSRelationDefinitionEntity object.

Introduced or updated in version: 7.5

Declaration

NSRelationDefinitionEntity GetRelationDefinitionEntity(Integer relationDefinitionEntityId)

Parameters

Type	Name	Description
Integer	relationDefinitionEntityId	The identifier of the NSRelationDefinitionEntity object.

Returns

Type	Description
NSRelationDefinitionEntity

Examples

NSListAgent agent;
NSRelationDefinitionEntity thing = agent.GetRelationDefinitionEntity(123);

GetResourceEntity(Integer)

Gets an NSResourceEntity object.

Introduced or updated in version: 7.5

Declaration

NSResourceEntity GetResourceEntity(Integer resourceEntityId)

Parameters

Type	Name	Description
Integer	resourceEntityId	The identifier of the NSResourceEntity object.

Returns

Type	Description
NSResourceEntity

Examples

NSListAgent agent;
NSResourceEntity thing = agent.GetResourceEntity(123);

GetSaleStageEntity(Integer)

Gets an NSSaleStageEntity object.

Introduced or updated in version: 7.5

Declaration

NSSaleStageEntity GetSaleStageEntity(Integer saleStageEntityId)

Parameters

Type	Name	Description
Integer	saleStageEntityId

Returns

Type	Description
NSSaleStageEntity

Examples

NSListAgent agent;
NSSaleStageEntity thing = agent.GetSaleStageEntity(123);

GetSaleType(Integer)

Gets an NSSaleType object.

Introduced or updated in version: 7

Declaration

NSSaleType GetSaleType(Integer saleTypeId)

Parameters

Type	Name	Description
Integer	saleTypeId

Returns

Type	Description
NSSaleType

Examples

NSListAgent agent;
NSSaleType thing = agent.GetSaleType(123);

GetSaleTypeEntity(Integer)

Gets an NSSaleTypeEntity object.

Introduced or updated in version: 7.5

Declaration

NSSaleTypeEntity GetSaleTypeEntity(Integer saleTypeEntityId)

Parameters

Type	Name	Description
Integer	saleTypeEntityId

Returns

Type	Description
NSSaleTypeEntity

Examples

NSListAgent agent;
NSSaleTypeEntity thing = agent.GetSaleTypeEntity(123);

GetSaleTypeList(Integer[])

Gets an array of NSSaleType objects.

Introduced or updated in version: 7

Declaration

NSSaleType[] GetSaleTypeList(Integer[]  saleTypeIds)

Parameters

Type	Name	Description
Integer[]	saleTypeIds

Returns

Type	Description
NSSaleType[]

Examples

Integer[] ids;
NSListAgent agent;
NSSaleType[] res = agent.GetSaleTypeList(ids);

GetSelectionCategory(Integer)

Gets an NSSelectionCategory object.

Introduced or updated in version: 7

Declaration

NSSelectionCategory GetSelectionCategory(Integer selectionCategoryId)

Parameters

Type	Name	Description
Integer	selectionCategoryId

Returns

Type	Description
NSSelectionCategory

Examples

NSListAgent agent;
NSSelectionCategory thing = agent.GetSelectionCategory(123);

GetSelectionCategoryList(Integer[])

Gets an array of SelectionCategory objects.

Introduced or updated in version: 7

Declaration

NSSelectionCategory[] GetSelectionCategoryList(Integer[]  selectionCategoryIds)

Parameters

Type	Name	Description
Integer[]	selectionCategoryIds

Returns

Type	Description
NSSelectionCategory[]

Examples

Integer[] ids;
NSListAgent agent;
NSSelectionCategory[] res = agent.GetSelectionCategoryList(ids);

GetSource(Integer)

Gets an NSSource object.

Introduced or updated in version: 7

Declaration

NSSource GetSource(Integer sourceId)

Parameters

Type	Name	Description
Integer	sourceId

Returns

Type	Description
NSSource

Examples

NSListAgent agent;
NSSource thing = agent.GetSource(123);

GetSourceList(Integer[])

Gets an array of Source objects.

Introduced or updated in version: 7

Declaration

NSSource[] GetSourceList(Integer[]  sourceIds)

Parameters

Type	Name	Description
Integer[]	sourceIds

Returns

Type	Description
NSSource[]

Examples

Integer[] ids;
NSListAgent agent;
NSSource[] res = agent.GetSourceList(ids);

GetSources()

Returns all sources

Introduced or updated in version: 7

Declaration

NSSource[] GetSources()

Returns

Type	Description
NSSource[]

Examples

NSListAgent agent;
NSSource[] res = agent.GetSources();

GetTask(Integer)

Gets an NSTask object.

Introduced or updated in version: 7

Declaration

NSTask GetTask(Integer taskId)

Parameters

Type	Name	Description
Integer	taskId

Returns

Type	Description
NSTask

Examples

NSListAgent agent;
NSTask thing = agent.GetTask(123);

GetTaskList(Integer[])

Gets an array of Task objects.

Introduced or updated in version: 7

Declaration

NSTask[] GetTaskList(Integer[]  taskIds)

Parameters

Type	Name	Description
Integer[]	taskIds

Returns

Type	Description
NSTask[]

Examples

Integer[] ids;
NSListAgent agent;
NSTask[] res = agent.GetTaskList(ids);

GetTasks()

Returns all appointment tasks

Introduced or updated in version: 7

Declaration

NSTask[] GetTasks()

Returns

Type	Description
NSTask[]

Examples

NSListAgent agent;
NSTask[] res = agent.GetTasks();

GetTicketCategories()

Introduced or updated in version: 8.5R08

Declaration

NSTicketCategoryEntity[] GetTicketCategories()

Returns

Type	Description
NSTicketCategoryEntity[]

Examples

NSListAgent agent;
NSTicketCategoryEntity[] thing = agent.GetTicketCategories();

GetTicketCategoriesForUserGroups(Integer[])

Introduced or updated in version: 8.5R08

Declaration

NSMDOListItem[] GetTicketCategoriesForUserGroups(Integer[] userGroupIds)

Parameters

Type	Name	Description
Integer[]	userGroupIds

Returns

Type	Description
NSMDOListItem[]	Ticket categories for user groups.

GetTicketCategory(Integer)

Gets an NSTicketCategory object.

Introduced or updated in version: 7

Declaration

NSTicketCategory GetTicketCategory(Integer ticketCategoryId)

Parameters

Type	Name	Description
Integer	ticketCategoryId

Returns

Type	Description
NSTicketCategory

Examples

NSListAgent agent;
NSTicketCategory thing = agent.GetTicketCategory(123);

GetTicketCategoryEntity(Integer)

Gets an NSTicketCategoryEntity object.

Introduced or updated in version: 8.5R08

Declaration

NSTicketCategoryEntity GetTicketCategoryEntity(Integer ticketCategoryEntityId)

Parameters

Type	Name	Description
Integer	ticketCategoryEntityId

Returns

Type	Description
NSTicketCategoryEntity

Examples

NSListAgent agent;
NSTicketCategoryEntity thing = agent.GetTicketCategoryEntity(123);

GetTicketCategoryList(Integer[])

Gets an array of NSTicketCategoryEntity objects.

Introduced or updated in version: 8.5R08

Declaration

NSTicketCategoryEntity[] GetTicketCategoryList(Integer[]  ticketCategoryEntityIds)

Parameters

Type	Name	Description
Integer[]	ticketCategoryEntityIds

Returns

Type	Description
NSTicketCategoryEntity[]

Examples

Integer[] ids;
NSListAgent agent;
NSTicketCategoryEntity[] res = agent.GetTicketCategoryList(ids);

GetTicketPriorities()

Introduced or updated in version: 7

Declaration

NSTicketPriority[] GetTicketPriorities()

Returns

Type	Description
NSTicketPriority[]

Examples

NSListAgent agent;
NSTicketPriority[] thing = agent.GetTicketPriorities();

GetTicketPriority(Integer)

Gets an NSTicketPriority object.

Introduced or updated in version: 7

Declaration

NSTicketPriority GetTicketPriority(Integer ticketPriorityId)

Parameters

Type	Name	Description
Integer	ticketPriorityId

Returns

Type	Description
NSTicketPriority

Examples

NSListAgent agent;
NSTicketPriority thing = agent.GetTicketPriority(123);

GetTicketPriorityEntity(Integer)

Gets an NSTicketPriorityEntity object.

Introduced or updated in version: 8.5R08

Declaration

NSTicketPriorityEntity GetTicketPriorityEntity(Integer ticketPriorityEntityId)

Parameters

Type	Name	Description
Integer	ticketPriorityEntityId

Returns

Type	Description
NSTicketPriorityEntity

Examples

NSListAgent agent;
NSTicketPriorityEntity thing = agent.GetTicketPriorityEntity(123);

GetTicketPriorityList(Integer[])

Gets an array of NSTicketPriority objects.

Introduced or updated in version: 7

Declaration

NSTicketPriority[] GetTicketPriorityList(Integer[]  ticketPriorityIds)

Parameters

Type	Name	Description
Integer[]	ticketPriorityIds

Returns

Type	Description
NSTicketPriority[]

Examples

Integer[] ids;
NSListAgent agent;
NSTicketPriority[] res = agent.GetTicketPriorityList(ids);

GetTicketStatusEntity(Integer)

Gets an NSTicketStatusEntity object.

Introduced or updated in version: 8.5R08

Declaration

NSTicketStatusEntity GetTicketStatusEntity(Integer ticketStatusEntityId)

Parameters

Type	Name	Description
Integer	ticketStatusEntityId

Returns

Type	Description
NSTicketStatusEntity

Examples

NSListAgent agent;
NSTicketStatusEntity thing = agent.GetTicketStatusEntity(123);

GetTicketStatuses()

Introduced or updated in version: 8.5R08

Declaration

NSTicketStatusEntity[] GetTicketStatuses()

Returns

Type	Description
NSTicketStatusEntity[]

Examples

NSListAgent agent;
NSTicketStatusEntity[] res = agent.GetTicketStatuses();

GetTicketStatusList(Integer[])

Gets an array of NSTicketStatusEntity objects.

Introduced or updated in version: 8.5R08

Declaration

NSTicketStatusEntity[] GetTicketStatusList(Integer[]  ticketStatusEntityIds)

Parameters

Type	Name	Description
Integer[]	ticketStatusEntityIds

Returns

Type	Description
NSTicketStatusEntity[]

Examples

Integer[] ids;
NSListAgent agent;
NSTicketStatusEntity[] res = agent.GetTicketStatusList(ids);

GetVisibleForUserGroups(Integer,Integer)

Introduced or updated in version: 7.5

Declaration

NSSelectableMDOListItem[] GetVisibleForUserGroups(Integer udListDefinitionId, Integer listItemId)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	listItemId

Returns

Type	Description
NSSelectableMDOListItem[]	List of User groups that this list item is visible for.

Examples

NSListAgent agent;
Integer udListDefinitionId;
Integer listItemId;
NSSelectableMDOListItem[] res = agent.GetVisibleForUserGroups(udListDefinitionId, listItemId);

GetVisibleForUserGroupsFromListName(String,Integer)

Introduced or updated in version: 8.2

Declaration

NSSelectableMDOListItem[] GetVisibleForUserGroupsFromListName(String udListDefinitionName, Integer listItemId)

Parameters

Type	Name	Description
String	udListDefinitionName
Integer	listItemId

Returns

Type	Description
NSSelectableMDOListItem[]	List of User groups that this list item is visible for.

Examples

NSListAgent agent;
String udListDefinitionName;
Integer listItemId;
NSSelectableMDOListItem[] res = agent.GetVisibleForUserGroupsFromListName(udListDefinitionName, listItemId);

GetWebPanelByProgId(String)

Gets a web panel using the ProgId key that was specified when it was created

Introduced or updated in version: 8.0sr3

Declaration

NSWebPanelEntity GetWebPanelByProgId(String progId)

Parameters

Type	Name	Description
String	progId

Returns

Type	Description
NSWebPanelEntity

Examples

NSListAgent agent;
String progId;
NSWebPanelEntity res = agent.GetWebPanelByProgId(progId);

GetWebPanelEntity(Integer)

Gets an NSWebPanelEntity object.

Introduced or updated in version: 7.5

Declaration

NSWebPanelEntity GetWebPanelEntity(Integer webPanelEntityId)

Parameters

Type	Name	Description
Integer	webPanelEntityId

Returns

Type	Description
NSWebPanelEntity

Examples

NSListAgent agent;
NSWebPanelEntity thing = agent.GetWebPanelEntity(123);

GetWebPanelList()

Return a list of all web panels.

Introduced or updated in version: 7.5

Declaration

NSWebPanelEntity[] GetWebPanelList()

Returns

Type	Description
NSWebPanelEntity[]

Examples

NSListAgent agent;
NSWebPanelEntity[] res = agent.GetWebPanelList();

GlobalChangeTicketStatus(Integer,Integer)

Changes all references from one ticket status to another.

Introduced or updated in version: 8.5R08

Declaration

Void GlobalChangeTicketStatus(Integer fromTicketStatusId, Integer toTicketStatusId)

Parameters

Type	Name	Description
Integer	fromTicketStatusId
Integer	toTicketStatusId

Returns

Type	Description
Void

Remarks

Typically used in conjunction with delete.

Examples

NSListAgent agent;
Integer fromTicketStatusId;
Integer toTicketStatusId;
agent.GlobalChangeTicketStatus(fromTicketStatusId, toTicketStatusId);

MoveAllTickets(Integer,Integer)

Moves all tickets from one ticket category to another

Introduced or updated in version: 8.5R08

Declaration

Void MoveAllTickets(Integer fromTicketCategoryId, Integer toTicketCategoryId)

Parameters

Type	Name	Description
Integer	fromTicketCategoryId
Integer	toTicketCategoryId

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer fromTicketCategoryId;
Integer toTicketCategoryId;
agent.MoveAllTickets(fromTicketCategoryId, toTicketCategoryId);

MoveListItem(Integer,Integer,Integer)

Moves a list item up or down in the list based on rank

Introduced or updated in version: 7.5

Declaration

Void MoveListItem(Integer udListDefinitionId, Integer listItemId, Integer direction)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	listItemId
Integer	direction

Returns

Type	Description
Void

RebuildFullnames()

Updates the fullname field of all categories

Introduced or updated in version: 8.5R08

Declaration

Void RebuildFullnames()

Returns

Type	Description
Void

Remarks

Use this for example when changing parentId or renaming a category with children.

Examples

NSListAgent agent;
agent.RebuildFullnames();

SaveAllFromListDefinition(Integer,NSListItemEntity[])

Saves all list items for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity[] SaveAllFromListDefinition(Integer udListDefinitionId, NSListItemEntity[] items)

Parameters

Type	Name	Description
Integer	udListDefinitionId
NSListItemEntity[]	items

Returns

Type	Description
NSListItemEntity[]

Examples

NSListAgent agent;
Integer udListDefinitionId;
NSListItemEntity[] items;
NSListItemEntity[] res = agent.SaveAllFromListDefinition(udListDefinitionId, items);

SaveAllFromListName(String,NSListItemEntity[])

Saves all list items for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity[] SaveAllFromListName(String udListDefinitionName, NSListItemEntity[] items)

Parameters

Type	Name	Description
String	udListDefinitionName
NSListItemEntity[]	items

Returns

Type	Description
NSListItemEntity[]

Examples

NSListAgent agent;
String udListDefinitionName;
NSListItemEntity[] items;
NSListItemEntity[] res = agent.SaveAllFromListName(udListDefinitionName, items);

SaveAmountClassEntity(NSAmountClassEntity)

Updates the existing NSAmountClassEntity or creates a new NSAmountClassEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSAmountClassEntity SaveAmountClassEntity(NSAmountClassEntity amountClassEntity)

Parameters

Type	Name	Description
NSAmountClassEntity	amountClassEntity	The NSAmountClassEntity to save.

Returns

Type	Description
NSAmountClassEntity

Examples

NSList  agent;
NSAmountClassEntity thing = agent.CreateDefaultAmountClassEntity();
thing = agent.SaveAmountClassEntity(thing);

SaveConsentPurpose(NSConsentPurpose)

Saves an NSConsentPurpose object

Introduced or updated in version: 8.2

Declaration

NSConsentPurpose SaveConsentPurpose(NSConsentPurpose consentPurpose)

Parameters

Type	Name	Description
NSConsentPurpose	consentPurpose

Returns

Type	Description
NSConsentPurpose

Examples

NSListAgent agent;
NSConsentPurpose consentPurpose;
NSConsentPurpose res = agent.SaveConsentPurpose(consentPurpose);

SaveConsentSource(NSConsentSource)

Introduced or updated in version: 8.2

Declaration

NSConsentSource SaveConsentSource(NSConsentSource consentSource)

Parameters

Type	Name	Description
NSConsentSource	consentSource

Returns

Type	Description
NSConsentSource

Examples

NSListAgent agent;
NSConsentSource consentSource;
NSConsentSource res = agent.SaveConsentSource(consentSource);

SaveCountry(NSCountry)

Saves a country

Introduced or updated in version: 7.5

Declaration

NSCountry SaveCountry(NSCountry country)

Parameters

Type	Name	Description
NSCountry	country

Returns

Type	Description
NSCountry

Examples

NSListAgent agent;
NSCountry country;
NSCountry res = agent.SaveCountry(country);

SaveCurrencyEntity(NSCurrencyEntity)

Updates the existing NSCurrencyEntity or creates a new NSCurrencyEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSCurrencyEntity SaveCurrencyEntity(NSCurrencyEntity currencyEntity)

Parameters

Type	Name	Description
NSCurrencyEntity	currencyEntity	The NSCurrencyEntity to save.

Returns

Type	Description
NSCurrencyEntity

Examples

NSList agent;
NSCurrencyEntity thing = agent.CreateDefaultCurrencyEntity();
thing = agent.SaveCurrencyEntity(thing);

SaveDocumentTemplateEntity(NSDocumentTemplateEntity)

Updates the existing NSDocumentTemplateEntity or creates a new NSDocumentTemplateEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSDocumentTemplateEntity SaveDocumentTemplateEntity(NSDocumentTemplateEntity documentTemplateEntity)

Parameters

Type	Name	Description
NSDocumentTemplateEntity	documentTemplateEntity	The NSDocumentTemplateEntity to save.

Returns

Type	Description
NSDocumentTemplateEntity

Examples

NSList  agent;
NSDocumentTemplateEntity thing = agent.CreateDefaultDocumentTemplateEntity();
thing = agent.SaveDocumentTemplateEntity(thing);

SaveDocumentTemplateStream(Integer,NSStream,String,Integer)

Writes content in stream to document template file

Introduced or updated in version: 8.2

Declaration

NSTemplateInfo SaveDocumentTemplateStream(Integer documentTemplateId, NSStream content, String languageCode, Integer pluginId)

Parameters

Type	Name	Description
Integer	documentTemplateId
NSStream	content
String	languageCode
Integer	pluginId

Returns

Type	Description
NSTemplateInfo

Examples

NSListAgent agent;
Integer documentTemplateId;
NSStream content;
String languageCode;
Integer pluginId;
NSTemplateInfo res = agent.SaveDocumentTemplateStream(documentTemplateId, content, languageCode, pluginId);

SaveExtAppEntity(NSExtAppEntity)

Updates the existing NSExtAppEntity or creates a new NSExtAppEntity if the id parameter is 0

Introduced or updated in version: 8.0sr3

Declaration

NSExtAppEntity SaveExtAppEntity(NSExtAppEntity extAppEntity)

Parameters

Type	Name	Description
NSExtAppEntity	extAppEntity	The NSExtAppEntity to save.

Returns

Type	Description
NSExtAppEntity

Examples

NSList  agent;
NSExtAppEntity thing = agent.CreateDefaultExtAppEntity();
thing = agent.SaveExtAppEntity(thing);

SaveFromListDefinition(Integer,Integer,NSListItemEntity)

Saves a list item for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity SaveFromListDefinition(Integer id, Integer udListDefinitionId, NSListItemEntity item)

Parameters

Type	Name	Description
Integer	id
Integer	udListDefinitionId
NSListItemEntity	item

Returns

Type	Description
NSListItemEntity

Examples

NSListAgent agent;
Integer id;
Integer udListDefinitionId;
NSListItemEntity item;
NSListItemEntity res = agent.SaveFromListDefinition(id, udListDefinitionId, item);

SaveFromListName(Integer,String,NSListItemEntity)

Saves a list item for the specified list definition

Introduced or updated in version: 8.2

Declaration

NSListItemEntity SaveFromListName(Integer id, String udListDefinitionName, NSListItemEntity item)

Parameters

Type	Name	Description
Integer	id
String	udListDefinitionName
NSListItemEntity	item

Returns

Type	Description
NSListItemEntity

Examples

NSListAgent agent;
Integer id;
String udListDefinitionName;
NSListItemEntity item;
NSListItemEntity res = agent.SaveFromListName(id, udListDefinitionName, item);

SaveHeadingEntity(NSHeadingEntity)

Updates the existing NSHeadingEntity or creates a new NSHeadingEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSHeadingEntity SaveHeadingEntity(NSHeadingEntity headingEntity)

Parameters

Type	Name	Description
NSHeadingEntity	headingEntity	The NSHeadingEntity to save.

Returns

Type	Description
NSHeadingEntity

Examples

NSList  agent;
NSHeadingEntity thing = agent.CreateDefaultHeadingEntity();
thing = agent.SaveHeadingEntity(thing);

SaveHeadingFromListDefinition(Integer,NSHeadingEntity)

Saves new heading for list resolved by the provided ID.

Introduced or updated in version: 8.2

Declaration

NSHeadingEntity SaveHeadingFromListDefinition(Integer id, NSHeadingEntity entity)

Parameters

Type	Name	Description
Integer	id
NSHeadingEntity	entity

Returns

Type	Description
NSHeadingEntity

Examples

NSListAgent agent;
Integer id;
NSHeadingEntity entity;
NSHeadingEntity res = agent.SaveHeadingFromListDefinition(id, entity);

SaveHeadingFromName(String,NSHeadingEntity)

Saves new heading for list resolved by the provided name.

Introduced or updated in version: 8.2

Declaration

NSHeadingEntity SaveHeadingFromName(String name, NSHeadingEntity entity)

Parameters

Type	Name	Description
String	name
NSHeadingEntity	entity

Returns

Type	Description
NSHeadingEntity

Examples

NSListAgent agent;
String name;
NSHeadingEntity entity;
NSHeadingEntity res = agent.SaveHeadingFromName(name, entity);

SaveHeadingsForListItemFromListDefinition(Integer,Integer,NSSelectableMDOListItem[])

Saves the active headings for the list item.

Introduced or updated in version: 8.2

Declaration

NSSelectableMDOListItem[] SaveHeadingsForListItemFromListDefinition(Integer udListDefinitionId, Integer listItemId, NSSelectableMDOListItem[] headings)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	listItemId
NSSelectableMDOListItem[]	headings

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

NSListAgent agent;
Integer udListDefinitionId;
Integer listItemId;
NSSelectableMDOListItem[] headings;
NSSelectableMDOListItem[] res = agent.SaveHeadingsForListItemFromListDefinition(udListDefinitionId, listItemId, headings);

SaveHeadingsForListItemFromListName(String,Integer)

Saves the headings for the list item.

Introduced or updated in version: 7

Declaration

NSSelectableMDOListItem[] SaveHeadingsForListItemFromListName(String udListDefinitionName, Integer listItemId, NSSelectableMDOListItem[] headings)

Parameters

Type	Name	Description
String	udListDefinitionName
Integer	listItemId
NSSelectableMDOListItem[]	headings

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

NSListAgent agent;
String udListDefinitionName;
Integer listItemId;
NSSelectableMDOListItem[] headings;
NSSelectableMDOListItem[] res = agent.SaveHeadingsForListItemFromListName(udListDefinitionName, listItemId, headings);

SaveHeadingsFromListDefinition(Integer)

Save headings for list resolved by the provided id.

Introduced or updated in version: 7

Declaration

NSHeadingEntity[] SaveHeadingsFromListDefinition(Integer id, NSHeadingEntity[] entities)

Parameters

Type	Name	Description
Integer	id
NSHeadingEntity[]	entities

Returns

Type	Description
NSHeadingEntity[]

Examples

NSListAgent agent;
Integer id;
NSHeadingEntity[] entities;
NSHeadingEntity[] res = agent.SaveHeadingsFromListDefinition(id, entities);

SaveHeadingsFromName(String)

Saves headings for list resolved by the provided name.

Introduced or updated in version: 7

Declaration

NSHeadingEntity[] SaveHeadingsFromName(String name, NSHeadingEntity[] entities)

Parameters

Type	Name	Description
String	name
NSHeadingEntity[]	entities

Returns

Type	Description
NSHeadingEntity[]

Examples

NSListAgent agent;
String name;
NSHeadingEntity[] entities;
NSHeadingEntity[] res = agent.SaveHeadingsFromName(name, entities);

SaveHierarchyEntity(NSHierarchyEntity)

Updates the existing NSHierarchyEntity or creates a new NSHierarchyEntity if the id parameter is 0

Introduced or updated in version: 7

Declaration

NSHierarchyEntity SaveHierarchyEntity(NSHierarchyEntity hierarchyEntity)

Parameters

Type	Name	Description
NSHierarchyEntity	hierarchyEntity	The NSHierarchyEntity to save.

Returns

Type	Description
NSHierarchyEntity

Examples

NSList  agent;
NSHierarchyEntity thing = agent.CreateDefaultHierarchyEntity();
thing = agent.SaveHierarchyEntity(thing);

SaveLegalBase(NSLegalBase)

Introduced or updated in version: 8.2

Declaration

NSLegalBase SaveLegalBase(NSLegalBase legalBase)

Parameters

Type	Name	Description
NSLegalBase	legalBase

Returns

Type	Description
NSLegalBase

SaveListEntity(NSListEntity)

Updates the existing NSListEntity or creates a new NSListEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSListEntity SaveListEntity(NSListEntity listEntity)

Parameters

Type	Name	Description
NSListEntity	listEntity	The NSListEntity to save.

Returns

Type	Description
NSListEntity

Examples

NSList  agent;
NSListEntity thing = agent.CreateDefaultListEntity();
thing = agent.SaveListEntity(thing);

SaveListEntityByName(String,NSListEntity)

Saves an NSListEntity resolved by the provided name.

Introduced or updated in version: 8.2

Declaration

NSListEntity SaveListEntityByName(String name, NSListEntity listEntity)

Parameters

Type	Name	Description
String	name
NSListEntity	listEntity

Returns

Type	Description
NSListEntity

Examples

NSListAgent agent;
String name;
NSListEntity listEntity;
NSListEntity res = agent.SaveListEntityByName(name, listEntity);

SaveListItemEntity(NSListItemEntity)

Saves the NSListItemEntity.

Introduced or updated in version: 7.5

Declaration

NSListItemEntity SaveListItemEntity(NSListItemEntity listItemEntity)

Parameters

Type	Name	Description
NSListItemEntity	listItemEntity

Returns

Type	Description
NSListItemEntity

Examples

NSListAgent agent;
NSListItemEntity listItemEntity;
NSListItemEntity res = agent.SaveListItemEntity(listItemEntity);

SaveProjectTypeEntity(NSProjectTypeEntity)

Updates the existing NSProjectTypeEntity or creates a new NSProjectTypeEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSProjectTypeEntity SaveProjectTypeEntity(NSProjectTypeEntity projectTypeEntity)

Parameters

Type	Name	Description
NSProjectTypeEntity	projectTypeEntity	The NSProjectTypeEntity to save.

Returns

Type	Description
NSProjectTypeEntity

Examples

NSList  agent;
NSProjectTypeEntity thing = agent.CreateDefaultProjectTypeEntity();
thing = agent.SaveProjectTypeEntity(thing);

SaveQuickReplies(NSQuickReply[])

Saves all quick replies for a given associate

Introduced or updated in version: 8.2

Declaration

Void SaveQuickReplies(NSQuickReply[] quickReplies)

Parameters

Type	Name	Description
NSQuickReply[]	quickReplies

Returns

Type	Description
Void

SaveRelationDefinitionEntity(NSRelationDefinitionEntity)

Updates the existing NSRelationDefinitionEntity or creates a new NSRelationDefinitionEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSRelationDefinitionEntity SaveRelationDefinitionEntity(NSRelationDefinitionEntity relationDefinitionEntity)

Parameters

Type	Name	Description
NSRelationDefinitionEntity	relationDefinitionEntity	The NSRelationDefinitionEntity to save.

Returns

Type	Description
NSRelationDefinitionEntity

Examples

NSList  agent;
NSRelationDefinitionEntity thing = agent.CreateDefaultRelationDefinitionEntity();
thing = agent.SaveRelationDefinitionEntity(thing);

SaveResourceEntity(NSResourceEntity)

Updates the existing NSResourceEntity or creates a new NSResourceEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSResourceEntity SaveResourceEntity(NSResourceEntity resourceEntity)

Parameters

Type	Name	Description
NSResourceEntity	resourceEntity	The NSResourceEntity to save.

Returns

Type	Description
NSResourceEntity

Examples

NSList  agent;
NSResourceEntity thing = agent.CreateDefaultResourceEntity();
thing = agent.SaveResourceEntity(thing);

SaveSaleStageEntity(NSSaleStageEntity)

Updates the existing NSSaleStageEntity or creates a new NSSaleStageEntity if the id parameter is

Introduced or updated in version: 7.5

Declaration

NSSaleStageEntity SaveSaleStageEntity(NSSaleStageEntity saleStageEntity)

Parameters

Type	Name	Description
NSSaleStageEntity	saleStageEntity	The NSSaleStageEntity to save.

Returns

Type	Description
NSSaleStageEntity

Examples

NSList  agent;
NSSaleStageEntity thing = agent.CreateDefaultSaleStageEntity();
thing = agent.SaveSaleStageEntity(thing);

SaveSaleTypeEntity(NSSaleTypeEntity)

Updates the existing NSSaleTypeEntity or creates a new NSSaleTypeEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSSaleTypeEntity SaveSaleTypeEntity(NSSaleTypeEntity saleTypeEntity)

Parameters

Type	Name	Description
NSSaleTypeEntity	saleTypeEntity	The NSSaleTypeEntity to save.

Returns

Type	Description
NSSaleTypeEntity

Examples

NSList  agent;
NSSaleTypeEntity thing = agent.CreateDefaultSaleTypeEntity();
thing = agent.SaveSaleTypeEntity(thing);

SaveTicketCategoryEntity(NSTicketCategoryEntity)

Updates the existing NSTicketCategoryEntity or creates a new NSTicketCategoryEntity if the id parameter is 0

Introduced or updated in version: 8.5R08

Declaration

NSTicketCategoryEntity SaveTicketCategoryEntity(NSTicketCategoryEntity ticketCategoryEntity)

Parameters

Type	Name	Description
NSTicketCategoryEntity	ticketCategoryEntity	The NSTicketCategoryEntity to save.

Returns

Type	Description
NSTicketCategoryEntity

Examples

NSList  agent;
NSTicketCategoryEntity thing = agent.CreateDefaultTicketCategoryEntity();
thing = agent.SaveTicketCategoryEntity(thing);

SaveTicketPriorityEntity(NSTicketPriorityEntity)

Updates the existing NSTicketPriorityEntity or creates a new NSTicketPriorityEntity if the id parameter is 0

Introduced or updated in version: 8.5R08

Declaration

NSTicketPriorityEntity SaveTicketPriorityEntity(NSTicketPriorityEntity ticketPriorityEntity)

Parameters

Type	Name	Description
NSTicketPriorityEntity	ticketPriorityEntity	The NSTicketPriorityEntity to save.

Returns

Type	Description
NSTicketPriorityEntity

Examples

NSList  agent;
NSTicketPriorityEntity thing = agent.CreateDefaultTicketPriorityEntity();
thing = agent.SaveTicketPriorityEntity(thing);

SaveTicketStatusEntity(NSTicketStatusEntity)

Updates the existing NSTicketStatusEntity or creates a new NSTicketStatusEntity if the id parameter is 0

Introduced or updated in version: 8.5R08

Declaration

NSTicketStatusEntity SaveTicketStatusEntity(NSTicketStatusEntity ticketStatusEntity)

Parameters

Type	Name	Description
NSTicketStatusEntity	ticketStatusEntity	The NSTicketStatusEntity to save.

Returns

Type	Description
NSTicketStatusEntity

Examples

NSList  agent;
NSTicketStatusEntity thing = agent.CreateDefaultTicketStatusEntity();
thing = agent.SaveTicketStatusEntity(thing);

SaveWebPanelEntity(NSWebPanelEntity)

Updates the existing NSWebPanelEntity or creates a new NSWebPanelEntity if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSWebPanelEntity SaveWebPanelEntity(NSWebPanelEntity webPanelEntity)

Parameters

Type	Name	Description
NSWebPanelEntity	webPanelEntity	The NSWebPanelEntity to save.

Returns

Type	Description
NSWebPanelEntity

Examples

NSList  agent;
NSWebPanelEntity thing = agent.CreateDefaultWebPanelEntity();
thing = agent.SaveWebPanelEntity(thing);

SetDocumentTemplateFromDocumentTemplate(Integer,NSDocumentTemplateEntity)

Creates a new document template based on another template

Introduced or updated in version: 7.5

Declaration

NSDocumentTemplateEntity SetDocumentTemplateFromDocumentTemplate(Integer sourceDocumentTemplateId, NSDocumentTemplateEntity documentTemplateEntity)

Parameters

Type	Name	Description
Integer	sourceDocumentTemplateId
NSDocumentTemplateEntity	documentTemplateEntity

Returns

Type	Description
NSDocumentTemplateEntity

Examples

NSListAgent agent;
Integer sourceDocumentTemplateId;
NSDocumentTemplateEntity documentTemplateEntity;
NSDocumentTemplateEntity res = agent.SetDocumentTemplateFromDocumentTemplate(sourceDocumentTemplateId, documentTemplateEntity);

SetDocumentTemplateStream(NSDocumentTemplateEntity,NSStream,String,Integer)

Stores a document template from its stream.

Introduced or updated in version: 7.5

Declaration

NSDocumentTemplateEntity SetDocumentTemplateStream(NSDocumentTemplateEntity documentTemplateEntity, NSStream stream, String languageCode, Integer pluginId)

Parameters

Type	Name	Description
NSDocumentTemplateEntity	documentTemplateEntity
NSStream	stream
String	languageCode
Integer	pluginId

Returns

Type	Description
NSDocumentTemplateEntity

Remarks

Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.

Examples

NSListAgent agent;
NSDocumentTemplateEntity documentTemplateEntity;
NSStream stream;
String languageCode;
Integer pluginId;
NSDocumentTemplateEntity res = agent.SetDocumentTemplateStream(documentTemplateEntity, stream, languageCode, pluginId);

SetEmarketingStrictMode(Bool)

Turns on the Emarketing strict mode, which will enable full GDPR rules concerning Emarketing consents and subscriptions

Introduced or updated in version: 8.2

Declaration

Void SetEmarketingStrictMode(Bool enable)

Parameters

Type	Name	Description
Bool	enable

Returns

Type	Description
Void

Examples

NSListAgent agent;
Bool enable;
agent.SetEmarketingStrictMode(enable);

SetHeadingsForListItem(Integer,Integer,Bool)

Sets headings which this list item should be listed under

Introduced or updated in version: 7

Declaration

Void SetHeadingsForListItem(Integer udListDefinitionId, Integer listItemId, Integer [] headingIds, Bool enable)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	listItemId
Integer[]	headingIds
Bool	enable

Returns

Type	Description
Void

SetListItemsForHeading(Integer,Integer,Integer[],Bool)

Updates listItems that will be visible for this usergroup

Introduced or updated in version: 8.2

Declaration

Void SetListItemsForHeading(Integer udListDefinitionId, Integer headingId, Integer[] listItemIds, Bool enable)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	headingId
Integer[]	listItemIds
Bool	enable

Returns

Type	Description
Void

SetListItemsForHeadingFromListName(String,Integer,Integer[],Bool)

Updates listItems under this heading

Introduced or updated in version: 8.2

Declaration

Void SetListItemsForHeadingFromListName(String udListDefinitionName, Integer headingId, Integer[] listItemIds, Bool enable)

Parameters

Type	Name	Description
String	udListDefinitionName
Integer	headingId
Integer[]	listItemIds
Bool	enable

Returns

Type	Description
Void

SetListItemsForUserGroup(Integer,Integer,Integer[],Bool)

Updates listItems that will be visible for this usergroup

Introduced or updated in version: 8.2

Declaration

Void SetListItemsForUserGroup(Integer udListDefinitionId, Integer usergroupId, Integer[] listItemIds, Bool enable)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	usergroupId
Integer[]	listItemIds
Bool	enable

Returns

Type	Description
Void

SetListItemsForUserGroupFromListName(String,Integer,Integer[],Bool)

Updates listItems that will be visible for this usergroup

Introduced or updated in version: 8.2

Declaration

Void SetListItemsForUserGroupFromListName(String udListDefinitionName, Integer usergroupId, Integer[] listItemsID, Bool enable)

Parameters

Type	Name	Description
String	udListDefinitionName
Integer	usergroupId
Integer[]	listItemsID
Bool	enable

Returns

Type	Description
Void

SetRankOnHeadings(Integer,Integer[])

Sets rank order on headings

Introduced or updated in version: 7.5

Declaration

Void SetRankOnHeadings(Integer udListDefinitionId, Integer[] headingIds)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer[]	headingIds

Returns

Type	Description
Void

SetRankOnProjectActivity(Integer,Integer[])

Sets rank order on project activity

Introduced or updated in version: 7.5

Declaration

Void SetRankOnProjectActivity(Integer projectTypeStatusLinkId, Integer[] itemsIds)

Parameters

Type	Name	Description
Integer	projectTypeStatusLinkId
Integer[]	itemsIds

Returns

Type	Description
Void

SetRankOnProjectDocument(Integer,Integer[])

Sets rank order on project document

Introduced or updated in version: 7.5

Declaration

Void SetRankOnProjectDocument(Integer projectTypeStatusLinkId, Integer[] itemsIds)

Parameters

Type	Name	Description
Integer	projectTypeStatusLinkId
Integer[]	itemsIds

Returns

Type	Description
Void

SetRankOnSaleActivity(Integer,Integer[])

Sets rank order on sale activity

Introduced or updated in version: 7.5

Declaration

Void SetRankOnSaleActivity(Integer saleTypeStageLinkId, Integer[] itemsIds)

Parameters

Type	Name	Description
Integer	saleTypeStageLinkId
Integer[]	itemsIds

Returns

Type	Description
Void

SetRankOnSaleDocument(Integer,Integer[])

Sets rank order on project document

Introduced or updated in version: 7.5

Declaration

Void SetRankOnSaleDocument(Integer saleTypeStageLinkId, Integer[] itemsIds)

Parameters

Type	Name	Description
Integer	saleTypeStageLinkId
Integer[]	itemsIds

Returns

Type	Description
Void

SetTicketCategoriesForUserGroup(Integer,Integer[])

Sets ticket categories for one user group

Introduced or updated in version: 7

Declaration

Void SetTicketCategoriesForUserGroup(Integer userGroupId, Integer[] categoryIds)

Parameters

Type	Name	Description
Integer	userGroupId
Integer[]	categoryIds

Returns

Type	Description
Void

Examples

NSListAgent agent;
Integer userGroupId;
Integer[] categoryIds;
agent.SetTicketCategoriesForUserGroup(userGroupId, categoryIds);

SetVisibleForUserGroup(Integer,Integer,Integer[],Bool)

Sets a group which this list item should be visible for

Introduced or updated in version: 7.5

Declaration

Void SetVisibleForUserGroup(Integer udListDefinitionId, Integer listItemId, Integer[] userGroupId, Bool enable)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	listItemId
Integer[]	userGroupId
Bool	enable

Returns

Type	Description
Void

SetVisibleForUserGroups(Integer,Integer,NSSelectableMDOListItem[])

Updates User groups that this list item is visible for

Introduced or updated in version: 8.2

Declaration

NSSelectableMDOListItem[] SetVisibleForUserGroups(Integer udListDefinitionId, Integer listItemId, NSSelectableMDOListItem[] userGroups)

Parameters

Type	Name	Description
Integer	udListDefinitionId
Integer	listItemId
NSSelectableMDOListItem[]	userGroups

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

NSListAgent agent;
Integer udListDefinitionId;
Integer listItemId;
NSSelectableMDOListItem[] userGroups;
NSSelectableMDOListItem[] res = agent.SetVisibleForUserGroups(udListDefinitionId, listItemId, userGroups);

SetVisibleForUserGroupsFromListName(String,Integer)

Updates User groups that this list item is visible for

Introduced or updated in version: 7

Declaration

NSSelectableMDOListItem[] SetVisibleForUserGroupsFromListName(String udListDefinitionName, Integer listItemId, NSSelectableMDOListItem[] userGroups)

Parameters

Type	Name	Description
String	udListDefinitionName
Integer	listItemId
NSSelectableMDOListItem[]	userGroups

Returns

Type	Description
NSSelectableMDOListItem[]

Examples

NSListAgent agent;
String udListDefinitionName;
Integer listItemId;
NSSelectableMDOListItem[] userGroups;
NSSelectableMDOListItem[] res = agent.SetVisibleForUserGroupsFromListName(udListDefinitionName, listItemId, userGroups);

SortListItems(Integer,String)

Sort the list items in a given list alphabetically

Introduced or updated in version: 7.5

Declaration

Void SortListItems(Integer udListDefinitionId, String cultureName)

Parameters

Type	Name	Description
Integer	udListDefinitionId
String	cultureName

Returns

Type	Description
Void

UpdateCategoryMemberships(NSTicketCategoryMembershipEntity[],NSTicketCategoryMembershipEntity[],NSTicketCategoryMembershipEntity[])

Updates a TicketCategory memberships.

Introduced or updated in version: 10

Declaration

Void UpdateCategoryMemberships(NSTicketCategoryMembershipEntity[] membershipsToAdd, NSTicketCategoryMembershipEntity[] membershipsToUpdate, NSTicketCategoryMembershipEntity[] membershipsToDelete)

Parameters

Type	Name	Description
NSTicketCategoryMembershipEntity[]	membershipsToAdd	Memberships to add.
NSTicketCategoryMembershipEntity[]	membershipsToUpdate	Memberships to update.
NSTicketCategoryMembershipEntity[]	membershipsToDelete	Memberships to delete.

Returns

Type	Description
Void

Examples

Integer ticketCategoryId = 16;
Integer associateId = 23;
NSListAgent listAgent;
// add a member with x weight
NSTicketCategoryMembershipEntity[] membershipsToAdd;
NSTicketCategoryMembershipEntity membership;
NSAssociate user;
user.SetAssociateId(associateId);
membership.SetUser(user);
membership.SetWeight(5);
membershipsToAdd.pushBack(membership);
// update a member, change it's weight
NSTicketCategoryMembershipEntity[] membershipsToUpdate;
// members to delete
NSTicketCategoryMembershipEntity[] membershipsToDelete;
listAgent.UpdateCategoryMemberships(ticketCategoryId, membershipsToAdd, membershipsToUpdate, membershipsToDelete);

UpdateHierarchyFromPath(Integer,String,NSHierarchyEntity)

Updates a hierarchy item from a path

Introduced or updated in version: 7

Declaration

NSHierarchyEntity UpdateHierarchyFromPath(Integer domain, String path, NSHierarchyEntity entity)

Parameters

Type	Name	Description
Integer	domain	See Domain.
String	path
NSHierarchyEntity	entity

Returns

Type	Description
NSHierarchyEntity

Examples

NSListAgent agent;
Integer domain;
String path;
NSHierarchyEntity entity;
NSHierarchyEntity res = agent.UpdateHierarchyFromPath(domain, path, entity);