ListItem

Controller for managing items on a list.

APIDescription
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/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

Changes the stage for an entity

Task

Controller for managing tasks.

APIDescription
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.

BusinessModuleTabViewSettings

Controller for managing Business Module tab view settings

APIDescription
GET api/BusinessModulesTabViewSettings

Gets all Tab View Settings for all business modules

GET api/BusinessModuleTabViewSettings/{id}

Gets all Tab View Settings for the Business Module with the specified id

MailMerge

Controller for accessing the NumeratorService.

APIDescription
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}

Creates a Word document based on a template and returns the document as html

GET api/MailMerge/GetMailMergedWordDocument?businessModuleID={businessModuleID}&entityID={entityID}&templateID={templateID}&includeHtml={includeHtml}&includeBytes={includeBytes}&commonFieldsBusinessModuleID={commonFieldsBusinessModuleID}&commonFieldsEntityID={commonFieldsEntityID}

Creates a Word document based on a template and returns the document

Document

Controller for documents.

APIDescription
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

NotifyApi

APIDescription
POST api/Notify/BusinessModules/{businessModuleId}/Entities/{entityId}?workPointTrigger={workPointTrigger}

Notify all WebHooks that match all parameters except entityId

BusinessModules

Controller for managing Business Modules.

APIDescription
GET api/BusinessModules

Gets all business modules

GET api/BusinessModules/{id}

Gets a business module

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

Event

Controller for managing events.

APIDescription
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

License

Controller for managing solution license and features

APIDescription
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/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

Command

Controller for managing solution license and features

APIDescription
POST api/Command/CreateSites

Creates an entity site

POST api/Command/DeleteSites

Deletes an entity site

RecordManagement

Controller for record management.

APIDescription
POST api/RecordManagement/Declare?siteUrl={siteUrl}&documentUrl={documentUrl}

Declares a document as record

POST api/RecordManagement/Undeclare?siteUrl={siteUrl}&documentUrl={documentUrl}

Undeclares a document as record

List

Controller for managing Lists.

APIDescription
GET api/lists

Gets all lists.

GET api/lists/{id}

Gets the list with the specified id.

Parameter

Controller for managing advanced parameters for web apis.

APIDescription
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.

Favorites

Controller for managing Favorites

APIDescription
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

Wizard

Controller for managing wizards.

APIDescription
GET api/Wizard/Configurations

Gets all wizard configurations.

POST api/Wizard/StoreFile

Store file temporary in blob storage

EMM

Controller for accessing EMM

APIDescription
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

WebHookFilters

APIDescription
GET api/webhooks/filters

No documentation available.

WebHookRegistrations

APIDescription
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.

MyTools

Controller for managing my tools.

APIDescription
GET api/MyTools

Gets my tools

ActionManagement

Controller for managing Actions and Triggers

APIDescription
GET api/BusinessModules/{id}/Actions

Gets all active actions on a business module

GET api/BusinessModules/{id}/Triggers

Gets all active triggers on a business module

POST api/BusinessModules/{bmId}/Actions/{actionId}/Run?entityId={entityId}

Executes an action on a business module entity

Relation

Controller for managing Relations.

APIDescription
POST api/relations/GetRelationsByEntity

Gets the relations for an item with the specified parameter.ItemID in the specified list parameter.ListID.

POST api/Relation/GetRelationsByEntity

Gets the relations for an item with the specified parameter.ItemID in the specified list parameter.ListID.

GET api/relations/{id}

Get a relation with the specified id.

DELETE api/relations/{id}

Deletes a relation with the specified id.

NumeratorService

Controller for accessing the NumeratorService.

APIDescription
GET api/NumeratorService/NextSequenceNumber/{id}

Gets the next sequence number for the specified sequence id.

Entity

Controller for managing entities

APIDescription
POST api/Entity/Move

Moves an entity

SiteManagement

Controller for managing Sites

APIDescription
POST api/SiteManagement/CreateSiteIfNotExists

Creates a site for a list item if it does not exists.