Account

APIDescription
GET api/account/managementinformation

Gets some management information for the current account.

GET api/organizations/current/account/organizationlogo/sizes/{logoSize}

Gets the logo image for the current usercompany.

PUT api/accounts/current

Updates the current account.

PUT api/organizations/current/account/organizationlogo

Updates the current organization's logo.

Agenda

A controller accepting agenda related requests.

APIDescription
DELETE api/organizations/current/users/current/agenda/defaultagendafilter

Deletes the current user's default agenda filter.

POST api/organizations/current/users/current/agenda/defaultagendafilter

Sets the current user's default filtering for the agenda.

ApplicationMailOptions

APIDescription
GET api/organizations/{organizationId}/application-mail-options/header-image

Gets the mail header image of an organization as an image stream.

PUT api/application-mail-options

Updates ApplicationMailOptions.

ArchivedEntityInstances

A controller containing endpoints facilitating in ArchivedEntityInstance related functionality.

APIDescription
DELETE api/archivedentityinstances/{archivedEntityInstanceId}

Deletes a specific ArchivedEntityInstance.

GET api/organizations/current/archivedentityinstances?pageSize={pageSize}&pageIndex={pageIndex}

Gets a specific subset of ArchivedEntityInstances related to the currently logged in Organization.

POST api/archivedentityinstances/{archivedEntityInstanceId}/restore

Restores an archived EntityInstance.

ArchivedEntityObjectListInstances

A controller containing endpoints facilitating in ArchivedEntityObjectListInstance related functionality.

APIDescription
DELETE api/archivedentityobjectlistinstances/{archivedEntityObjectListInstanceId}

Deletes an ArchivedEntityObjectListInstance.

GET api/organizations/current/archivedentityobjectlistinstances?pageSize={pageSize}&pageIndex={pageIndex}

Gets a specific subset of ArchivedEntityObjectListInstances related to the currently logged in Organization.

POST api/archivedentityobjectlistinstances/{archivedEntityObjectListInstanceId}/restore

Restores an archived EntityObjectListInstance to its former state.

ArchivedFiles

A controller containing endpoint facilitating in ArchivedFile entity operations.

APIDescription
DELETE api/archivedfiles/{archivedFileId}

Deletes a specific ArchivedFile.

GET api/archivedfiles/{archivedFileId}/download

Downloads a specific ArchivedFile.

GET api/organizations/current/archivedfiles?pageSize={pageSize}&pageIndex={pageIndex}

Get a specific subset of ArchivedFile entities within the current Organization.

Authentication

APIDescription
GET api/authenticate/is_authenticated

Gets a value indicating whether a request is authenticated.

POST api/authenticate

Serves credentials, that can be used to access VobeSoft, upon succesful authentication.

Calculator

APIDescription
POST api/modules/calculator/calculate_total

Calculates a total ObjectCalculation.

POST api/modules/calculator/calculate_individual?pageSize={pageSize}&pageIndex={pageIndex}

Calculates an individual ObjectCalculation.

POST api/modules/calculator/objectcalculations

Adds a new ObjectCalculation.

ConditionalAgendaItemStyles

APIDescription
DELETE api/conditional-agenda-item-styles/{conditionalAgendaItemStyleId}

Deletes a specific ConditionalAgendaItemStyle.

GET api/entityattributes/{entityAttributeId}/conditionalAgendaItemStyles

Gets the ConditionalAgendaItemStyles by EntityAttributeId

POST api/entityattributes/{entityAttributeId}/conditional-agenda-item-styles

Creates a new ConditionalAgendaItemStyle.

PUT api/conditional-agenda-item-styles/{conditionalAgendaItemStyleId}

Updates a specific ConditionalAgendaItemStyle.

Contact

A controller whose sole purpose is to notify about contact requests.

APIDescription
POST api/contact

Creates a contact request.

Currencies

APIDescription
GET api/currencies

Fetches a collection of Currencies.

DashboardSheets

A controller that exposes DashboardSheet related endpoints.

APIDescription
DELETE api/dashboardsheets/{dashboardSheetId}

Deletes a specific DashboardSheet.

GET api/dashboardsheets/{dashboardSheetId}

Gets a specific DashboardSheet.

POST api/users/current/dashboardsheets

Inserts a new DashboardSheet.

PUT api/dashboardsheets/{dashboardSheetId}

Updates a specific DashboardSheet.

DossierPortals

A controller that exposes endpoints related to the "DossierPortal" module.

APIDescription
DELETE api/modules/dossierportal/dossierportals/{dossierPortalId}

Deletes a specific existing DossierPortal.

GET api/modules/dossierportal/dossierportals/{dossierPortalId}

Gets an existing DossierPortal.

GET api/modules/dossierportal/users/current/entityinstance

Gets the EntityInstance related to the currently logged in User (through the DossierPortal module).

GET api/modules/dossierportal/users/current/entityinstance/entityobjectlistinstances?entityCategoryId={entityCategoryId}&pageIndex={pageIndex}&pageSize={pageSize}

Gets the EntityObjectListInstances of an EntityCategory related to the EntityInstance related to the current User (through the DossierPortal module).

GET api/organizations/current/modules/dossierportal/dossierportals

Gets a collection of configured DossierPortals in the current organization.

GET api/modules/dossierportal/entityinstances/{entityInstanceId}/user

Gets the User associated, via DossierPortal module, to a specific EntityInstance.

GET api/modules/dossierportal/entityinstances/{entityInstanceId}/users?pageSize={pageSize}&pageIndex={pageIndex}

Gets a collection of Users related to a specific EntityInstance, through the DossierPortal module.

GET api/modules/dossierportal/eligibleentitydefinitions

Gets a collection of eligible and unused EntityDefinitions for the "DossierPortal" module.

GET api/entityinstances/{entityInstanceId}/is-portal-entityinstance

Gets a value indicating whether a specific EntityInstance can be logged in upon, aka being a DossierPortal EntityInstance.

POST api/modules/dossierportal/dossierportals

Creates a new DossierPortal.

POST api/modules/dossierportal/users/current/entityinstance/entityobjectlistinstances

Adds an EntityObjectListInstance to the EntityInstance related to the current User (through the DossierPortal module).

PUT api/modules/dossierportal/dossierportals/{dossierPortalId}

Updates a specific DossierPortal.

PUT api/modules/dossierportal/users/current/entityinstance

Updates a specific EntityAttribute value for the EntityInstance related to the current User through the DossierPortal module.

PUT api/modules/dossierportal/users/current/entityinstance/entityobjectlistinstances/{entityObjectListInstanceId}

Updates a specific EntityObjectListInstance belonging to the EntityInstance related to the current User (through the DossierPortal module).

EntityAttributeOrderings

EntityAttributeOrderingsController

APIDescription
GET api/entityattributeorderings/{entityAttributeOrderingId}

Gets a specific EntityAttributeOrder.

POST api/entityattributeorderings

Adds a new EntityAttributeOrdering.

PUT api/entityattributeorderings/{entityAttributeOrderingId}

Updates an existing EntityAttributeOrdering.

EntityCategories

APIDescription
DELETE api/organizations/current/users/current/entitycategories/{entityCategoryId}

Deletes a specific EntityCategory.

GET api/organizations/current/users/current/entitycategories/{entityCategoryId}

Gets a specific EntityCategory.

GET api/entitycategories/{entityCategoryId}/module-usage

Fetches the modules in which a specific EntityCategory is used.

POST api/organizations/current/users/current/entitycategories

Creates a new EntityCategory.

PUT api/organizations/current/users/current/entitycategories/{entityCategoryId}

Updates a specific EntityCategory.

PUT api/organizations/current/users/current/entitycategories/orderings

Updates the order of a specific set of EntityCategories.

EntityCriteriaLists

APIDescription
GET api/entitycriterialists/{entityCriteriaListId}

Gets a specific EntityCriteriaList.

GET api/entitycriterialists/{entityCriteriaListId}/entityattributes

Gets a collection of EntityAttributes related to a specific EntityCriteriaList.

GET api/users/{userId}/entitycriterialists

Gets the EntityCriteriaList collection for a specific User.

GET api/users/{userId}/entitycriterialists?entityDefinitionId={entityDefinitionId}

Gets the EntityCriteriaList collection for a specific User.

POST api/entitycriterialists

Adds a new EntityCriteriaList.

PUT api/entitycriterialists/{entityCriteriaListId}

Updates a specific EntityCriteriaList.

PUT api/entitycriterialists/{entityCriteriaListId}/name

Updates the name of an EntityCriteriaList.

EntityDefinitionExports

APIDescription
GET api/entitydefinitionexports

Gets an EntityDefinitionExport collection for the current UserCompany.

EntityDefinitions

APIDescription
DELETE api/organizations/current/users/current/entitydefinitions/{entityDefinitionId}

Deletes a specific EntityDefinition.

GET api/organizations/current/users/current/entitydefinitions/{entityDefinitionId}

Gets a specific EntityDefinition.

GET api/entitydefinitions/{entityDefinitionId}/module-usage

Fetches the modules in which a specific EntityDefinition is used.

GET api/organizations/current/users/current/entitydefinitions?expanded={expanded}

Gets an EntityDefinition collection related to the current organization and accessible by the current logged in user.

POST api/organizations/current/users/current/entitydefinitions

Create a new EntityDefinition.

PUT api/organizations/current/users/current/entitydefinitions/{entityDefinitionId}

Updates a specific EntityDefinition.

EntityInstance

APIDescription
GET api/entityinstances/{entityInstanceId}/can-delete

Checks whether a specific EntityInstance can be deleted.

POST api/entityinstances/{entityInstanceId}/copy?includeEntityObjectListInstances={includeEntityObjectListInstances}

Copies a specific EntityInstance.

DELETE api/entityinstances/{entityInstanceId}

Deletes a specific EntityInstance.

POST api/entityinstances/bulk-delete

No documentation available.

GET api/EntityInstance/{id}/EntityObjectListInstances/EmailAddresses

Fetches the values formatted as email addresses for an EntityInstance's EntityObjectListInstances.

GET api/entityinstances/bulk-deletion/progress

No documentation available.

GET api/entityinstances/search?entityCriteriaListId={entityCriteriaListId}&sortings[0].EntityAttributeId={sortings[0].EntityAttributeId}&sortings[0].SortOrder={sortings[0].SortOrder}&sortings[1].EntityAttributeId={sortings[1].EntityAttributeId}&sortings[1].SortOrder={sortings[1].SortOrder}&page={page}&pageSize={pageSize}

Gets the results of an EntityCriteriaList.

GET api/entityinstances/{entityInstanceId}

Gets an EntityInstance.

GET api/entityinstances/{entityInstanceId}/entityattributes/{entityAttributeId}/value

No documentation available.

GET api/entityinstances/{entityInstanceId}/images

Gets a collection of images associated with a specific EntityInstance.

GET api/entityinstances/log?page={page}&pageSize={pageSize}

Gets a collection of recently added EntityInstances.

POST api/entityinstances

Adds a new EntityInstance.

EntityInstanceExport

APIDescription
POST api/EntityInstanceExport

Creates an Excel export.

FileDirectories

APIDescription
DELETE api/organizations/current/filedirectories/{fileDirectoryId}

Deletes a specific FileDirectory.

GET api/organizations/current/filedirectories

Gets the FileDirectory tree of the current organization.

POST api/organizations/current/filedirectories

Adds a new FileDirectory.

PUT api/organizations/current/filedirectories/{fileDirectoryId}

Updates a specific FileDirectory.

Files

A controller that exposes file related actions.

APIDescription
GET api/organizations/current/files/download?filePath={filePath}

Downloads a specific file.

GET api/organizations/current/files?query={query}&pageIndex={pageIndex}&pageSize={pageSize}

Gets a file collection corresponding to the specified search query, pageIndex and pageSize.

GeneralStatistics

APIDescription
GET api/general-statistics

Gets the general statistics of the application.

Pictures

APIDescription
POST api/organizations/current/pictures/{pictureId}/crop

Crops a picture.

POST api/organizations/current/pictures

Adds a new Picture.

Pipeflows

APIDescription
DELETE api/organizations/current/users/current/modules/pipeflow/pipeflows/{pipeflowId}

Deletes a specific Pipeflow.

DELETE api/organizations/current/users/current/modules/pipeflow/pipeflows/{pipeflowId}/userdefaultpipeflowfilter

Deletes a User_DefaultPipeflowFilter for a specific Pipeflow and the current User.

GET api/organizations/current/users/current/modules/pipeflow/lastselectedpipeflow

Gets the LastSelectedPipeflow for the current User.

GET api/organizations/current/modules/pipeflows/entitydefinitions

Gets the ids of the EntityDefinitions usable by the Pipeflow module.

GET api/organizations/current/users/current/modules/pipeflows

Gets a collection of Pipeflows, with their related Pipeflow_Statuses, for the current User of the current UserCompany.

GET api/organizations/current/users/current/modules/pipeflow/{pipeflowId}/widget-statistics

Gets the statistics for a specific Pipeflow, to be used in the Pipeflow widget.

GET api/modules/pipeflows/{pipeflowId}/statuses/{status}/results?filters[0].EntityAttributeId={filters[0].EntityAttributeId}&filters[0].Value={filters[0].Value}&filters[1].EntityAttributeId={filters[1].EntityAttributeId}&filters[1].Value={filters[1].Value}&pageIndex={pageIndex}&pageSize={pageSize}

Gets the EntityInstance results for a specific Pipeflow pipe.

POST api/organizations/current/users/current/modules/pipeflows

Adds a new Pipeflow.

PUT api/users/current/modules/pipeflow/pipeflows/{pipeflowId}/defaultcardstate

Updates the default card state (expanded or collapsed) of a specific Pipeflow.

PUT api/organizations/current/users/current/modules/pipeflow/lastselectedpipeflow

Updates the LastSelectedPipeflow for the current User.

PUT api/organizations/current/users/current/modules/pipeflow/pipeflows/{pipeflowId}

Updates a specific Pipeflow.

PUT api/organizations/current/modules/pipeflow/pipeflows/{pipeflowId}/pipeflowstatuses/{pipeflowStatusId}

Updates a specific PipeflowStatus.

PUT api/organizations/current/modules/pipeflow/pipeflows/{pipeflowId}/pipeflowstatusorderings

Updates the orderings of specific PipeflowStatuses.

PUT api/organizations/current/modules/pipeflow/pipeflows/{pipeflowId}/pipeflowstatuses/{pipeflowStatusId}/piperesults/{entityInstanceId}/status

Updates the status of an EntityInstance related to a Pipeflow.

POST api/organizations/current/users/current/modules/pipeflow/pipeflows/{pipeflowId}/userdefaultpipeflowfilterings

Sets the current user's default filtering for a specific Pipeflow.

PUT api/organizations/current/modules/pipeflow/pipeflows/{pipeflowId}/pipeflowstatuses/{pipeflowStatusId}/entityinstanceorderings

Synchronizes the orderings of EntityInstances in regard to a specific PipeflowStatus.

PricingReference

APIDescription
GET api/pricing-reference

Fetches a PricingReference.

RecurringDates

APIDescription
DELETE api/recurringdates/{recurringDateId}

Deletes a specific RecurringDate.

GET api/entityinstance_entityattributes/{entityInstanceEntityAttributeId}/recurringdate

Gets the RecurringDate for an EntityInstance_EntityAttribute.

GET api/entityinstance_entityattributedateranges/{entityInstanceEntityAttributeDateRangeId}/recurringdate

Gets the RecurringDate for an EntityInstance_EntityAttributeDateRange.

GET api/entityobjectlistinstance_entityattributes/{entityObjectListInstanceEntityAttributeId}/recurringdate

Gets the RecurringDate for an EntityObjectListInstance_EntityAttribute.

GET api/entityobjectlistinstance_entityattributedateranges/{entityObjectListInstanceEntityAttributeDateRangeId}/recurringdate

Gets the RecurringDate for an EntityObjectListInstance_EntityAttributeDateRange.

Roles

APIDescription
DELETE api/roles/{id}

Deletes a Role.

GET api/roles/{roleId}

Gets a specific Role.

POST api/Role

Creates a new Role.

PUT api/Role

Updates a Role.

GET api/Roles

Fetches a ReadRoleViewModel collection.

SupportDeskConfigurations

An endpoint exposing SupportDesk related actions.

APIDescription
DELETE api/modules/supportdesk/configurations/{supportDeskConfigurationId}

Deletes a specific SupportDeskConfiguration.

GET api/modules/supportdesk/configurations/{supportDeskConfigurationId}

Gets a specific SupportDeskConfiguration.

GET api/modules/supportdesk/configuration?relationEntityDefinitionId={relationEntityDefinitionId}

No documentation available.

GET api/modules/supportdesk/configuration?ticketEntityDefinitionId={ticketEntityDefinitionId}

No documentation available.

GET api/organizations/current/modules/supportdesk/configurations

Gets a collection of SupportDesk module configuration.

GET api/modules/supportdesk/is-ticket-entitydefinition?entityDefinitionId={entityDefinitionId}

No documentation available.

POST api/modules/supportdesk/configurations/empty

Adds a new empty SupportDeskConfiguration.

PUT api/modules/supportdesk/configurations/{id}

Updates a specific SupportDeskConfiguration.

SupportDeskMailAccounts

A controller that exposes SupportDeskMailAccount related functionality.

APIDescription
GET api/modules/supportdesk/mailaccounts/{supportDeskMailAccountId}/connect-google

Connection a SupportDeskMailAccount to a Google email account.

GET api/modules/supportdesk/mailaccounts/{supportDeskMailAccountId}/connect-microsoft-graph

Connection a SupportDeskMailAccount to a Microsoft Graph email account.

DELETE api/modules/supportdesk/mailaccounts/{supportDeskMailAccountId}

Deletes a specific SupportDeskMailAccount.

GET api/modules/supportdesk/mailaccounts/{supportDeskMailAccountId}/mailfolders

Gets the MailFolders associated with a SupportDeskMailAccount's Microsoft Graph connection.

GET api/modules/supportdesk/mailaccounts/{supportDeskMailAccountId}

Gets a specific SupportDeskMailAccount.

POST api/modules/supportdesk/configurations/{supportDeskConfigurationId}/mailaccounts/create-empty

Creates an empty SupportDeskMailAccount.

PUT api/modules/supportdesk/mailaccounts/{supportDeskMailAccountId}

Updates a specific SupportDeskMailAccount.

SupportDeskMailTemplates

A controller exposing SupportDeskMailTemplate related endpoints.

APIDescription
DELETE api/modules/supportdesk/mailtemplates/{id}

Deletes a specific SupportDeskMailTemplate.

GET api/modules/supportdesk/mailtemplates/{id}

Gets a specific SupportDeskMailTemplate.

POST api/modules/supportdesk/configurations/{supportDeskConfigurationId}/mailtemplates/create-empty

Creates an empty SupportDeskMailTemplate.

PUT api/modules/supportdesk/mailtemplates/{id}

Updates a specific SupportDeskMailTemplate.

UserCompanies

APIDescription
GET api/organizations

No documentation available.

PUT api/organizations/current/additional-settings

Updates the additional settings of a UserCompany.

UserGroups

A controller exposing UserGroup related actions.

APIDescription
GET api/users/current/usergroup/users

No documentation available.

UserIntegrations

APIDescription
DELETE api/organizations/current/users/current/userintegrations?apiType={apiType}

Deletes a UserIntegration for the current User.

Users

APIDescription
GET api/users/current/change-context?userId={userId}

Changes the User context.

DELETE api/users/{userId}

Deletes a specific User.

DELETE api/users/current/minimizedentities/entityinstances/{entityInstanceId}

Deletes a specific minimized EntityInstance for the current User.

DELETE api/users/current/minimizedentities/entityobjectlistinstances/{entityObjectListInstanceId}

Deletes a specific minimized EntityInstance for the current User.

GET api/users/current/dossier-overview-orderings/entitydefinitions/{entityDefinitionId}

No documentation available.

GET api/users/{userId}

Gets a specific User.

GET api/users/{userId}/objectoverviewcolumnorderings

Gets a collection of User_ObjectOverviewColumnOrderings for a specific User.

GET api/users/current/permissions

Gets a collection of permissions related to the currently logged in User.

POST api/users

Adds a specific User. #NOTE: This endpoint is solely used (for now) to create an empty User. Use PutUserAsync instead, to actually finish creating the User with the appropriate values.

POST api/users/current/userentitycategorylistcolumnorderings

Adds a UserEntityCategoryListColumnOrdering.

POST api/users/{userId}/user_entitydefinition_orders

Inserts User_EntityDefinitionOrders.

POST api/users/current/minimizedentities

Adds a new User_MinimizedEntity for the current User.

PUT api/users/current/profile?synchronizeDashboard={synchronizeDashboard}

Updates the current user's preference regarding whether to automatically synchronize his or hers dashboard.

PUT api/users/{userId}

Updates a specific User.

PUT api/users/current/entitycategories/{entityCategoryId}/entityattributesorting

Updates the sorting of a EntityCategoryList for a specific user.

POST api/organizations/current/users/current/session/refresh

No documentation available.

POST api/users/current/dossier-column-orderings/entitydefinitions/{entityDefinitionId}

No documentation available.

POST api/users/{userId}/entitydefinitions/{entityDefinitionId}/objectoverviewcolumnorderings

Saves the ordering of column in ObjectOverview for a specific User and EntityDefinition.

UserSettings

APIDescription
POST api/usersettings/userprofilepicture/crop

Crops a UserProfilePicture.

GET api/usersettings/userprofileinformation

Gets an existing UserProfileInformation.

GET api/usersettings/userprofilepicture/sizes/{photoSize}

Gets a UserProfilePicture.

GET api/users/{userId}/usersettings/userprofilepicture/sizes/{photoSize}

Gets a UserProfilePicture.

POST api/usersettings/profilepicture

Adds a new profile picture to a temporary directory. #NOTE: This is put into a temporary directory because the uploaded image still has to be scaled.

PUT api/usersettings/locale

Updates the current User's locale.

PUT api/usersettings/userprofileinformation

Updates the UserProfileInformation.

Weather

APIDescription
GET api/weather

Gets the current weather conditions for the currently logged in User.

WebForms

APIDescription
POST api/webforms/{webFormId}

Copies an existing WebForm.

DELETE api/webforms/{webFormId}

Deletes an existing WebForm.

GET api/webforms/{webformId}

Gets a specific WebForm.

GET api/entitydefinitions/{entityDefinitionId}/webforms

Gets a WebForm collection for a specific EntityDefinition.

GET api/webforms/{webFormId}/url

Gets the URL of a specific WebForm.

POST api/webforms/{webFormId}/createwebformfile

Creates a WebForm file corresponding to a specific WebForm.

POST api/entitydefinitions/{entityDefinitionId}/webforms

Creates a new WebForm.

PUT api/webforms/{webFormId}

Updates an existing WebForm.

Widgets

APIDescription
DELETE api/users/{userId}/widgets/{userWidgetConfigurationId}

Deletes a specific User_WidgetConfiguration.

GET api/users/current/dashboardsheets-with-widgets

Gets a collection of DashboardSheets with their related Widgets.

POST api/users/{userId}/widgets

Adds a new User_WidgetConfiguration.

PUT api/users/{userId}/listwidgetconfigurations/{userWidgetConfigurationId}/color

Updates the color associated with a ListWidget.

PUT api/users/current/widgetconfigurations/{userWidgetConfigurationId}/columnwidth

Updates the width of a column for a specific List widget.

PUT api/users/{userId}/listwidgetconfigurations/{userWidgetConfigurationId}/entityattributeordering

Updates the EntityAttributeOrdering of a ListWidget.

PUT api/users/{userId}/listwidgetconfigurations/{userWidgetConfigurationId}/entitycriterialist

Updates the EntityCriteriaList associated with a ListWidget's instance.

PUT api/users/current/listwidgetconfigurations/{userWidgetConfigurationId}/lastsorting

Updates the last sorting of a ListWidget.

PUT api/users/current/notewidgetconfigurations/{userWidgetConfigurationId}

Updates a specific WidgetNoteConfiguration.

PUT api/users/current/userwidgetconfigurations/{userWidgetConfigurationId}/lastviewmode?viewModeId={viewModeId}

Updates the last selected view mode of a specific Pipeflow widget.

PUT api/users/{userId}/widgets

Updates an existing User_WidgetConfiguration collection.

PUT api/modules/supportdesk/widget-configurations/{userWidgetConfigurationId}/supportdesk-conversations-configuration

No documentation available.

GET api/Widgets

Gets a collection representing the available Widgets.