Skip to main content

​
Namespace SuperOffice.WebApi.Agents

​
Classes

AIAgent AI services, such as Translation, Statistics, Sentiment analysis, backed by calls to Public Cloud providers AgentBase Base class for client Agents. Uses a to call the SuperOffice REST API. Will use a default implementation with gzip and progress callbacks if nothing is specified. ApiAgent API info: tenant status, API version, Client library version AppointmentAgent Collection of all services that works with Appointment data. ArchiveAgent ArchiveList functions of all kinds AssociateAgent Associate utilities, notes, not user admininstration BLOBAgent Collection of all services that works with binary objects (BLOBS), e.g. Images and documents. BatchAgent Start, stop and monitor predefined batch tasks BulkUpdateAgent Agent used for bulk update methods CRMScriptAgent Manage and execute CRMScript functions.

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. ChatAgent Chat functions. Manage chat channels, sessions and messages. ConfigurationAgent User interface configuration - XMLs and other elements such as inter-client URLs ContactAgent Contact (company) data services. CustomObjectAgent Agent for working with Custom Objects (extra tables): read schema and full CRUD over rows. Purpose-built replacement for using DatabaseTableAgent against custom objects. CustomerServiceAgent Agent used for Customer Service methods DashAgent Agent that lets you configure dashboard tiles and retrieve dashboard data DashboardAgent Agent lets you configure dashboard tiles and retrieve dashboard data DatabaseAgent Database schema queries and changes DatabaseTableAgent Agent used for CRUD operations on database tables. Read, add, update, delete rows in tables. DiagnosticsAgent Diagnostics, usage data collection, caches and flushing DocumentAgent Collection of all services that works with Document data. This is services for the document information, not the physical document themselves. These are handled by the BLOB service methods. DocumentMigrationAgent Agent used to support migrating documents between different document-plugins, as single documents or batches.

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. Intended for SuperOffice-internal apps. EMailAgent Email connection, reading, sending

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. ErpSyncAgent Services for the ERP Integration Services feature

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. Intended for ERP integration apps. FavouriteAgent Agent used for retrieveing and setting favourites FindAgent Find functions ForeignSystemAgent Collection of all services that works with Foreign key data (Key/Value pairs) FreeTextAgent This agent can be used to manage the free text system ImportAgent This agent can be used to import data into the system LicenseAgent License query, download, activation ListAgent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc. MDOAgent MDO Lists, reading, searching, and item lookup. MarketingAgent Agent used for Marketing functions, such as Forms MessagingAgent SMS and other external messaging systems

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. NavigatorAgent Navigator stuff. NewsFeedAgent Posting and reading Newsfeed items, marking them as read or as handled. NumberAllocationAgent This agent can be used to manage number allocation PersonAgent Person data services. PhoneListAgent Collection of all services for searching for person or contact (company) phone numbers. PocketAgent Agent with Pocket specific functionality PreferenceAgent Preferences, user interface tab configuration PreviewsAgent Get preview strings from a hint ProjectAgent Collection of all services that works with Project data. QuoteAgent Services for the Quote Management feature, part of the Sale module RelationAgent Contact/Person relations ReportAgent Run reports, set favourites, labels ResourceAgent String resource substitution management. SaintAgent Administration and maintenance of SAINT counters and statuses SaleAgent Sale data services SelectionAgent Selections, entities, members and tasks SentryAgent Data and function right queries TargetsAgent Agent lets you configure targets, and retrieve targets TicketAgent Agent used for Ticket functions TimeZoneAgent TimeZone maintenance TooltipsAgent Tooltip system, hint to text transformation UserAgent User administration

Online Restricted: This agent is not available in Online by default. User management is not allowed for partner apps. UserDefinedFieldInfoAgent Returns information about user-defined fields, like field type, field size, field label text, default value. Does not return the actual values in the user-defined fields. The values are returned on the entity objects. ViewStateAgent User interface view state, history, currentXXX values WebhookAgent Webhook definitions - webhooks signal other systems about events inside NetServer

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. WorkflowAgent Agent lets you configure workflow automation

​
Interfaces

IAIAgent AI services, such as Translation, Statistics, Sentiment analysis, backed by calls to Public Cloud providers IAgentBase Base interface for interacting with SuperOffice WebApi agents. IApiAgent Interface for API agents: API info, tenant status, Client library version IAppointmentAgent Collection of all services that works with Appointment data. IArchiveAgent ArchiveList functions of all kinds IAssociateAgent Associate utilities, notes, not user admininstration IBLOBAgent Collection of all services that works with binary objects (BLOBS), e.g. Images and documents. IBatchAgent Start, stop and monitor predefined batch tasks IBulkUpdateAgent Agent used for bulk update methods ICRMScriptAgent Manage and execute CRMScript functions.

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. IChatAgent Chat functions. Manage chat channels, sessions and messages. IConfigurationAgent User interface configuration - XMLs and other elements such as inter-client URLs IContactAgent Contact (company) data services. ICustomObjectAgent Agent for working with Custom Objects (extra tables): read schema and full CRUD over rows. Purpose-built replacement for using DatabaseTableAgent against custom objects. ICustomerServiceAgent Agent used for Customer Service methods IDashAgent Agent that lets you configure dashboard tiles and retrieve dashboard data IDashboardAgent Agent lets you configure dashboard tiles and retrieve dashboard data IDatabaseAgent Database schema queries and changes IDatabaseTableAgent Agent used for CRUD operations on database tables. Read, add, update, delete rows in tables. IDiagnosticsAgent Diagnostics, usage data collection, caches and flushing IDocumentAgent Collection of all services that works with Document data. This is services for the document information, not the physical document themselves. These are handled by the BLOB service methods. IDocumentMigrationAgent Agent used to support migrating documents between different document-plugins, as single documents or batches.

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. Intended for SuperOffice-internal apps. IEMailAgent Email connection, reading, sending

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. IErpSyncAgent Services for the ERP Integration Services feature

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. Intended for ERP integration apps. IFavouriteAgent Agent used for retrieveing and setting favourites IFindAgent Find functions IForeignSystemAgent Collection of all services that works with Foreign key data (Key/Value pairs) IFreeTextAgent This agent can be used to manage the free text system IImportAgent This agent can be used to import data into the system ILicenseAgent License query, download, activation IListAgent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc. IMDOAgent MDO Lists, reading, searching, and item lookup. IMarketingAgent Agent used for Marketing functions, such as Forms IMessagingAgent SMS and other external messaging systems

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. INavigatorAgent Navigator stuff. INewsFeedAgent Posting and reading Newsfeed items, marking them as read or as handled. INumberAllocationAgent This agent can be used to manage number allocation IPersonAgent Person data services. IPhoneListAgent Collection of all services for searching for person or contact (company) phone numbers. IPocketAgent Agent with Pocket specific functionality IPreferenceAgent Preferences, user interface tab configuration IPreviewsAgent Get preview strings from a hint IProjectAgent Collection of all services that works with Project data. IQuoteAgent Services for the Quote Management feature, part of the Sale module IRelationAgent Contact/Person relations IReportAgent Run reports, set favourites, labels IResourceAgent String resource substitution management. ISaintAgent Administration and maintenance of SAINT counters and statuses ISaleAgent Sale data services ISelectionAgent Selections, entities, members and tasks ISentryAgent Data and function right queries ITargetsAgent Agent lets you configure targets, and retrieve targets ITicketAgent Agent used for Ticket functions ITimeZoneAgent TimeZone maintenance ITooltipsAgent Tooltip system, hint to text transformation IUserAgent User administration

Online Restricted: This agent is not available in Online by default. User management is not allowed for partner apps. IUserDefinedFieldInfoAgent Returns information about user-defined fields, like field type, field size, field label text, default value. Does not return the actual values in the user-defined fields. The values are returned on the entity objects. IViewStateAgent User interface view state, history, currentXXX values IWebhookAgent Webhook definitions - webhooks signal other systems about events inside NetServer

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered. IWorkflowAgent Agent lets you configure workflow automation