WorkPoint 365 (Preview)

WorkPoint 365 is a Microsoft 365–native platform for managing structured business information across projects, cases, quality processes, and HR workflows. This connector enables automated interactions with WorkPoint 365 data through certified actions and triggers, helping organizations build reliable integrations and streamline business processes.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	WorkPoint Support
URL	https://support.workpoint.dk
Email	support@workpoint.dk

Connector Metadata
Publisher	WorkPoint 365
Website	https://www.workpoint365.com/
Privacy policy	https://www.workpoint365.com/privacy-policy/
Categories	Productivity;Content and Files

WorkPoint 365 Connector Overview

The WorkPoint 365 Connector enables seamless integration with the Power Platform. This powerful connector is designed for users who have an active WorkPoint 365 solution, with the integration feature already enabled.

Prerequisites

You will need the following to proceed: Before leveraging the advantages of the WorkPoint 365 Connector, you will need to have your WorkPoint 365 solution up and running. If you're new to WorkPoint 365 or interested in activating a solution, discover more at the official WorkPoint website.

For comprehensive information regarding the functionality and setup of the WorkPoint 365 Connector, please refer to our knowledge base article: WorkPoint Connector for Microsoft Power Automate and Power Apps.

Should you encounter any challenges or require assistance with the Power connector, do not hesitate to reach out to the WorkPoint Support team for expert help.

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Adds a document to a digital signature transaction	This action adds a document to a digital signature transaction
Archive team	The action is used to archive a team which is attached to a business module entity in WorkPoint.
Change welcome page	this action can be used to change the welcome page.
Changes the stage for an entity	Action to change the stage of an entity.
Completes a document in a digital signature transaction	This action completes a document in a digital signature transaction
Completes a document in a digital signature transaction (Base64)	This action completes a document in a digital signature transaction
Compress to ZIP file	Action to compress documents to a zip file.
Concatenate multiple files and save as PDF	This action concatenates multiple files and saves it as a pdf.
Converts a document to pdf and saves it to a list	This action converts a document to pdf and saves it to a list
Converts selected documents to PDFs	This action takes a set of documents and converts them into one of the supported PDF formats.
Copy or move documents	This action is used for copying or moving documents from one library to another.
Create a List Item	Action to create a list item.
Create a notification	This action creates a notification in WorkPoint
Create activity	This action creates an entry in the Entity Activity Log
Create business module entity in WorkPoint	Action to create an entity.
Create item	Action to create a list item.
Create team	This action can be used to create an office group and connect it to a site.
Create Word document from a template	Creates a Word document based on a template and returns the document
Create Word document from a template and returns as html	Creates a Word document based on a template and returns the document as html
Creates a log entry for a digital signature transaction	This action creates a log entry for a digital signature transaction
Declare document as record	Declares a document in WorkPoint as a record
Executes an action on a business module entity	this action can be used to execute a configured action on a business module entity.
Generates a xwsse header to use for digital signature	This action generates a xwsse header to use for digital signature
Get entity	This action gets an entity from WorkPoint
Get item	Gets a list item in an entity site list
Get next sequence number	Gets the next sequence number for the specified sequence id
Gets a business module	Gets a business module by id within the WorkPoint 365 solution
Gets a parameter for PowerApp or Flow integration	Gets a parameter for PowerApp or Flow integration
Gets all business modules	Gets all business modules within the WorkPoint 365 solution
Gets DateTimeOffset.UtcNow converted to Unix time milliseconds	This action takes a DateTimeOffset.UtcNow and converts it to Unix time in milliseconds
Grants application permission full control to selected site	Grants application permission full control to selected site.
Lock entity	This action can be used to lock the selected entity.
Move entity (Action management)	this action can be used to move an entity
Moves an entity	This action moves an entity.
Queue site creation job	This action queues a site creation job
Register site collection	Register a site collection to be used by WorkPoint for multi site collection
Send e-mail	The action can be used to send e-mails.
Set default view	An action that can be used to change the default view.
Toggle entity as favorite	This action can be used to toggle an entity as favorite
Unarchive team	The action is used to unarchive a team associated with a WorkPoint entity which was previously archived.
Undeclare document as record	Undeclares a document in WorkPoint as a record
Unlock entity	This action can be used to unlock the selected entity.
Update a notification status	This action uppdates the status of a notification in WorkPoint
Update entity	Action to update an entity.
Update item	Action to update a list item.

Adds a document to a digital signature transaction

Operation ID:

Document_DigitalSignatureAddDocumentToTransaction

This action adds a document to a digital signature transaction

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Transaction ID	TransactionID		string	The transacation id
Document site URL	DocumentSiteUrl		string	The absolute site url of where the document is saved
Document URL	DocumentUrl		string	The absolute document url
Signing set properties behaviour	SigningSetPropertiesBehaviour		string	The signing properties behaviour
Signing declare as record behaviour	SigningDeclareAsRecordBehaviour		string	The record declaration setting
Signing type	SigningType		string	The signing type
PDF format	PdfFormat		string	The PDF format to be used. If not specified the default PDF format will be used

Returns

Return value for for the method DigitalSignatureAddDocumentToTransaction.

Body

WorkPoint365.WebAPI.Model.Document.DigitalSignatureAddDocumentToTransactionReturnValue

Archive team

Operation ID:

ArchiveTeam

The action is used to archive a team which is attached to a business module entity in WorkPoint.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Callback Url	callbackUrl		string	Callback url to be triggered on operation completion.

Returns

Change welcome page

Operation ID:

ChangeWelcomePage

this action can be used to change the welcome page.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Welcome page (see comment)	WelcomePage		string

Returns

response

boolean

Changes the stage for an entity

Operation ID:

Entity_ChangeStage

Action to change the stage of an entity.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Stage	stageId	True	string	The ID for the content type (stage) to change to
Stage constraint behaviour	overrideConstraints	True	string	Stage constraint behaviour
Override required fields	overrideRequiredFields	True	boolean	If true, it is accepted that required fields does not have a value
Fields	data	True	dynamic	Configure fields of the selected entity

Returns

response

boolean

Completes a document in a digital signature transaction

Operation ID:

Document_DigitalSignatureCompleteDocumentInTransaction

This action completes a document in a digital signature transaction

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Signed PDF bytes	SignedPdfBytes		byte	The PDF document as a byte array.
Transaction ID	TransactionID		string	The transacation id
File name	FileName		string	The file name with extension to complete
Signed status	SigningStatus		string	The signing status
Message	Message		string	An optional message
Undeclare original document or appendix file as record	UndeclareOriginalDocumentOrAppendixFileAsRecord		boolean	The document undeclaration behaviour. If set to true, the original document is undeclared as record

Returns

response

array of WorkPoint365.WebAPI.Model.Document.DigitalSignatureError

Completes a document in a digital signature transaction (Base64)

Operation ID:

Document_DigitalSignatureBase64CompleteDocumentInTransaction

This action completes a document in a digital signature transaction

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Signed PDF base 64 string	SignedPdfBase64String		string	The PDF document as a base64 string.
Transaction ID	TransactionID		string	The transacation id
File name	FileName		string	The file name with extension to complete
Signed status	SigningStatus		string	The signing status
Message	Message		string	An optional message
Undeclare original document or appendix file as record	UndeclareOriginalDocumentOrAppendixFileAsRecord		boolean	The document undeclaration behaviour. If set to true, the original document is undeclared as record

Returns

response

array of WorkPoint365.WebAPI.Model.Document.DigitalSignatureError

Compress to ZIP file

Operation ID:

CompressToZIPFile

Action to compress documents to a zip file.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
model	model	True	dynamic

Concatenate multiple files and save as PDF

Operation ID:

ConcatenateFilesToPDF

This action concatenates multiple files and saves it as a pdf.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	Which business module to use
Entity	entityId	True	string	Which business module entity to use
Documents	Documents		object
Pdf Format	PdfFormat		string	The pdf format you want to use.
Include Page Numbers	IncludePageNumbers		boolean	Include Page Numbers
Include Source Information	IncludeSourceInformation		boolean	Include Source Information
Include Table of Contents	IncludeTableOfContents		boolean	Include Table of Contents
UseLatestMinorVersion	UseLatestMinorVersion		boolean
Overwrite existing files.	OverwriteExistingFiles		boolean	Whether to overwrite existing files.
Source Folder Path	SourceFolderPath		string	The folder path where you want the file.
Source List	SourceListRelativWebPath	True	string	The id of the source list.
Target Business Module	TargetBusinessModuleId	True	uuid	The id of the target business module.
Target Business Module Item	TargetBusinessModuleItemId	True	integer	The id of the target business module item.
Target Folder Path	TargetFolderPath		string	The folder path where you want the file.
Target List	TargetListRelativWebPath	True	string	The id of the target list.
Output Filename	OutputFileName	True	string	The filename you want the new file to have.

Returns

response

uuid

Converts a document to pdf and saves it to a list

Operation ID:

Document_ConvertToPdfAndSaveOutput

This action converts a document to pdf and saves it to a list

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Document site URL	DocumentSiteUrl		string	The absolute url of the site where the document is saved
Document URL	DocumentUrl		string	The absolute url of the document to be converted to pdf
Output site URL	OutputSiteUrl		string	The absolute url of the site where the output document should be saved
Output URL	OutputUrl		string	The url of the location where the converted pdf should be saved
Output exists behaviour	OutputExistsBehaviour		string	The override behaviour
PDF format	PdfFormat		string	The PDF conversion format. If not specified the default PDF format will be used

Converts selected documents to PDFs

Operation ID:

Document_ConvertToPDF

This action takes a set of documents and converts them into one of the supported PDF formats.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Documents to convert	Documents to convert		object
Destination business module	TargetBusinessModule	True	uuid
Destination entity	TargetBusinessModuleEntity	True	integer
Destination Library	TargetList	True	string
Destination folder	TargetFolder		string
Output exists behaviour	OutputExistsBehaviour	True	string	The override behaviour
PDF format	PdfFormat	True	string	The PDF conversion format. If not specified the default PDF format will be used
Load source property values	UseStepInputValues		boolean	Should the step use the values from the step input when creating the items. Not applicaple in Combine Files Mode.
Source Item Fields To Copy To Pdf Item	SourceItemFieldsToCopyToPdfItem		array of string	Option to Add Index
Combine Files	CombineFiles		boolean	Option to select if the converted PDFs should be Concactated
Combined file properties	FieldValues		object	Collection of the field values for the converted file(s)
Add page numbers	AddPageNumbers		boolean	Option to Add page numbers
Add Index	AddIndex		boolean	Option to Add Index
Add source information	AddSourceInformation		boolean	Option to Add Source Information
Version	DocumentVersion		string	Option for which Version to use
Async	Async		boolean	Select this option if you want to run the process in asynchronous operation
Callback Url	CallbackUrl		string	Option for Callback Url
Callback Headers	CallbackHeaders		object	Option for Callback Headers

Returns

Body

WorkPoint365.WebAPI.Model.ProcessContextItemOutPutResult

Copy or move documents

Operation ID:

Document_CopyDocuments

This action is used for copying or moving documents from one library to another.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Mode	Mode	True	string
Source documents	Source documents		object
Target business module	TargetBusinessModuleId	True	uuid	Which business module to use
Target entity	TargetEntityId	True	integer	Which business module entity to use
Target list	TargetWebRelativListUrl	True	string	The target list to import the document to
Target folder	TargetFolderRelativListUrl		string	The target folder on the target list to import the document to
Naming conflict behavior	NameConflict	True	string	Sets what to do, if a document with that name already exists on destination
Ignore version history	IgnoreVersionHistory		boolean	This property controlls if you want to include version history or not
Content type	ContentTypeId		string	The defined content type id will be set after the copy/move operation

Returns

response

string

Create a List Item

Operation ID:

CreateAListItem

Action to create a list item.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
List Id	listId	True	uuid	The id of the list in sharepoint.
			object

Returns

response

object

Create a notification

Operation ID:

Notification_Create

This action creates a notification in WorkPoint

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Notification title	Title	True	string	Item title
Notification type	NotificationType	True	string	Notification Type
Status	Status	True	string	Notification Status
Priority	Priority	True	string	Notification Priority
Message	Message	True	string	Notification Message
Deadline	Deadline		date-time	Notification Deadline
Delivery date	DeliveryDate		date-time	Notification Delivery Date
Recipient	Recipient	True	object	Notification Recipient
Duplicate behaviour	DuplicateBehaviour	True	string	Notification Duplication Behaviour
Business module	BusinessModuleId	True	uuid	Notification Business Module Id
Entity	EntityId	True	integer	Notification Entity Id (Context of the notification)
List	List		string	Notification List Id or Web Relativ List Url
Item	ItemId		integer	Notification Item Id (Context of the notification)

Returns

response

object

Create activity

Operation ID:

EntityActivityLog_Add

This action creates an entry in the Entity Activity Log

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Title	Title	True	string	Title of the event.
Type	EventType	True	string	The type of event. Value must be a path to the EventType term in the termstore (e.g. Document;Created).
Type ID	EventTypeId	True	string	Entity Type Id
Source type	EventSourceType	True	string	Path to the EventSourceType term in the termstore (e.g. Document).
Date	EventDate	True	date-time	Timestamp when the event occurred.
User	EventUser		string	Login name of the user that initiated the event.
System	EventSystem		string	System from which the event originated
Business module	BusinessModuleId	True	uuid	ID of the business module where the event occurred.
Entity	Entity	True	integer	ID of the business module entity where the event occurred.
List	List		string	The list where the event occurred.
Item	Item		object
Item data	ItemData		string	Additional field values when the event occurred. Entered as a list of fields that exist on the Item object like this: Title,Author.email,Author.title
Details	Details		string	Additional details.

Returns

response

boolean

Create business module entity in WorkPoint

Operation ID:

Entity_Create

Action to create an entity.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business Module	businessModuleId	True	uuid	The ID of the business module
Create Site	createSite	True	boolean	Create a site when creating entity.
Fields	body	True	dynamic	Configure fields of the selected entity

Returns

The outputs of this operation are dynamic.

Create item

Operation ID:

CreateItem

Action to create a list item.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
List	listWebRelativeUrl	True	string	The the web relative URL of the list on the entity site
Fields	body	True	dynamic	The fields which you want to create the list item with
Existing document output behaviour	outputExists		string	What to do if the output document already exists
Content type	contentType		string	The content type of the list item
Template list	templateList		string	The template from a template list you want to use
Template item id	templateItem		integer	The template from a template list you want to use
Folder	folder		string	The folder on the list on the entity site

Returns

The outputs of this operation are dynamic.

Create team

Operation ID:

ConnectToOffice365Group

This action can be used to create an office group and connect it to a site.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Is public	IsPublic	True	boolean
Description	DescriptionField		string
Group alias	GroupAliasField	True	string
Group display name	GroupDisplayNameField	True	string
Callback Url	CallbackUrl		string
Callback Headers	CallbackHeaders		object

Returns

response

boolean

Create Word document from a template

Operation ID:

MailMerge_GetMailMergedWordDocument

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

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleID	True	uuid	The business module id of the entity
Entity	entityID	True	integer	The entity id
Template ID	templateID	True	integer	The Word template id
Include result as HTML	includeHtml	True	boolean	Include the document as HTML in the result
Include result as byte array	includeBytes	True	boolean	Include the document as a byte array in the result
Common Fields Business Module ID	commonFieldsBusinessModuleID		uuid	Business module id that the entity for common fields belongs to
Common Fields Entity ID	commonFieldsEntityID		integer	Entity id used for common fields

Returns

Body

WorkPoint365.WebAPI.Model.MailMergeDocumentResult

Create Word document from a template and returns as html

Operation ID:

MailMerge_GetMailMergedWordDocumentAsHtml

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

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleID	True	uuid	The id of the business module that the entity is belonging to.
Entity	entityID	True	integer	The id the entity
Word template ID	templateID	True	integer	The id of the Word template

Returns

Body

WorkPoint365.WebAPI.Model.MailMergeHtmlResult

Creates a log entry for a digital signature transaction

Operation ID:

Document_DigitalSignatureCreateLogEntryForTransaction

This action creates a log entry for a digital signature transaction

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Transaction ID	TransactionID		string	The transaction id
Signing provider	SigningProvider		string	The signing provider
Log title	LogTitle		string	The log title
Log description	LogDescription		string	The log description
Business module	BusinessModuleID		string	The business module id
Entity	EntityID		integer	The entity id
Total signing count	TotalSigningCount		integer	The total signing count
Total appendix count	TotalAppendixCount		integer	The total appendix count

Declare document as record

Operation ID:

RecordManagement_Declare

Declares a document in WorkPoint as a record

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Absolute site URL	siteUrl	True	string	The absolute url of the site where the document belongs to (the value must be UrlEncoded)
Absolute document URL	documentUrl	True	string	The absolute url of the document to declare (the value must be UrlEncoded)

Executes an action on a business module entity

Operation ID:

ActionManagement_RunAction

this action can be used to execute a configured action on a business module entity.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	bmId	True	uuid	The ID of the business module
Action	actionId	True	uuid	The id of the action to run
Entity	entityId	True	integer	The id of the entity in the business module

Returns

response

uuid

Generates a xwsse header to use for digital signature

Operation ID:

Document_DigitalSignatureGenerateXwsseHeader

This action generates a xwsse header to use for digital signature

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
User name	UserName		string	User name
Password	Password		string	Password

Returns

response

string

Get entity

Operation ID:

Entity_Get

This action gets an entity from WorkPoint

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity

Returns

The outputs of this operation are dynamic.

Get item

Operation ID:

GetAListItem

Gets a list item in an entity site list

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity on which entity site the list is found
Entity site list	listWebRelativeUrl	True	string	The the web relative URL of the list on the entity site
List item ID	listItemId	True	integer	The ID of the list item to get

Returns

The outputs of this operation are dynamic.

Get next sequence number

Operation ID:

NumeratorService_GetNextSequenceNumber

Gets the next sequence number for the specified sequence id

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Id	id	True	integer	The id of the sequence
Business Module Id	bmId		uuid	The id of the business module
Entity Id	entityId		integer	The id of the entity

Returns

response

string

Gets a business module

Operation ID:

BusinessModules_Lookup

Gets a business module by id within the WorkPoint 365 solution

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business Module	id	True	string	The ID of the Business Module

Returns

Body

WorkPoint365.WebAPI.Model.BusinessModuleOnline

Gets a parameter for PowerApp or Flow integration

Operation ID:

Parameter_GetPowerAppAndFlowParameter

Gets a parameter for PowerApp or Flow integration

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Parameter object identifier	identifier	True	string	The identifier of the parameter

Returns

Parameter used by Power App and Flow

Body

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter

Gets all business modules

Operation ID:

BusinessModules_Get

Gets all business modules within the WorkPoint 365 solution

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed

Returns

response

array of WorkPoint365.WebAPI.Model.BusinessModuleOnline

Gets DateTimeOffset.UtcNow converted to Unix time milliseconds

Operation ID:

Document_DigitalSignatureUnixTimeMilliseconds

This action takes a DateTimeOffset.UtcNow and converts it to Unix time in milliseconds

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed

Returns

response

integer

Grants application permission full control to selected site

Operation ID:

Consent_SetSelectedSiteFullControl

Grants application permission full control to selected site.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Site Url	siteUrl	True	string	The Url of the site to grant permissions for

Returns

response

boolean

Lock entity

Operation ID:

LockEntity

This action can be used to lock the selected entity.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Lock type	lockType	True	string	which type of lock to place
Callback Url	callbackUrl		string	Callback url to be triggered on operation completion.

Returns

Move entity (Action management)

Operation ID:

MoveEntity

this action can be used to move an entity

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Target business module	BusinessModuleId		uuid	Which Business Module to move the entity to
Target stage	StageId		string

Returns

Body

WorkPoint365.WebAPI.Model.MoveEntityResult

Moves an entity

Operation ID:

Move_Entity

This action moves an entity.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business Module	businessModuleId	True	uuid	The ID of the business module
Source Entity	sourceEntityId	True	integer	The source entity ID
Source entity list ID	SourceEntityListID		uuid	The source entity list identifier.
Source entity ID	SourceEntityID		integer	The source entity identifier.
Target entity list ID	TargetEntityListID		uuid	The target entity list identifier.
Target entity content type ID	TargetEntityContentTypeID		string	The target entity content type identifier.
Validate only	ValidateOnly		boolean	Gets or sets a value indicating whether [validate only].
Include progress log in result	IncludeProgressLogInResult		boolean	Gets or sets a value indicating whether [include progress log in result].
Run as job	RunAsJob		boolean	Gets or sets a value indicating whether [run as job].

Returns

response

uuid

Queue site creation job

Operation ID:

SiteManagement_QueueCreateSiteJob

This action queues a site creation job

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
BusinessModuleId	BusinessModuleId		uuid
EntityId	EntityId		integer
SiteUrl	SiteUrl		string
CallbackUrl	CallbackUrl		string
CallbackContent	CallbackContent		object
CallbackHeaders	CallbackHeaders		object

Returns

response

boolean

Register site collection

Operation ID:

SiteManagement_RegisterSiteCollection

Register a site collection to be used by WorkPoint for multi site collection

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Server relative URL	ServerRelativeUrl		string	Gets or sets the relative url of the site collection fx /sites/workpoint_0
Assigned business module ID	AssignedToBusinessModuleId		uuid	Gets or sets the id of the business module
Site collection type	SiteCollectionType		string	Gets or sets the use of the site collection. Can be Bucket or Entity (one-site per site collection)

Returns

response

boolean

Send e-mail

Operation ID:

SendMail

The action can be used to send e-mails.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
To	To		object
CC	CC		object
BCC	BCC		object
Subject	Subject		string
Body	Body		string

Returns

response

boolean

Set default view

Operation ID:

SetDefaultView

An action that can be used to change the default view.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
View URL (server relative)	ServerRelativeViewUrl		string
List URL (web relative)	WebRelativeListUrl		string

Returns

response

boolean

Toggle entity as favorite

Operation ID:

ActionManagement_MarkEntityAsFavorite

This action can be used to toggle an entity as favorite

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Mark as favorite	MarkAsFavorite		boolean	Mark or unmark as favorite
Users	UserLoginNames		array of string	Login names of users to apply favorite marking for.

Returns

response

boolean

Unarchive team

Operation ID:

UnarchiveTeam

The action is used to unarchive a team associated with a WorkPoint entity which was previously archived.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Callback Url	callbackUrl		string	Callback url to be triggered on operation completion.

Returns

Undeclare document as record

Operation ID:

RecordManagement_Undeclare

Undeclares a document in WorkPoint as a record

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Absolute site URL	siteUrl	True	string	The absolute url of the site where the document belongs to (the value must be UrlEncoded)
Absolute document URL	documentUrl	True	string	The absolute url of the document to undeclare (the value must be UrlEncoded)

Unlock entity

Operation ID:

UnlockEntity

This action can be used to unlock the selected entity.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Lock type	lockType	True	string	The type of lock
Callback Url	callbackUrl		string	Callback url to be triggered on operation completion.

Returns

Update a notification status

Operation ID:

Notification_UpdateStatus

This action uppdates the status of a notification in WorkPoint

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Item Id	itemId	True	integer	List item id of the notification to update
Status	status	True	string	Status to set for the notification - the status can be 'Unread', 'Action required' or 'Completed'.

Returns

response

boolean

Update entity

Operation ID:

UpdateEntity

Action to update an entity.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity
Fields	data	True	dynamic	Configure fields of the selected entity

Returns

The outputs of this operation are dynamic.

Update item

Operation ID:

UpdateItem

Action to update a list item.

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Business module	businessModuleId	True	uuid	The ID of the business module
Entity	entityId	True	integer	The ID of the business module entity on which entity site the list is found
List	listWebRelativeUrl	True	string	The the web relative url of the list on the entity site
Item ID	listItemId	True	integer	The ID of the list item to update
Content type	contentType	True	string	The content type of the list item
body	body	True	dynamic

Returns

The outputs of this operation are dynamic.

Triggers

Triggers when a WorkPoint event occurs

Creates a WorkPoint webhook

Triggers when a WorkPoint event occurs

Operation ID:

WebHookRegistrations_Post

Creates a WorkPoint webhook

Parameters

Name	Key	Required	Type	Description
WorkPoint365 URL	WorkPoint365Url	True	string	SharePoint site with WorkPoint365 installed
Description	Description		string	Web hook description
Business Module Id	BusinessModuleId	True	uuid	Business module id attached to web hook
Trigger Id	WorkPointTrigger	True	uuid	Trigger id attached to web hook

Returns

Definitions

WorkPoint365.WebAPI.Model.MoveEntityResult

Name	Path	Type	Description
Ok	Ok	boolean	Gets or sets a value indicating whether this {WorkPoint365.WebAPI.Model.MoveEntityResult} is ok.
Errors	Errors	array of string	Gets or sets the errors.
Warnings	Warnings	array of string	Gets or sets the warnings.
ProgressLog	ProgressLog	string	Gets or sets the progress log.

WorkPoint365.WebAPI.Model.ProcessContextItemOutPutViewModel

Name	Path	Type	Description
WebUrl	WebUrl	string
List	List	string
ID	ID	integer
Title	Title	string

WorkPoint365.WebAPI.Model.BusinessModuleOnline

Name	Path	Type	Description
Title	Title	string	The title of the business module
ListUrl	ListUrl	string	The relative url of the business module list in SharePoint
EntityName	EntityName	string	The name of a single entity (typical a singular expression)
Template	Template	integer	The business module template
Category	Category	integer	The category used to set entity move behaviour. It is only possible to move entities of same category across business modules
Parent	Parent	uuid	The parent business module
ParentRelationName	ParentRelationName	string	The parent field name
SitesEnabled	SitesEnabled	boolean	The value indicating whether sites are enabled
IconUrl	IconUrl	string	The business module icon url
EnableEMMIntegration	EnableEMMIntegration	boolean	The value indicating if EMM is enabled
Id	Id	uuid	The business module identifier
MasterSiteSettings	MasterSiteSettings	WorkPoint365.WebAPI.Model.MasterSiteSettings
FieldMappingsSettings	FieldMappingsSettings	WorkPoint365.WebAPI.Model.FieldMappingsSettings	The FieldMappingsSettings class
ClientSettings	ClientSettings	WorkPoint365.WebAPI.Model.ClientSettings

WorkPoint365.WebAPI.Model.MasterSiteSettings

Name	Path	Type	Description
Enabled	Enabled	boolean	The value indicating whether master site is enabled
MasterSiteUrl	MasterSiteUrl	string	The master site URL
ReplicateLists	ReplicateLists	boolean	The value indicating whether lists are replicated
ReplicateAppParts	ReplicateAppParts	boolean	The value indicating whether web parts are replicated
ReplicateFeatures	ReplicateFeatures	boolean	The value indicating whether SharePoint features are replicated

WorkPoint365.WebAPI.Model.FieldMappingsSettings

The FieldMappingsSettings class

Name	Path	Type	Description
ActiveSettings	ActiveSettings	WorkPoint365.WebAPI.Model.ActiveSettings	The Active settings class
CommonFieldMappingsSettings	CommonFieldMappingsSettings	WorkPoint365.WebAPI.Model.CommonFieldMappingsSettings	The CommonFieldMappingsSettings class
MyEntitiesFieldNames	MyEntitiesFieldNames	array of string	The my entities field names.
CurrentUserMappingField	CurrentUserMappingField	string	The current user mapping field.
AddressField	AddressField	string	The address field.
CityField	CityField	string	The city field.
ZipcodeField	ZipcodeField	string	The zipcode field.
CountryField	CountryField	string	The country field.
PhoneFieldNames	PhoneFieldNames	array of string	The phone field names.
EmailFieldNames	EmailFieldNames	array of string	The email field names.
UrlFieldNames	UrlFieldNames	array of string	The URL field names.

WorkPoint365.WebAPI.Model.ClientSettings

Name	Path	Type	Description
CachingDisabled	CachingDisabled	boolean	The value indicating whether caching is disabled
FieldsInSearchResult	FieldsInSearchResult	array of string	The fields in search result.
SearchableFields	SearchableFields	array of WorkPoint365.WebAPI.Model.ClientSettings.SearchableField	The collection of searchable fields.
AdvancedSearchableFields	AdvancedSearchableFields	array of WorkPoint365.WebAPI.Model.ClientSettings.SearchableField	The collection of advanced searchable fields.
MobileFields	MobileFields	array of WorkPoint365.WebAPI.Model.ClientSettings.MobileField	The collections of the mobile fields.
CommonFieldNames	CommonFieldNames	array of WorkPoint365.WebAPI.Model.ClientSettings.CommonFieldName	The collection of common field names.
FieldsInFavoriteName	FieldsInFavoriteName	array of string	The name of the fields in favorite.

WorkPoint365.WebAPI.Model.ActiveSettings

The Active settings class

Name	Path	Type	Description
FieldName	FieldName	string	The name of the field.
ActiveValues	ActiveValues	array of string	The active values.

WorkPoint365.WebAPI.Model.CommonFieldMappingsSettings

The CommonFieldMappingsSettings class

Name	Path	Type	Description
Mappings	Mappings	array of WorkPoint365.WebAPI.Model.CommonFieldMapping

WorkPoint365.WebAPI.Model.ClientSettings.SearchableField

Name	Path	Type	Description
InternalName	InternalName	string	The internal field name
Title	Title	string	The field title
Operator	Operator	string	The operator.
CommonName	CommonName	string	The common name

WorkPoint365.WebAPI.Model.ClientSettings.MobileField

Name	Path	Type	Description
InternalName	InternalName	string	The internal field name
Title	Title	string	The field title
MobileFieldVisibility	MobileFieldVisibility	string	The mobile field visibility

WorkPoint365.WebAPI.Model.ClientSettings.CommonFieldName

Name	Path	Type	Description
InternalName	InternalName	string	The internal field name
CommonName	CommonName	string	The common field name

WorkPoint365.WebAPI.Model.CommonFieldMapping

The CommonFieldMapping class

Name	Path	Type	Description
CommonFieldName	CommonFieldName	string	The common field name
MappedFieldName	MappedFieldName	string	The mapped field name

WorkPoint365.WebAPI.Model.ProcessContextItemOutPutViewModel.WorkPoint365.WebAPI.Model.SerializableException.ResultEventReference

Name	Path	Type	Description
Reference	Reference	WorkPoint365.WebAPI.Model.ProcessContextItemOutPutViewModel
Event	Event	WorkPoint365.WebAPI.Model.SerializableException

WorkPoint365.WebAPI.Model.ProcessContextItemOutPutViewModel.System.String.ResultEventReference

Name	Path	Type	Description
Reference	Reference	WorkPoint365.WebAPI.Model.ProcessContextItemOutPutViewModel
Event	Event	string

WorkPoint365.WebAPI.Model.SerializableException

Name	Path	Type	Description
TimeStamp	TimeStamp	date-time
Message	Message	string
StackTrace	StackTrace	string
InnerException	InnerException	object
ExceptionType	ExceptionType	string
ExceptionMessage	ExceptionMessage	string
ExceptionData	ExceptionData	object

WorkPoint365.WebAPI.Model.ProcessContextItemOutPutResult

Name	Path	Type	Description
Result	Result	array of WorkPoint365.WebAPI.Model.ProcessContextItemOutPutViewModel
Errors	Errors	array of WorkPoint365.WebAPI.Model.ProcessContextItemOutPutViewModel.WorkPoint365.WebAPI.Model.SerializableException.ResultEventReference
Warnings	Warnings	array of WorkPoint365.WebAPI.Model.ProcessContextItemOutPutViewModel.System.String.ResultEventReference
SignalRIdentifier	SignalRIdentifier	string
SignalRUrl	SignalRUrl	string

WorkPoint365.WebAPI.Model.Document.DigitalSignatureAddDocumentToTransactionReturnValue

Return value for for the method DigitalSignatureAddDocumentToTransaction.

Name	Path	Type	Description
PdfUrl	PdfUrl	string	Pdf url
PdfServerRelativeUrl	PdfServerRelativeUrl	string	Pdf server releative url
Errors	Errors	array of WorkPoint365.WebAPI.Model.Document.DigitalSignatureError	A collection of errors

WorkPoint365.WebAPI.Model.Document.DigitalSignatureError

Error for digital signature.

Name	Path	Type	Description
ErrorType	ErrorType	string	Error type
Text	Text	string	Text

WorkPoint365.WebAPI.Model.MailMergeHtmlResult

Name	Path	Type	Description
Html	Html	string	Gets or sets the HTML.
Subject	Subject	string	Gets or sets the Subject.
ErrorMessages	ErrorMessages	array of string	Gets or sets the error messages.
Ok	Ok	boolean	Gets a value indicating whether this {WorkPoint365.WebAPI.Model.MailMergeHtmlResult} is ok.

WorkPoint365.WebAPI.Model.MailMergeDocumentResult

Name	Path	Type	Description
Html	Html	string	Gets or sets the HTML.
Bytes	Bytes	byte	Gets or sets the Bytes.
FileName	FileName	string	Gets or sets the FileName.
Subject	Subject	string	Gets or sets the Subject.
ErrorMessages	ErrorMessages	array of string	Gets or sets the error messages.
Ok	Ok	boolean	Gets a value indicating whether this {WorkPoint365.WebAPI.Model.MailMergeDocumentResult} is ok.

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter

Parameter used by Power App and Flow

Name	Path	Type	Description
Entity	Entity	WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.EntityInfo	Entity information
Library	Library	WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.LibraryInfo	Library information
Documents	Documents	array of WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.DocumentInfo	List of documents
Properties	Properties	object	Dictionary containing property names with corresponding values

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.EntityInfo

Entity information

Name	Path	Type	Description
ListId	ListId	uuid	Entity list id
ListItemId	ListItemId	integer	Entity list item id
Title	Title	string	Entity title
ServerRelativeUrl	ServerRelativeUrl	string	Entity server relative url
Properties	Properties	object	Dictionary containing property names with corresponding values

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.LibraryInfo

Library information

Name	Path	Type	Description
Id	Id	uuid	The id of the library
ServerRelativeUrl	ServerRelativeUrl	string	Library server relative url
Name	Name	string	Library name

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.DocumentInfo

Document information

Name	Path	Type	Description
Id	Id	integer	Document id
Name	Name	string	Document name
ServerRelativeUrl	ServerRelativeUrl	string	Document server relative url
WebRelativeUrl	WebRelativeUrl	string	Document web relative url
Properties	Properties	object	Dictionary containing property names with corresponding values

string

This is the basic data type 'string'.

object

This is the type 'object'.

uuid

uuid

integer

This is the basic data type 'integer'.

boolean

This is the basic data type 'boolean'.