ASP.NET Web API Help Page

Introduction

WorkPoint 365 WebAPI

Task

Controller for managing tasks.

API	Description
GET api/Task/ExistsTask?entityListID={entityListID}&entityID={entityID}&taskListID={taskListID}&taskID={taskID}	Checks if a task exists.
POST api/Task/CreateTask?entityListID={entityListID}&entityID={entityID}	Creates a task.
POST api/Task/UpdateTask?entityListID={entityListID}&entityID={entityID}	Updates a task.
GET api/Task/DeleteTask?entityListID={entityListID}&entityID={entityID}&taskListID={taskListID}&taskID={taskID}	Deletes a task.

Process

Controller for managing UserProcesses

API	Description
GET api/ProcessInstance/{processInstanceId}?sendMessages={sendMessages}	Returns current instance
GET api/Process	Get published processes
GET api/ProcessConfigurations?processConfigurationId={processConfigurationId}	Get published process configurations
POST api/ProcessConfigurations?ignoreConflictingVersions={ignoreConflictingVersions}&overrideExisting={overrideExisting}	No documentation available.
PUT api/ProcessConfigurations?ignoreConflictingVersions={ignoreConflictingVersions}	No documentation available.
DELETE api/ProcessConfigurations/{processConfigurationId}	No documentation available.
POST api/ProcessInstance/{processInstanceId}/Trigger/{trigger}	Initializes the user step.
POST api/Process/{processId}/InitializeUserProcess	Initializes a user process.
GET api/Process/Account	Processes the account.
POST api/Process/UpdateConfigurationItemsCache	Updates Cache
POST api/Process/UpdateCache	Updates the entire Process Configuration cache in Cosmos. This should not really be used because it is expensive in Resource units and could cause throttleling. When a Process is being used it is automatically set in cache the first time if it does not exist and it is published. When a Process is published it is also set in cache automatically. If you want to publish a range of processes and initilize the trigger cache, look at the above
POST api/Expression/Evaluate	Evaluates expression
GET api/ProcessInstance/{processInstanceId}/Versionhistory	No documentation available.
GET api/Process/{processId}/ProcessInstances?pageSize={pageSize}&continueationToken={continueationToken}	No documentation available.
POST api/MyProcessInstances	No documentation available.
GET api/ProcessHistory/{processId}/instances?includeContext={includeContext}	No documentation available.
POST api/ProcessSettings	No documentation available.
GET api/ProcessSettings	No documentation available.

WebHookRegistrations

API	Description
GET api/webhooks/registrations	No documentation available.
GET api/webhooks/registrations/{id}	No documentation available.
POST api/webhooks/registrations	No documentation available.
PUT api/webhooks/registrations/{id}	No documentation available.
DELETE api/webhooks/registrations/{id}	No documentation available.
DELETE api/webhooks/registrations	No documentation available.

Uninstall

API	Description
DELETE api/Uninstall/{solutionId}	No documentation available.

EMM

Controller for accessing EMM

API	Description
POST api/EMM/JournalItems	Gets all the journal items that match the expression in the parameter
GET api/EMM/Email/{conversationID}	Gets an email by a conversationID
POST api/EMM/Email/{conversationID}/Attachment/{attachmentIndex}	Gets the attachment as a file for specified attachmentindex on the email with the given conversationID
POST api/EMM/Email/{conversationID}/AttachmentAsEmail/{attachmentIndex}	Gets the attachment as an email for specified attachmentindex on the email with the given conversationID

EventBus

API	Description
POST api/EventBus/Settings	No documentation available.
GET api/EventBus/Settings	No documentation available.

Wizard

Controller for managing wizards.

API	Description
GET api/Wizard/Configurations	Gets all wizard configurations.
POST api/Wizard/StoreFile	Store file temporary in blob storage

NavigationSettings

API	Description
GET api/NavigationSettings	Gets the navigation settings

Entity

Controller for managing entities

API	Description
POST api/Entity/Move	Moves an entity
POST api/Entity/{businessModuleId}/Move/{sourceEntityId}	Moves an entity
GET api/Entity/{businessModuleId}/GetEntityFieldSchema?contentType={contentType}	Get field schema used for other entity actions in the WorkPoint Connector
GET api/Entity/{businessModuleId}/GetEntityFormFieldSchema?contentType={contentType}	Get field schema used for entity form step
GET api/Entity/{businessModuleId}/GetUpdateEntityFieldSchema	Get field schema used for update entity action in the WorkPoint Connector
GET api/BusinessModules/{businessModuleId}/GetTimedisplacementOnEntitySelectionSchema	Get field schema used for other entity actions in the WorkPoint Connector
GET api/Entity/{businessModuleId}/GetEntityFieldSchemaWithId?contentType={contentType}	Get field schema used for other entity actions in the WorkPoint Connector
GET api/Entity/{businessModuleId}/GetEntityAllFieldsSchemaWithId?contentType={contentType}	Get all fields schema used for other entity actions in the WorkPoint Connector
POST api/Entity/{businessModuleId}/CopyAdvanced/{sourceEntityId}	Copy entity
POST api/Entity/{businessModuleId}/Copy/{sourceEntityId}	Copies business module entity in WorkPoint
POST api/Entity/CopyEntityContent	Copies business module entity site content to the other entity site
POST api/BusinessModules/{businessModuleId}/Entities/Create/{siteCreationBehaviour}?modelId={modelId}&stageId={stageId}	Create business module entity in WorkPoint
POST api/Entity/{businessModuleId}/Create/{createSite}	Create business module entity in WorkPoint
POST api/Entity/{businessModuleId}/Update/{entityId}	Updates business module entity in WorkPoint
GET api/Entity/{businessModuleId}/Get/{entityId}	Get entity
POST api/Entity/Delete	Delete entities
POST api/Entity/ChangeStage	No documentation available.
POST api/Entity/{businessModuleId}/ChangeStage/{entityId}/{stageId}/{overrideConstraints}/{overrideRequiredFields}	Changes the stage for an entity
GET api/Entity/{businessModuleId}/AvailableStages/{entityId}	Available Stages
GET api/Entity/{businessModuleId}/AvailableStartStages/{sourceEntityItemId}	Returns AvailableStartStages for a new Entity
POST api/Entity/BatchChangeStage	Validates stage constrains against a specific stage
GET api/Entity/{businessModuleId}/ValidateStageConstraints/{entityId}/{stageId}/{stageModelId}	Validates stage constrains against a specific stage
GET api/Entity/{businessModuleId}/StageFields/{entityId}/{stageId}/{stageModelId}	Returns the fields for a specific stage for a entity
POST api/BusinessModules/{businessModuleId}/entities/{entityId}/ConnectToSite	Connects entity to a site

Health

API	Description
GET api/Health	No documentation available.
GET admin/host/ping	No documentation available.
POST admin/host/ping	No documentation available.

BufferSites

Controller for buffer sites

API	Description
GET api/BufferSites/{businessModuleId}	Gets buffer site infos

Command

Controller for managing solution license and features

API	Description
GET api/Command/CanConnect	Simple Test Method to test if there is access to the API
POST api/Command/CreateSites	Creates an entity site
POST api/Command/DeleteSites	Deletes an entity site

ExpressPanelSettings

API	Description
POST api/ExpressPanelSettings/Settings	No documentation available.
GET api/ExpressPanelSettings/Settings	No documentation available.

Suggestion

Controller for suggestions.

API	Description
POST api/Suggestion/GetEntitySuggestions	Gets entity suggestions based on where existing emails is journalized

Install

Controller for managing Install processes

API	Description
GET api/Install	No documentation available.
GET api/Install/Languages	No documentation available.
GET api/Install/Countries	No documentation available.
GET api/Install/Timezones	No documentation available.
GET api/Install/Users/{searchterm}	No documentation available.
POST api/Install/Solution	Start installation of Solution
GET api/Install/CanInstallWorkPoint?siteUrl={siteUrl}	Checks if WorkPoint can be installed on the site
GET api/Install/SiteValidation/{siteAlias}	Validate site
POST api/Install/SiteCollection	Create site
GET api/Install/LicensesAndTemplates/{licenseKey}	Retrieve customer solution licenses and solution templates
GET api/Install/Customer/{customerId}/Contacts	Retrieve customer contacts
POST api/Install/CustomAppAuthentication/Disable	No documentation available.
POST api/Install/SharedApp	No documentation available.
POST api/Install/SPFxApp	No documentation available.
GET api/Install/SharedAppApproval/RequestUrl	No documentation available.
GET api/Install/SharedAppApproval	No documentation available.
POST api/Install/SharedApp?install={install}	No documentation available.
GET api/Install/SiteCollection/SharedApp?siteCollectionUrl={siteCollectionUrl}	No documentation available.
POST api/Install/SiteCollection/SharedApp?siteCollectionUrl={siteCollectionUrl}	No documentation available.
GET api/Install/SharedAppPermissions?siteCollectionUrl={siteCollectionUrl}	No documentation available.
GET api/Install/SharedApp	Is shared app installed.
GET api/Install/TenantRequisites	No documentation available.
GET api/Install/ProvisioningSteps?solutionPackageId={solutionPackageId}	No documentation available.
GET api/Install/UserInfo	No documentation available.
GET api/Install/Solutions	No documentation available.
GET api/Install/SolutionInstallationReport?siteUrl={siteUrl}	No documentation available.
GET api/Install/AppInstallationReport	No documentation available.

SignalR

API	Description
GET api/SignalR/GetSignalRModel	No documentation available.
GET api/SignalR/Identifier	No documentation available.
GET signalr/negotiate	Legacy Signal R negotiate

API	Description
GET api/Consent/Permissions	Check Consent
GET api/Consent/Permissions/Descriptions?allowSiteCollectionManagement={allowSiteCollectionManagement}	Get Consent Scope Descriptions
GET api/Consent/Permissions/Application	No documentation available.
POST api/Consent/Permissions/Application	Consent to application permissions
DELETE api/Consent/Permissions/Application	No documentation available.
GET api/Consent/Permissions/Delegated	No documentation available.
POST api/Consent/WorkPoint/Permissions/Application/SharePoint?allowSiteCollectionManagement={allowSiteCollectionManagement}	Consent to SharePoint application permissions
POST api/Consent/WorkPoint/Permissions/Application/Graph?allowSiteCollectionManagement={allowSiteCollectionManagement}	Consent to Graph application permissions
POST api/Consent/WorkPoint/Permissions/Application/ExtendedGraph	Consent to Extended Graph application permissions
POST api/Consent/WorkPoint/Permissions/Application/ExtendedGraphGroupify	Consent to Extended Graph application permissions for groupify
POST api/Consent/WorkPoint/Permissions/Application/ExtendedGraphUserInvite	Consent to Extended Graph application permissions for User Invite
POST api/Consent/WorkPoint/Permissions/Application/InformationProtection	Consent to Extended Graph application permissions for information protection
GET api/Consent/WorkPoint/Permissions/Application/GetConsentUrlForSavingTeamsChatMessages	Get consent Url for saving Teams chat messages
GET api/Consent/WorkPoint/Permissions/Application/GetConsentUrlForUploadingEmailsAndAttachments	Get consent Url for uploading Outlook emails and attachments
GET api/Consent/WorkPoint/Permissions/Application/GetConsentUrlForUpdatingGroupMembership	Get consent Url for uploading Outlook emails and attachments
GET api/Consent/WorkPoint/Permissions/Application/GetConsentUrlForGroupReadWrite	Get consent Url for group read/write (setting sensitivity labels).
POST api/Consent/WorkPoint/Permissions/Delegated	Consent to delegated permissions
POST api/Consent/WorkPoint/Permissions/SelectedSite?siteUrl={siteUrl}	Grants application permission full control to selected site
DELETE api/Consent/WorkPoint/Permissions	Revoke consent to WorkPoint required scopes
GET api/Consent/Url/WebAPI	Get Consent Url for the Web API
GET api/Consent/Url/WebJob	Get Consent Url for the Web Job
POST api/Consent/AcceptPendingAPIAccessRequests	Accept pending API access requests

ListItem

Controller for managing items on a list.

API	Description
POST api/List/{listId}/Items	Gets all the items on the specified listId
GET api/List/{listId}/Item/{id}?includeFile={includeFile}	Gets the item with the specified id, on the given listId
POST api/List/{listId}/UploadFile?folderUrl={folderUrl}&overwrite={overwrite}	Uploads a file on the given listId.
GET api/List/{listId}/Item/{id}/Email	Gets the file as an email, for the specified item id, on the given listId.
POST api/List/{listId}/Item/{id}/Email/Attachment/{attachmentIndex}	Gets an attachment from the email file, for the specified item id, on the given listId.
POST api/List/{listId}/Item/{id}/Email/AttachmentAsEmail/{attachmentIndex}	Gets an attachment as an email object from the email file, for the specified item id, on the given listid.
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/Lists/ListItems/Create?listWebRelativeUrl={listWebRelativeUrl}&outputExists={outputExists}&contentType={contentType}&templateList={templateList}&templateItem={templateItem}&folder={folder}	No documentation available.
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/Lists/ListItems/Update?listWebRelativeUrl={listWebRelativeUrl}&listItemId={listItemId}&contentType={contentType}&unify={unify}	No documentation available.
GET api/List/{listId}/Item/{id}/Substages	No documentation available.
POST api/Items/BatchUpdateItems	Update multiple items
POST api/ListItem/CreateItems	Create documents, folders and items
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/Lists/ListItems?listWebRelativeUrl={listWebRelativeUrl}&listItemId={listItemId}	Get item
POST api/ListItem/Delete	Delete files, folders and items
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/Lists/{listIdOrWebRelativeUrl}/ListItems/{itemId}/Events/{eventType}	No documentation available.
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/Files/{uniqueId}/Events/{eventType}	No documentation available.
GET api/List/{listId}/Item/{id}/UserHasPermission?webUrl={webUrl}&permissionKind={permissionKind}	Check if the current user has permission of the given permissionKind, on the list listId and item id.
POST api/ListItem/Exists	Checks if a list item with the ListItemID or the specified IdentifierFieldValues exist in the list with ListName
POST api/ListItem/CreateOrUpdate	Creates or updates a list item. If a list item with the ListItemID or the specified IdentifierFieldValues exist the item is updated. If not, it is created.
POST api/ListItem/Create	Creates a list item
POST api/ListItem/Update	Updates the list item with the ListItemID or the specified IdentifierFieldValues
POST api/ListItem/Recycle	Recycles the list item with the ListItemID or the specified IdentifierFieldValues
POST api/ListItem/ChangeStage	Change Stage

EntityActivityLog

Controller for writing to entity activity logs.

API	Description
GET api/EntityActivityLog/EventSourceTypes	Refine Terms By EventSourceType
GET api/EntityActivityLog/EventTypes	Refine Terms By EventTypes
POST api/EntityActivityLog/Add	Create activity

WebHookProxy

API	Description
GET api/WebHookProxy	Gets all registered WebHooks for a given user.
GET api/WebHookProxy/{id}	Looks up a registered WebHook with the given for a given user.
POST api/WebHookProxy	Registers a new WebHook for a given user.
PUT api/WebHookProxy/{id}	Updates an existing WebHook registration.
DELETE api/WebHookProxy/{id}	Deletes an existing WebHook registration.
DELETE api/WebHookProxy	Deletes all existing WebHook registrations.

Teams

API	Description
POST api/Teams/UpdateTeamMembers	Update team members
POST api/Teams/SaveMicrosoftTeamsChats	Save Microsoft Teams chats
POST api/Teams/GetMessages	Save Microsoft Teams chats
POST api/Teams/GetMessage	No documentation available.
GET api/Teams/GetTeamByInternalId?teamInternalId={teamInternalId}	No documentation available.
GET api/Teams/GetEntityInfoByTeamInternalId?teamInternalId={teamInternalId}	No documentation available.
GET api/Teams/GetEntityChannels?businessModuleId={businessModuleId}&entityId={entityId}	No documentation available.
GET api/Teams/GetChannels?teamId={teamId}	No documentation available.

Favorites

Controller for managing Favorites

API	Description
GET api/Favorites/GetFavorites	Gets the favorites
POST api/Favorites/ExistsFavorite	Checks if a favorite exists
POST api/Favorites/Add	Add favorite to favorites list
DELETE api/Favorites/Delete/{favoriteId}	Removes the favorite from the favorites list
GET api/Favorites/MoveUp/{favoriteId}	Moves the favorite a step up in the sorting order
GET api/Favorites/MoveDown/{favoriteId}	Moves the favorite a step down in the sorting order
GET api/Favorites/SetIsMailList/{favoriteId}?isMailList={isMailList}	Sets IsMailList on the favorite
POST api/Favorites/Find	Finds a favorite by criteria and returns it if it exists

Admin

API	Description
GET api/Admin/Navigation	No documentation available.

NumeratorService

Controller for accessing the NumeratorService.

API	Description
GET api/NumeratorService/NextSequenceNumber/{id}?bmId={bmId}&entityId={entityId}	Get next sequence number

MailMerge

Controller for accessing the NumeratorService.

API	Description
GET api/MailMerge/GetMailMergeFields/{id}	Gets a list of field names used for mail merge.
GET api/MailMerge/GetMailMergedWordDocumentAsHtml?businessModuleID={businessModuleID}&entityID={entityID}&templateID={templateID}	Create Word document from a template and returns as html
GET api/MailMerge/GetMailMergedWordDocument?businessModuleID={businessModuleID}&entityID={entityID}&templateID={templateID}&includeHtml={includeHtml}&includeBytes={includeBytes}&commonFieldsBusinessModuleID={commonFieldsBusinessModuleID}&commonFieldsEntityID={commonFieldsEntityID}	Create Word document from a template
GET api/MailMerge/GetTemplates?businessModuleId={businessModuleId}&entityId={entityId}	Get templates for business module

ActionManagement

Controller for managing Actions and Triggers

API	Description
GET api/BusinessModules/{id}/Actions	Get actions on Business Module
POST api/BusinessModules/{businessModuleId}/Entity/{entityId}/ArchiveTeam	Archive team
POST api/BusinessModules/{businessModuleId}/Entity/{entityId}/UnarchiveTeam	Unarchive team
POST api/Mail/Send	Send e-mail
POST api/CustomEndpoint/Execute?endPointId={endPointId}	Send HTTP request
GET api/CustomEndpoint/{endpointId}/GetEndpointParameterSchema	Get Endpoint Parameter Schema
GET api/CustomEndpoint/GetEndpointResponseSchema?endpointId={endpointId}	Get Endpoint Response Schema
GET api/CustomEndpoint/GetEndpointsList	Get Endpoints List
GET api/CustomEndpoint/GetEndpointById?endpointId={endpointId}	Get Endpoint By Id
POST api/BusinessModules/{businessModuleId}/Entity/{entityId}/ConcatenateFiles	Concatenate multiple files and save as PDF
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/WelcomePage	Change welcome page
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/ConnectToOfficeGroup	Create team
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/Lock?lockType={lockType}	Lock entity
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/Unlock?lockType={lockType}	Unlock entity
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/MoveEntity	Move entity (Action management)
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/SetDefaultView	Set default view
GET api/BusinessModules/{id}/Triggers	Get Triggers
POST api/BusinessModules/{bmId}/Actions/{actionId}/Run?entityId={entityId}	Executes an action on a business module entity
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/MarkFavorite	Toggle entity as favorite
POST api/BusinessModules/{businessModuleId}/Entities/{entityId}/CreateDigitalPostDraftMessage	No documentation available.
POST api/DigitalPost/SaveMessage	No documentation available.
POST api/DigitalPost/ReplyToMessage	No documentation available.
POST api/DigitalPost/ForwardMessage	No documentation available.

Taxonomy

API	Description
GET api/TermStore/List	No documentation available.
GET api/TermGroup/List	No documentation available.
GET api/TermGroup/Get?id={id}	No documentation available.
POST api/TermGroup/Create?termGroupName={termGroupName}	No documentation available.
DELETE api/TermGroup/Delete?termsGroupId={termsGroupId}	No documentation available.
GET api/TermGroup/TermSet/List?termsGroupId={termsGroupId}	No documentation available.
GET api/TermGroup/TermSet/Get?termsGroupId={termsGroupId}&termsSetId={termsSetId}	No documentation available.
POST api/TermGroup/TermSet/Create?termsGroupId={termsGroupId}&termSetName={termSetName}	No documentation available.
DELETE api/TermGroup/TermSet/Delete?termsGroupId={termsGroupId}&termsSetId={termsSetId}	No documentation available.
GET api/TermGroup/TermSet/Terms/List?termsGroupId={termsGroupId}&termsSetId={termsSetId}&structure={structure}	No documentation available.
POST api/TermGroup/TermSet/Terms/Create?termsSetId={termsSetId}&termId={termId}&termName={termName}	No documentation available.
POST api/TermGroup/TermSet/Terms/Create?termsStoreId={termsStoreId}&termsGroupId={termsGroupId}&termsSetId={termsSetId}&termId={termId}&termName={termName}&availableForTagging={availableForTagging}	No documentation available.
PUT api/TermGroup/TermSet/Terms/Update?termsStoreId={termsStoreId}&termsGroupId={termsGroupId}&termsSetId={termsSetId}&termId={termId}&availableForTagging={availableForTagging}	No documentation available.
PUT api/TermGroup/TermSet/Terms/UpdateName?termsSetId={termsSetId}&termId={termId}&newName={newName}&lcid={lcid}	No documentation available.
POST api/TermGroup/TermSet/Terms/Upsert?termsStoreId={termsStoreId}&termsGroupId={termsGroupId}&taxonomySetName={taxonomySetName}&taxonomyIdKey={taxonomyIdKey}&taxonomyId={taxonomyId}&taxonomyParentId={taxonomyParentId}&kleNumber={kleNumber}&taxonomyTitle={taxonomyTitle}	No documentation available.
DELETE api/TermGroup/TermSet/Terms/Delete?termsGroupId={termsGroupId}&termsSetId={termsSetId}&termId={termId}	No documentation available.
POST api/TermStore/GetSuggestions?webUrl={webUrl}	No documentation available.

Outlook

Controller for Outlook integrations.

API	Description
GET api/Outlook/GetMappedPath/{outlookFolderEntryId}	Retrieves the mapped SharePoint folder
GET api/Outlook/GetOutlookMapping/{outlookFolderEntryId}	Retrieves the outlook mapping
GET api/Outlook/GetOutlookMappingsForCurrentUser	Retrieves a list of Outlook mappings for the current user
POST api/Outlook/AddFolderWebhookAndMapping	Register webhook on a outlook folder and adds mapping to SharePoint
POST api/Outlook/RemoveFolderWebhookAndMapping	Remove a registered outlook folder webhook
POST api/Outlook/NotificationListener?validationToken={validationToken}	This is the notification validation endpoint that is registered with the webhook subscriptions.
POST api/Outlook/NotificationListener	This is the notification endpoint that is subsequently hit by webhooks when an event we listen on (created / updated) occurs in the folder that is being listened on
POST api/Outlook/SynchronizeFolders	Endpoint to call for synchronize users mapped folders between Outlook and WorkPoint
POST api/Outlook/UploadEmailsAndAttachments	Upload attachments from Email's into WorkPoint

Solution

Controller for managing the solution.

API	Description
GET api/Solution/Info	Gets information for the current solution
POST api/Solution/Export	Generate a solution export template
GET api/Solution/Export/{id}	Downloads an existing export file
POST api/Solution/Import/{id}	Import a solution template and apply to solution

List

Controller for managing Lists.

API	Description
GET api/Lists	Gets all lists.
GET api/Lists/{id}	Gets the list with the specified id
GET api/Lists/{id}/Views	Gets the Views for the List with the specified id
GET api/Lists/{listId}/GetFieldSchema?contentType={contentType}	Get the field schema for a list's item
GET api/lists/{listId}/contenttypes	Gets all content types belonging to a list.
GET api/lists/{listId}/defaultcontenttypes	Gets all content types belonging to a list.
GET api/lists/{listId}/contentTypesExtended?listItemId={listItemId}&subListItemUrl={subListItemUrl}	Gets all content types belonging to a list with extended parameters
GET api/Lists/{listId}/ViewsExtended?listItemId={listItemId}&subListItemUrl={subListItemUrl}	Gets the views for the List with the specified extended parameters

SecurityReplication

Controller for managing Lists.

API	Description
POST api/BusinessModules/{bmId}/Entities/{entityId}/EntitySecurityReplication/{replicationMode}	Runs the entity scope replication. This means it only runs security replication for entities, everything else is not replicated.

Search

Controller for managing solution license and features

API	Description
PUT api/Search/Entities	Searches entities.
PUT api/Search/Documents	Searches documents.
PUT api/Search/Items	Searches items.
POST api/Search/EntityDetails?listId={listId}&listItemId={listItemId}	Gets preview information on a searched entity.
GET api/Search/RefinerTerms?termSetId={termSetId}&termId={termId}&firstLevelOnly={firstLevelOnly}	Gets available refiner terms for termset

SiteManagement

Controller for managing Sites

API	Description
GET api/SiteManagement/GetSites	Get Sites
POST api/SiteManagement/QueueCreateSiteJob	Queue site creation job
GET api/SiteManagement/SiteCollections?businessModuleId={businessModuleId}&siteCollectionStatus={siteCollectionStatus}	No documentation available.
GET api/SiteManagement/SiteCollectionBuffers	No documentation available.
POST api/SiteManagement/CreateSiteIfNotExists	Creates a site for a list item if it does not exists.
POST api/SiteManagement/RegisterSiteCollection	Register site collection

MailJournal

Controller for mail journals.

API	Description
GET api/JournalLocation/GetJournalLocations?messageID={messageID}	Gets journal locations for an email. Used by WorkPoint Express (Legacy).
GET api/JournalLocations?messageId={messageId}	No documentation available.
GET api/JournalizeFlag/SetFlags?internetMessageID={internetMessageID}&OutlookColorName={OutlookColorName}	Sets journalize flags for an email

BusinessModules

Controller for managing Business Modules.

API	Description
GET api/BusinessModules	Gets all business modules
GET api/BusinessModules/{id}	Gets a business module
GET api/BusinessModules/{businessModuleId}/{stageId}/SubStages	Gets all substages on the stage
GET api/BusinessModules/{businessModuleId}/StageModels	Gets Stage models on the business module
GET api/BusinessModules/{businessModuleId}/stages	Gets all stages on the businessModule
GET api/BusinessModules/{businessModuleId}/stages/{stageModel}	Gets all stages on the businessModule by stage model ID
GET api/BusinessModules/{businessModuleId}/startStages/{stageModelId}	Gets all start stages on the businessModule by stage model
GET api/BusinessModules/GetWithNone	Gets all business modules but added None, to represent the root site
GET api/BusinessModules/{businessModuleId}/GetSelectableBusinessModuleTimedisplacementFields	Gets Selectable EntityTime displacement Fields
GET api/BusinessModules/{businessModuleId}/GetTimedisplacementFieldsForEntityMasterSiteList?listWebRelativeUrl={listWebRelativeUrl}	Gets master site list time displacement Fields
GET api/BusinessModules/TabViewSettings	Gets the TabView for all Business Modules
GET api/BusinessModules/{id}/TabViewSettings	Gets the TabView for the Business Module with the specified id
GET api/BusinessModules/{id}/SubStages?subStagesTermSetId={subStagesTermSetId}&stageId={stageId}	Gets the Substages for a given Stage on the Business Module with the specified id
POST api/BusinessModules/{bmId}/Entities/{entityId}/QueueAggregationJob	Queue an aggregation job a specific business module entity.
POST api/BusinessModules/{bmId}/Entities/{entityId}/QueueSecuritySynchronizationJob	Queue a security synchronization job for a specific business module entity.
POST api/BusinessModules/{bmId}/Entities/{entityId}/QueueMasterSiteSyncJob	Queue a master site synchronization job a specific business module entity.
POST api/BusinessModules/{bmId}/QueueMasterSiteSyncJob	Queue a master site synchronization job for entities from a specific business module.
POST api/BusinessModules/{bmId}/QueueSecuritySynchronizationJob	Queue a security synchronization job for a specific business module.
GET api/BusinessModules/{businessModuleId}/MasterSiteLists	Gets all lists.
GET api/BusinessModules/{businessModuleId}/MasterSiteDocumentLibraries	Gets all document libraries
GET api/BusinessModules/{businessModuleId}/EntitySiteListFieldsSchema?listWebRelativeUrl={listWebRelativeUrl}&contentType={contentType}&mapping={mapping}	Get field schema used for other entity actions in the WorkPoint Connector
GET api/BusinessModules/{businessModuleId}/EntitySiteListFields?listWebRelativeUrl={listWebRelativeUrl}	Get master site list fields
GET api/BusinessModules/{businessModuleId}/EntitySiteListFieldsSchemaWithId?listWebRelativeUrl={listWebRelativeUrl}	Get field schema used for other entity actions in the WorkPoint Connector
GET api/BusinessModules/{businessModuleId}/EntitySiteListContentTypes?listWebRelativeUrl={listWebRelativeUrl}	Gets all content types belonging to a list.
GET api/BusinessModules/{businessModuleId}/EntitySiteListContentTypesWithAll?listWebRelativeUrl={listWebRelativeUrl}	Gets all content types belonging to a list with an extra all option.
GET api/BusinessModules/{businessModuleId}/EntitySiteListDefaultContentTypes?listWebRelativeUrl={listWebRelativeUrl}	Gets all content types belonging to a list.
GET api/BusinessModules/{businessModuleId}/EntitySiteListViews?listWebRelativeUrl={listWebRelativeUrl}	Gets all content types belonging to a list.

DisableWebhooks

Controller for disabling webhooks during migration

API	Description
POST api/businessmodules/{businessModuleId}/entities/{entityId}/webhooks/disable	Moves an entity
POST api/businessmodules/{businessModuleId}/entities/{entityId}/webhooks/enable	Moves an entity

IntegrationSettings

API	Description
POST api/IntegrationSettings/FirstAgenda	No documentation available.
POST api/IntegrationSettings/FirstAgenda/ApplyTemplates	No documentation available.
GET api/IntegrationSettings/FirstAgenda	No documentation available.
POST api/IntegrationSettings/DynamicTemplate	No documentation available.
GET api/IntegrationSettings/DynamicTemplate	No documentation available.
POST api/IntegrationSettings/GeoEnviron	No documentation available.
GET api/IntegrationSettings/GeoEnviron	No documentation available.
GET api/IntegrationSettings/Kombit	No documentation available.
POST api/IntegrationSettings/Kombit	No documentation available.
GET api/IntegrationSettings/WebLager	No documentation available.
POST api/IntegrationSettings/WebLager	No documentation available.
GET api/IntegrationSettings/HjernenOgHjertet	No documentation available.
POST api/IntegrationSettings/HjernenOgHjertet	No documentation available.
GET api/IntegrationSettings/ArcGIS	No documentation available.
POST api/IntegrationSettings/ArcGIS	No documentation available.
GET api/IntegrationSettings/BusinessModules/{businessModuleId}/ApplyDigitalPostFeature	No documentation available.

WebHookFilters

API	Description
GET api/webhooks/filters	No documentation available.

NotifyApi

API	Description
GET api/Notify	No documentation available.
POST api/Notify/BusinessModules/{businessModuleId}/Entities/{entityId}?workPointTrigger={workPointTrigger}	Notify all WebHooks that match all parameters except entityId

Notification

Controller for managing notifications.

API	Description
PUT api/Notifications/Initialize	No documentation available.
GET api/Notifications/NotificationSettings	Get Notification Settings
GET api/Notifications/GetDefaultNotificationAdaptiveCardTemplate	Gets the default Adaptive Card template for Notifications
PUT api/Notifications/NotificationSettings	Updates the globally configured notification settings
POST api/Notifications	Create a notification
POST api/Notifications/{itemId}/UpdateStatus?status={status}	Update a notification status
DELETE api/Notifications/{itemId}	Delete a notification
GET api/Notifications/User	Get user notifications
GET api/Notifications/NotificationCountForIcon	Get notification count for icon
GET api/Notifications/NotificationTermTypes	Get Notification Term Types KeyValuePairs
GET api/Notifications/NotificationTermPriorities	Get Notification Term Priority KeyValuePairs
GET api/Notifications/Terms	No documentation available.
GET api/Notifications/TeamsAppManifest	No documentation available.
POST api/Notifications/GenerateTeamsAppManifest	No documentation available.

SupportRequest

API	Description
GET api/SupportRequest	Gets a specific support request
GET api/SupportRequest/{id}	Gets a specific support request
GET api/SupportRequest/Requests	Gets support requests
PUT api/SupportRequest/Store	Store a support request ticket

License

Controller for managing solution license and features

API	Description
GET api/License/IsLicensed	Checks if the current solution is licensed
GET api/License/EntityConsentStatus?businessModuleId={businessModuleId}&entitySiteUrl={entitySiteUrl}	Retrieves the consent status of a given entity item
PUT api/License/AcceptEntityConsent?businessModuleId={businessModuleId}&entitySiteUrl={entitySiteUrl}	Add entry to consent list
GET api/License/GlobalConsentStatus	Retrieves the global consent status
PUT api/License/AcceptGlobalConsent	Add entry to global consent list
GET api/License/UserLicense	Checks if the user is licensed on the current solution
GET api/License/Features	Gets all the features licensed for the current solution
GET api/License/HasFeature/{id}	Checks if the current solution has a license that includes the specified feature id
GET api/License/IslimitedUser/{userPrincipalName}	Checks if a user is a limited user
GET api/License/SubscriptionInfo	Gets subscription information for the current solution

Parameter

Controller for managing advanced parameters for web apis.

API	Description
POST api/Parameter/Set	Saves parameter object and returns an identifier
GET api/Parameter/Get/{identifier}	Gets a parameter as an object
GET api/Parameter/GetBaseParameter/{identifier}	Gets a parameter as a BaseParameter
GET api/Parameter/GetPowerAppAndFlowParameter/{identifier}	Gets a parameter for PowerApp or Flow integration
POST api/Parameter/ConstructPowerAppAndFlowParameter	Constructs and saves a PowerAppAndFlowParameter and returns an identifier.

Token

API	Description
GET api/Token	No documentation available.
GET api/Token/WebApiToken4Teams	No documentation available.
GET api/Token/WebAPI?client={client}	No documentation available.
GET api/Token/IsLicensed	Check if Teams Apps Studio is licensed
GET api/Token/IsFeatureLicensed/{id}	Checks if provided featre is licesnsed
GET api/Token/Version	Get Solution Version
GET api/Token/Solution	Get Solution Details
GET api/Token/GetToken?scopes={scopes}&clientId={clientId}&clientSecret={clientSecret}	No documentation available.

SearchSettings

Search settings handling

API	Description
GET api/SearchSettings/Get	No documentation available.
GET api/SearchSettings/ResultGroups/{searchSettings}	No documentation available.

MyTools

Controller for managing my tools.

API	Description
GET api/MyTools	Gets my tools

Relation

Controller for managing Relations.

API	Description
PUT api/Relations	Update relation(s)
POST api/Relations	Create relation(s)
GET api/Relations/RelationTypes	Get Relation Types
GET api/Relations/Configuration	Get Relations Configuration
POST api/Relation/GetRelationsByEntity	Get Relations for Entity
POST api/relations/GetRelationsByEntity	Get Relations for Entity
GET api/relations/{id}	Get Relation
DELETE api/relations/{id}	Delete Relation
POST api/relations/ReplaceRelationsByEntity	Replace Relations By Entity
POST api/relations/query	Query relations across multiple entities

SiteProperties

API	Description
GET api/SiteProperties?siteUrl={siteUrl}	Gets Site Properties

Event

Controller for managing events.

API	Description
POST api/Event/CreateAzureEventGridMessage	Creates an Azure Event Grid Message
GET api/Event/EventGridTokens	Gets configured Access Tokens
GET api/Event/ExistsEvent?entityListID={entityListID}&entityID={entityID}&eventListID={eventListID}&eventID={eventID}	Checks if an event exists
POST api/Event/CreateEvent?entityListID={entityListID}&entityID={entityID}	Creates an event
POST api/Event/UpdateEvent?entityListID={entityListID}&entityID={entityID}	Updates a event
GET api/Event/DeleteEvent?entityListID={entityListID}&entityID={entityID}&eventListID={eventListID}&eventID={eventID}	Deletes a event

RelatedContent

Controller for related content.

API	Description
POST api/RelatedContent/GetRelatedContents	Retrieves a list of related contents for a given item

Utility

Controller for utilities.

API	Description
GET api/Utility/GetBackendUrl	Gets the backend url

UserSettings

Endpoint related to WorkPoint User Settings.

API	Description
POST api/Users/Settings	Update a users settings for the current user.
GET api/Users/Settings	Retrieves user settings for the current user.
GET api/Users/NotificationSettings	Retrieves user notification settings for the current user.
POST api/Users/NotificationSettings	Update user notification settings for the current user.
GET api/Users/AdminFavorites	Retrieves Admin menu favorites for the current user.
POST api/Users/AdminFavorites	Adds an Admin menu favorite for the current user.
PUT api/Users/AdminFavorites	Updates Admin menu favorites for the current user.
DELETE api/Users/AdminFavorites/{id}	Removes an Admin menu favorite for the current user.
GET api/Users/Memberships	Gets a list of groups current user is a member of.
GET api/Users/SiteMemberships?siteAbsoluteUrl={siteAbsoluteUrl}	Gets lists of AD Groups, Associated Groups and SharePoint Groups, the current user is member of in provided site.
GET api/Users/MyProcessSettings	Retrieves "My Process Settings" for the current user.
GET api/Users/TimeZoneInfo?webUrl={webUrl}	Gets the time zone info for the user's or web's time zone, based on the SPS-RegionalSettings-FollowWeb setting
GET api/Users/UserCultureAndTimeZoneInfo?webUrl={webUrl}	Gets the time zone info for the user's or web's time zone, based on the SPS-RegionalSettings-FollowWeb setting as well as the currentCulture and currentUICulture of the user.
POST api/Users/MyProcessSettings	Update "My Process Settings" for the current user

Document

Controller for documents.

API	Description
POST api/Document/CopyDocuments	Copy or move documents
POST api/Document/ValidatePDF	Validates PDF documents
GET api/Document/GetTemplateLibraries	Gets all the template libraries
GET api/Document/Transparency	Gets all transpancies
GET api/Document/TextRedactionOptions	Gets all active actions on a business module
GET api/Document/Colors	Gets all active actions on a business module
POST api/Document/EditManipulatePDF	Edit and manipulate PDF https://docs.aspose.com/pdf/net/replace-text-in-pdf/ https://docs.aspose.com/pdf/net/extra-annotations/#redact-certain-page-region-with-redaction-annotation-using-asposepdf-for-net
POST api/Document/ConvertToPDF	Converts selected documents to PDFs
POST api/Document/ConvertToPdfAndSaveOutputId	Converts a document to pdf and saves it to a list and returns the id of the listitem
POST api/Document/ConvertToPdfAndSaveOutput	Converts a document to pdf and saves it to a list
POST api/Document/DigitalSignatureCreateLogEntryForTransaction	Creates a log entry for a digital signature transaction
POST api/Document/DigitalSignatureAddDocumentToTransaction	Adds a document to a digital signature transaction
POST api/Document/DigitalSignatureCompleteDocumentInTransaction	Completes a document in a digital signature transaction
POST api/Document/DigitalSignatureBase64CompleteDocumentInTransaction	Completes a document in a digital signature transaction (Base64)
POST api/Document/DigitalSignatureGenerateXwsseHeader	Generates a xwsse header to use for digital signature
GET api/Document/DigitalSignatureUnixTimeMilliseconds	Gets DateTimeOffset.UtcNow converted to Unix time milliseconds
GET api/Document/DigitalSignatureLogEntry/{transactionID}	Gets a log entry from the digital signature log
POST api/Document/CompressToZip	Compress to ZIP file

RecordManagement

Controller for record management.

API	Description
POST api/RecordManagement/Declare?siteUrl={siteUrl}&documentUrl={documentUrl}	Declare document as record
POST api/RecordManagement/Undeclare?siteUrl={siteUrl}&documentUrl={documentUrl}	Undeclare document as record

CasePresentation

API	Description
POST api/CasePresentation/Setup	No documentation available.

Introduction

Task

Process

WebHookRegistrations

Uninstall

EMM

EventBus

Wizard

NavigationSettings

Entity

Health

BufferSites

Command

ExpressPanelSettings

Suggestion

Install

SignalR

Consent

ListItem

EntityActivityLog

WebHookProxy

Teams

Favorites

Admin

NumeratorService

MailMerge

ActionManagement

Taxonomy

Outlook

Solution

List

SecurityReplication

Search

SiteManagement

MailJournal

BusinessModules

DisableWebhooks

IntegrationSettings

WebHookFilters

NotifyApi

Notification

SupportRequest

License

Parameter

Token

SearchSettings

MyTools

Relation

SiteProperties

Event

RelatedContent

Utility

UserSettings

Document

RecordManagement

CasePresentation