Partilhar via


WorkPoint

WorkPoint 365 business-solution makes it easy to manage critical processes.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   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)
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)
Contact
Name WorkPoint Support
URL https://support.workpoint.dk
Email support@workpoint.dk
Connector Metadata
Publisher WorkPoint
Website https://www.workpoint365.com/
Privacy policy https://www.workpoint365.com/privacy-policy/
Categories Productivity;Content and Files

The WorkPoint Connector is WorkPoint’s integration to the Power platform. To use this integration, users must have an active WorkPoint 365 solution with the integration feature activated. If you don’t have an active WorkPoint 365 solution and want to learn more, please visit WorkPoint

For further information about the WorkPoint connector, please visit our knowledgebase: WorkPoint Connector

If you experience any issues with the Power connector, please contact WorkPoint Support.

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

Adds a document to a digital signature transaction

Changes the stage for an entity

Changes the stage for an entity

Changes the stage for an entity and set field values

Changes the stage for an entity and set field values

Completes a digital signature transaction (base64)

Completes a document in a digital signature transaction using a pdf file represented as a base64 string

Completes digital signature transaction (byte array)

Completes a document in a digital signature transaction using a pdf file represented as a byte array

Converts a document to pdf and saves it to a list

Converts a document to pdf and saves it to a list

Copies a business module entity in WorkPoint

Copies business module entity in WorkPoint

Create business module entity in WorkPoint

Create business module entity in WorkPoint

Creates a log entry for a digital signature transaction

Creates a log entry for a digital signature transaction

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

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

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

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

Declares a document as record

Declares a document as record

Executes an action on a business module entity

Executes an action on a business module entity

Generates a xwsse header to use for digital signature

Generates a xwsse header to use for digital signature

Gets a log entry from the digital signature log

Creates a log entry for a digital signature transaction

Gets a parameter for App or flow integration

Gets a parameter for app or flow integration.

Gets all active actions on a business module

Gets all active actions on a business module

Gets all active triggers on a business module

Gets all active triggers on a business module

Gets all business modules

Gets all business modules

Gets DateTimeOffset.UtcNow converted to Unix time milliseconds

Gets DateTimeOffset.UtcNow converted to Unix time milliseconds

Moves an entity

Moves an entity

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

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

Undeclares a document as record

Undeclares a document as record.

Update business module entity in WorkPoint

Update business module entity in WorkPoint

Adds a document to a digital signature transaction

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 True string

The transaction id

Absolute document site url
DocumentSiteUrl True string

The absolute site url of where the document is saved

Absolute document url
DocumentUrl True string

The absolute document url

Signing properties behaviour
SigningSetPropertiesBehaviour True string

The signing properties behaviour

Record declaration setting
SigningDeclareAsRecordBehaviour True string

The record declaration setting

Signing type
SigningType True string

The signing type

PdfFormat
PdfFormat string

The PDF conversion format. If not specified the default PDF format will be used

Returns

Changes the stage for an entity

Changes the stage for an entity

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Entity list id
EntityListId True uuid

The id of the entity list

Entity item id
EntityItemId True integer

The id of the entity item

Stage id
StageId True string

The id for the content type (stage) to change to

Stage contraints behaviour
OverrideConstraints True string

Stage contraints behaviour

Override required fields
OverrideRequiredFields True boolean

If true, it is accepted that required fields does not have a value

Returns

Stage was changed

StageChanged
boolean

Changes the stage for an entity and set field values

Changes the stage for an entity and set field values

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Business module id
businessModuleId True uuid

The id of the business module

The id of the entity
entityId True integer

Entity Id

Stage id
stageId True string

The id for the content type (stage) to change to

Stage contraints behaviour
overrideConstraints True string

Stage contraints behaviour

Override required fields
overrideRequiredFields True boolean

If true, it is accepted that required fields does not have a value

data
data True dynamic

Dynamic Schema of items in selected list

Returns

Stage was changed

StageChanged
boolean

Completes a digital signature transaction (base64)

Completes a document in a digital signature transaction using a pdf file represented as a base64 string

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Transaction id
TransactionID True string

The transaction id

File name
FileName True string

The file name with extension to complete

Base64 PDF document
SignedPdfBase64String True string

The PDF document as a base64 string

Signing status
SigningStatus True string

The signing status

Message
Message string

An optional message

Document undeclaration behaviour
UndeclareOriginalDocumentOrAppendixFileAsRecord True boolean

The document undeclaration behaviour. If set to true, the original document is undeclared as record

Returns

Completes digital signature transaction (byte array)

Completes a document in a digital signature transaction using a pdf file represented as a byte array

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Transaction id
TransactionID True string

The transaction id

File name
FileName True string

The file name with extension to complete

Signed PDF bytes
SignedPdfBytes True binary

The PDF document bytes

Signing status
SigningStatus True string

The signing status

Message
Message string

An optional message

Document undeclaration behaviour
UndeclareOriginalDocumentOrAppendixFileAsRecord True boolean

The document undeclaration behaviour. If set to true, the original document is undeclared as record

Returns

Converts a document to pdf and saves it to a list

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

absolute document site URL
DocumentSiteUrl True string

The absolute url of the site where the document is saved

Absolute document URL
DocumentUrl True string

The absolute url of the document to be converted to pdf

Absolute output site URL
OutputSiteUrl True string

The absolute url of the site where the output document should be saved

Absolute output URL
OutputUrl True string

The url of the location where the converted pdf should be saved

Override behaviour
OutputExistsBehaviour True string

The override behaviour

PdfFormat
PdfFormat string

The PDF conversion format. If not specified the default PDF format will be used

Returns

response
object

Copies a business module entity in WorkPoint

Copies business module entity in WorkPoint

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Business module id
businessModuleId True uuid

The id of the business module

source entity id
sourceEntityId True integer

The of source entity id

data
data True dynamic

Dynamic Schema of items in selected list

Returns

response
integer

Create business module entity in WorkPoint

Create business module entity in WorkPoint

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Business module id
businessModuleId True uuid

The id of the business module

Create site
createSite True boolean

Create site

data
data True dynamic

Dynamic Schema of items in selected list

Returns

response
integer

Creates a log entry for a digital signature transaction

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 True string

The transaction id

Signing provider
SigningProvider True string

The signing provider

Log title
LogTitle string

The log title

Log description
LogDescription string

The log description.

Business module id
BusinessModuleID True string

The business module id

Entity id
EntityID True integer

The entity id

Total signing count
TotalSigningCount True integer

The total signing count

Total appendix count
TotalAppendixCount True integer

The total appendix count

Returns

response
object

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

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 id
businessModuleID True uuid

The business module id of the entity

Entity id
entityID True integer

The id the entity

Word template id
templateID True integer

The Word template id

Include the document as HTML in the result
includeHtml True boolean

Include the document as HTML in the result

Include the document bytes
includeBytes True boolean

Include the document bytes in the result

Business module id that the entity for common fields belongs to
commonFieldsBusinessModuleID uuid

The id of the business module that the entity for common fields is belongs to.

Entity id used for common fields
commonFieldsEntityID integer

The id the entity used for common fields.

Returns

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

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 id
businessModuleID True uuid

The id of the business module that the entity belongs to

Entity id
entityID True integer

The id the entity.

Word template id
templateID True integer

The id of the Word template

Returns

Declares a document as record

Declares a document as 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)

Returns

response
object

Executes an action on a business module entity

Executes an action on a business module entity

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Business module id
bmId True uuid

The id of the business module

Action id
actionId True uuid

The id of the action to run

Entity id
entityId True integer

The id of the entity in the business module

Returns

JobId

JobId
string

Generates a xwsse header to use for digital signature

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 True string

User name

Password
Password True string

Password

Returns

XwsseHeader

XwsseHeader
string

Gets a log entry from the digital signature log

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 True string

The id of the Digital Signature transaction

Returns

The log for a Digital Signature transaction

Gets a parameter for App or flow integration

Gets a parameter for app 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

Gets all active actions on a business module

Gets all active actions on a business module

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Business module id
id True uuid

The id of the business module

Returns

Gets all active triggers on a business module

Gets all active triggers on a business module

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Business module id
id True uuid

The id of the business module

Returns

Gets all business modules

Gets all business modules

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Returns

Gets DateTimeOffset.UtcNow converted to Unix time milliseconds

Gets DateTimeOffset.UtcNow converted to Unix time milliseconds

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Returns

Unix time milliseconds

Milliseconds
integer

Moves an entity

Moves an entity

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

The source entity list id
SourceEntityListID True uuid

The source entity list id

The source entity id
SourceEntityID True integer

The source entity id

Target entity list id
TargetEntityListID True uuid

Target entity list id

Target entity content type id
TargetEntityContentTypeID True string

Target entity content type id

Validate only
ValidateOnly True boolean

Value indicating whether validate only

Include progress log
IncludeProgressLogInResult True boolean

Value indicating whether to include progress log in result

Run as job
RunAsJob True boolean

Value indicating whether to run as job

Returns

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

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

Site Collection Server Relative Url
ServerRelativeUrl True string

Sets the server relative url of the site collection fx /sites/workpoint_0

Bussiness Module Id
AssignedToBusinessModuleId True uuid

Id of the business module

Site Collection Type
SiteCollectionType True string

Sets the use of the site collection. Can be Bucket or Entity (one-site collection per entity)

Returns

response
boolean

Undeclares a document as record

Undeclares a document as 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)

Returns

response
object

Update business module entity in WorkPoint

Update business module entity in WorkPoint

Parameters

Name Key Required Type Description
WorkPoint365 URL
WorkPoint365Url True string

SharePoint site with WorkPoint365 installed

Business module id
businessModuleId True uuid

The id of the business module

The id of the entity
entityId True integer

Entity Id

data
data True dynamic

Dynamic Schema of items in selected list

Returns

response
integer

Triggers

Triggers when a WorkPoint event occurs

Creates a WorkPoint webhook

Triggers when a WorkPoint event occurs

Creates a WorkPoint webhook

Parameters

Name Key Required Type Description
Description
Description string

Web hook description

WorkPoint365 URL
WorkPointUrl True string

SharePoint site with WorkPoint365 installed

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

Name Path Type Description
WorkPoint365 URL
Properties.WorkPointUrl string

SharePoint site with WorkPoint365 installed

Business Module Id
Properties.BusinessModuleId string

Business module id attached to web hook

Trigger Id
Properties.WorkPointTrigger string

Trigger id attached to web hook

Notifications
Notifications array of object

Notifications

EntityId
Notifications.EntityId integer

EntityId

Definitions

WorkPoint365.WebAPI.Model.Action

Name Path Type Description
Action title
Title string

The Title of the Action

Unique action id
Id uuid

The Id of the Action

WorkPoint365.WebAPI.Model.Trigger

Name Path Type Description
Trigger title
Title string

The Title of the Trigger

Unique trigger id
Id uuid

The Id of the Trigger

WorkPoint365.WebAPI.Model.BusinessModuleOnline

Name Path Type Description
Title
Title string

The title of the business module

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

WorkPoint365.WebAPI.Model.Document.DigitalSignatureAddDocumentToTransactionReturnValue

Name Path Type Description
Pdf url
PdfUrl string

Pdf url

Pdf server relative url
PdfServerRelativeUrl string

Pdf server relative url

A collection of errors
Errors array of WorkPoint365.WebAPI.Model.Document.DigitalSignatureError

A collection of errors

WorkPoint365.WebAPI.Model.Document.DigitalSignatureError

Name Path Type Description
Error type
ErrorType string

Error type

Text
Text string

Text

WorkPoint365.WebAPI.Model.Document.LogEntry

The log for a Digital Signature transaction

Name Path Type Description
TransactionID
TransactionID string

The transaction id for the entry

Title
Title string

The log title

Description
Description string

The log description

BusinessModuleID
BusinessModuleID string

The business module id

BusinessModuleTitle
BusinessModuleTitle string

The business module title

EntityID
EntityID integer

The entity id

EntityTitle
EntityTitle string

The entity tile

Links
Links string

Links to documents in the transaction

LogEntryDetails
LogEntryDetails WorkPoint365.WebAPI.Model.Document.LogEntry.Details

The log details for a Digital Signature transaction

SigningStatus
SigningStatus string

The signing status for the transaction

WorkPoint365.WebAPI.Model.Document.LogEntry.Details

The log details for a Digital Signature transaction

Name Path Type Description
TotalSigningCount
TotalSigningCount integer

The total signing count

TotalAppendixCount
TotalAppendixCount integer

The total appendix count

InProgressCount
InProgressCount integer

The In progress count

SignedCount
SignedCount integer

The Signed count

ApprovedCount
ApprovedCount integer

The Approved count

CancelledCount
CancelledCount integer

The Cancelled count

RejectedCount
RejectedCount integer

The Rejected count

FailedCount
FailedCount integer

The Failed count

SigningProvider
SigningProvider string

The signing provider

DocumentInfos
DocumentInfos array of WorkPoint365.WebAPI.Model.Document.LogEntry.Details.DocumentInfo

The list of documents in the transaction

WorkPoint365.WebAPI.Model.Document.LogEntry.Details.DocumentInfo

The document details for a document a Digital Signature transaction

Name Path Type Description
DocumentSiteUrl
DocumentSiteUrl string

The url of the site for the document

DocumentUrl
DocumentUrl string

The url for the document

DocumentLastModified
DocumentLastModified date-time

The time which the document was last modified

DocumentVersion
DocumentVersion string

The document version

PdfUrl
PdfUrl string

The url of the pdf version of the document

PdfServerRelativeUrl
PdfServerRelativeUrl string

The server relative url of the pdf version of the document

SigningStatus
SigningStatus string

The Signing status for the document

SigningType
SigningType string

The Signing type for the document

SetPropertiesInfo
SetPropertiesInfo string

The info for when each properties is set

DeclarePdfFileAsRecordRequired
DeclarePdfFileAsRecordRequired boolean

Is declare pdf file as record required

DeclareOriginalDocumentAsRecordRequired
DeclareOriginalDocumentAsRecordRequired boolean

Is declare original document as record required

DeclareAppendixFileAsRecordRequired
DeclareAppendixFileAsRecordRequired boolean

Is declare appendix file as record required

DeclareAsRecordInfo
DeclareAsRecordInfo string

The info for the declare as record status

LogCreated
LogCreated date-time

The time which the document log was created

LogLastModified
LogLastModified date-time

The time which the document log was last modified

Message
Message string

An optional message

WorkPoint365.WebAPI.Model.MoveEntityResult

Name Path Type Description
MoveEntityResult ok
Ok boolean

Value indicating whether MoveEntityResult is ok

Errors
Errors array of string

Errors.

Warnings
Warnings array of string

Warnings

Progress Log
ProgressLog string

Progress Log

WorkPoint365.WebAPI.Model.MailMergeHtmlResult

Name Path Type Description
HTML
Html string

The HTML.

Subject
Subject string

The Subject.

Error messages
ErrorMessages array of string

The error messages.

MailMergeHtmlResult ok
Ok boolean

Gets a value indicating whether MailMergeHtmlResult is ok.

WorkPoint365.WebAPI.Model.MailMergeDocumentResult

Name Path Type Description
HTML
Html string

The HTML

Bytes
Bytes byte

The document bytes

Filename
FileName string

The Filename

Subject
Subject string

The Subject

Error messages
ErrorMessages array of string

The error messages

MailMergeDocumentResult ok
Ok boolean

Gets a value indicating whether MailMergeDocumentResult is ok.

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter

Name Path Type Description
Entity
Entity WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.EntityInfo
Library
Library WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.LibraryInfo
Documents
Documents array of WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.DocumentInfo

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.DocumentInfo

Name Path Type Description
Document id
Id integer

Document id

Document name
Name string

Document name

Document server relative url
ServerRelativeUrl string

Document server relative url.

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.EntityInfo

Name Path Type Description
Entity list id
ListId uuid

Entity list id

Entity list item id
ListItemId integer

Entity list item id

Entity title
Title string

Entity title

Entity server relative url
ServerRelativeUrl string

Entity server relative url

WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.LibraryInfo

Name Path Type Description
Library id
Id uuid

The id of the library

Library server relative url
ServerRelativeUrl string

Library server relative url

Library name
Name string

Library name

boolean

This is the basic data type 'boolean'.

object

This is the type 'object'.

string

This is the basic data type 'string'.

integer

This is the basic data type 'integer'.