Connectors Reference
WorkPoint 365 business-solution makes it easy to manage critical processes.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
ActionManagement_Actions (string WorkPoint365Url, string id) |
Gets all active actions on a business module |
|
ActionManagement_Triggers (string WorkPoint365Url, string id) |
Gets all active triggers on a business module |
|
ActionManagement_RunAction (string WorkPoint365Url, string bmId, string actionId, integer entityId) |
Executes an action on a business module entity |
|
Gets all business modules |
|
|
Gets a business module |
|
|
Converts a document to pdf and saves it to a list |
|
|
Creates a log entry for a digital signature transaction |
|
|
Adds a document to a digital signature transaction |
|
|
Completes digital signature transaction (byte array) |
|
|
Completes a digital signature transaction (base64) |
|
|
Generates a xwsse header to use for digital signature |
|
|
Document_DigitalSignatureUnixTimeMilliseconds (string WorkPoint365Url) |
Gets DateTimeOffset.UtcNow converted to Unix time milliseconds |
|
Entity_Move (string WorkPoint365Url, WorkPoint365.WebAPI.Model.MoveEntityParameter parameter) |
Moves an entity |
|
Changes the stage for an entity |
|
|
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 |
|
|
Parameter_GetPowerAppAndFlowParameter (string WorkPoint365Url, string identifier) |
Gets a parameter for App or flow integration |
|
RecordManagement_Declare (string WorkPoint365Url, string siteUrl, string documentUrl) |
Declares a document as record |
|
RecordManagement_Undeclare (string WorkPoint365Url, string siteUrl, string documentUrl) |
Undeclares a document as record |
|
Get all WorkPoint webhooks |
|
|
Delete all WorkPoint webhooks |
|
|
Get a WorkPoint webhook based on id |
|
|
Delete a WorkPoint webhook based on id |
|
|
WebHookRegistrations_Put (string id, Microsoft.AspNet.WebHooks.WebHook webHook) |
Update a WorkPoint webhook based on id |
|
Entity_GetEntityFieldSchema (string WorkPoint365Url, string businessModuleId) |
Get field schema used for other entity actions in the WorkPoint Connector |
|
Changes the stage for an entity and set field values |
|
|
Create business module entity in WorkPoint |
|
|
Update business module entity in WorkPoint |
|
Name |
Summary |
|
WebHookRegistrations_Post (WebHookRegistrations_PostParameterWebHook webHook) |
Triggers when a WorkPoint event occurs |
Summary: Gets all active actions on a business module
Description: Gets all active actions on a business module
Syntax:
WorkPoint.ActionManagement_Actions (string WorkPoint365Url, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
id |
string(uuid) (Business module id) |
The id of the business module |
True |
Returns:
Type:array of (WorkPoint365.WebAPI.Model.Action)
Summary: Gets all active triggers on a business module
Description: Gets all active triggers on a business module
Syntax:
WorkPoint.ActionManagement_Triggers (string WorkPoint365Url, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
id |
string(uuid) (Business module id) |
The id of the business module |
True |
Returns:
Type:array of (WorkPoint365.WebAPI.Model.Trigger)
Summary: Executes an action on a business module entity
Description: Executes an action on a business module entity
Syntax:
WorkPoint.ActionManagement_RunAction (string WorkPoint365Url, string bmId, string actionId, integer entityId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
bmId |
string(uuid) (Business module id) |
The id of the business module |
True |
|
|
actionId |
string(uuid) (Action id) |
The id of the action to run |
True |
|
|
entityId |
integer(int32) (Entity id) |
The id of the entity in the business module |
True |
Returns:
Type:stringJobId
Title: JobId
Description: JobId
Summary: Gets all business modules
Description: Gets all business modules
Syntax:
WorkPoint.BusinessModules_Get (string WorkPoint365Url)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
Returns:
Type:array of (WorkPoint365.WebAPI.Model.BusinessModuleOnline)
Summary: Gets a business module
Description: Gets a business module
Syntax:
WorkPoint.BusinessModules_Lookup (string WorkPoint365Url, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
id |
string (Business module id) |
The id of the Business Module |
True |
Returns:
Type:WorkPoint365.WebAPI.Model.BusinessModuleOnline
Summary: Converts a document to pdf and saves it to a list
Description: Converts a document to pdf and saves it to a list
Syntax:
WorkPoint.Document_ConvertToPdfAndSaveOutput (string WorkPoint365Url, WorkPoint365.WebAPI.Model.Document.ConvertToPdfAndSaveOutputParameter parameter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
parameter |
WorkPoint365.WebAPI.Model.Document.ConvertToPdfAndSaveOutputParameter
|
|
True |
Returns:
Type:Document_ConvertToPdfAndSaveOutputResponse
Summary: Creates a log entry for a digital signature transaction
Description: Creates a log entry for a digital signature transaction
Syntax:
WorkPoint.Document_DigitalSignatureCreateLogEntryForTransaction (string WorkPoint365Url, WorkPoint365.WebAPI.Model.Document.DigitalSignatureCreateLogEntryForTransactionParameter parameter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
parameter |
WorkPoint365.WebAPI.Model.Document.DigitalSignatureCreateLogEntryForTransactionParameter
|
|
True |
Returns:
Type:Document_DigitalSignatureCreateLogEntryForTransactionResponse
Summary: Adds a document to a digital signature transaction
Description: Adds a document to a digital signature transaction
Syntax:
WorkPoint.Document_DigitalSignatureAddDocumentToTransaction (string WorkPoint365Url, WorkPoint365.WebAPI.Model.Document.DigitalSignatureAddDocumentToTransactionParameter parameter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
parameter |
WorkPoint365.WebAPI.Model.Document.DigitalSignatureAddDocumentToTransactionParameter
|
|
True |
Returns:
Type:WorkPoint365.WebAPI.Model.Document.DigitalSignatureAddDocumentToTransactionReturnValue
Summary: Completes digital signature transaction (byte array)
Description: Completes a document in a digital signature transaction using a pdf file represented as a byte array
Syntax:
WorkPoint.Document_DigitalSignatureCompleteDocumentInTransaction (string WorkPoint365Url, WorkPoint365.WebAPI.Model.Document.DigitalSignatureCompleteDocumentInTransactionParameter parameter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
parameter |
WorkPoint365.WebAPI.Model.Document.DigitalSignatureCompleteDocumentInTransactionParameter
|
|
True |
Returns:
Type:array of (WorkPoint365.WebAPI.Model.Document.DigitalSignatureError)
Summary: Completes a digital signature transaction (base64)
Description: Completes a document in a digital signature transaction using a pdf file represented as a base64 string
Syntax:
WorkPoint.Document_DigitalSignatureBase64CompleteDocumentInTransaction (string WorkPoint365Url, WorkPoint365.WebAPI.Model.Document.DigitalSignatureBase64CompleteDocumentInTransactionParameter parameter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
parameter |
WorkPoint365.WebAPI.Model.Document.DigitalSignatureBase64CompleteDocumentInTransactionParameter
|
|
True |
Returns:
Type:array of (WorkPoint365.WebAPI.Model.Document.DigitalSignatureError)
Summary: Generates a xwsse header to use for digital signature
Description: Generates a xwsse header to use for digital signature
Syntax:
WorkPoint.Document_DigitalSignatureGenerateXwsseHeader (string WorkPoint365Url, WorkPoint365.WebAPI.Model.Document.DigitalSignatureGenerateXwsseHeaderParameter parameter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
parameter |
WorkPoint365.WebAPI.Model.Document.DigitalSignatureGenerateXwsseHeaderParameter
|
|
True |
Returns:
Type:stringXwsseHeader
Title: XwsseHeader
Description: XwsseHeader
Summary: Gets DateTimeOffset.UtcNow converted to Unix time milliseconds
Description: Gets DateTimeOffset.UtcNow converted to Unix time milliseconds
Syntax:
WorkPoint.Document_DigitalSignatureUnixTimeMilliseconds (string WorkPoint365Url)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
Returns:
Type:integer(int64)Milliseconds
Title: Milliseconds
Description: Unix time milliseconds
Summary: Moves an entity
Description: Moves an entity
Syntax:
WorkPoint.Entity_Move (string WorkPoint365Url, WorkPoint365.WebAPI.Model.MoveEntityParameter parameter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
parameter |
WorkPoint365.WebAPI.Model.MoveEntityParameter
|
|
True |
Returns:
Type:WorkPoint365.WebAPI.Model.MoveEntityResult
Summary: Changes the stage for an entity
Description: Changes the stage for an entity
Syntax:
WorkPoint.ListItem_ChangeStage (string WorkPoint365Url, WorkPoint365.WebAPI.Model.ChangeStageParameter parameter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
parameter |
WorkPoint365.WebAPI.Model.ChangeStageParameter
|
|
True |
Returns:
Type:booleanStageChanged
Title: StageChanged
Description: Stage was changed
Summary: Creates a Word document based on a template and returns the document as html
Description: Creates a Word document based on a template and returns the document as html
Syntax:
WorkPoint.MailMerge_GetMailMergedWordDocumentAsHtml (string WorkPoint365Url, string businessModuleID, integer entityID, integer templateID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
businessModuleID |
string(uuid) (Business module id) |
The id of the business module that the entity belongs to |
True |
|
|
entityID |
integer(int32) (Entity id) |
The id the entity. |
True |
|
|
templateID |
integer(int32) (Word template id) |
The id of the Word template |
True |
Returns:
Type:WorkPoint365.WebAPI.Model.MailMergeHtmlResult
Summary: Creates a Word document based on a template and returns the document
Description: Creates a Word document based on a template and returns the document
Syntax:
WorkPoint.MailMerge_GetMailMergedWordDocument (string WorkPoint365Url, string businessModuleID, integer entityID, integer templateID, boolean includeHtml, boolean includeBytes, [Optional]string commonFieldsBusinessModuleID, [Optional]integer commonFieldsEntityID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
businessModuleID |
string(uuid) (Business module id) |
The business module id of the entity |
True |
|
|
entityID |
integer(int32) (Entity id) |
The id the entity |
True |
|
|
templateID |
integer(int32) (Word template id) |
The Word template id |
True |
|
|
includeHtml |
boolean (Include the document as HTML in the result) |
Include the document as HTML in the result |
True |
|
|
includeBytes |
boolean (Include the document bytes) |
Include the document bytes in the result |
True |
|
|
commonFieldsBusinessModuleID |
string(uuid) (Business module id that the entity for common fields belongs to) |
The id of the business module that the entity for common fields is belongs to. |
False |
|
|
commonFieldsEntityID |
integer(int32) (Entity id used for common fields) |
The id the entity used for common fields. |
False |
Returns:
Type:WorkPoint365.WebAPI.Model.MailMergeDocumentResult
Summary: Gets a parameter for App or flow integration
Description: Gets a parameter for app or flow integration.
Syntax:
WorkPoint.Parameter_GetPowerAppAndFlowParameter (string WorkPoint365Url, string identifier)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
identifier |
string (Parameter object identifier) |
The identifier of the parameter |
True |
Returns:
Type:WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter
Summary: Declares a document as record
Description: Declares a document as record
Syntax:
WorkPoint.RecordManagement_Declare (string WorkPoint365Url, string siteUrl, string documentUrl)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
siteUrl |
string (Absolute site Url) |
The absolute url of the site where the document belongs to (the value must be UrlEncoded) |
True |
|
|
documentUrl |
string (Absolute document Url) |
The absolute url of the document to declare (the value must be UrlEncoded) |
True |
Returns:
Type:RecordManagement_DeclareResponse
Summary: Undeclares a document as record
Description: Undeclares a document as record.
Syntax:
WorkPoint.RecordManagement_Undeclare (string WorkPoint365Url, string siteUrl, string documentUrl)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
siteUrl |
string (Absolute site Url) |
The absolute url of the site where the document belongs to (the value must be UrlEncoded) |
True |
|
|
documentUrl |
string (Absolute document Url) |
The absolute url of the document to declare (the value must be UrlEncoded) |
True |
Returns:
Type:RecordManagement_UndeclareResponse
Summary: Get all WorkPoint webhooks
Description: Get all WorkPoint webhooks
Syntax:
WorkPoint.WebHookRegistrations_Get ()
Returns:
Type:array of (Microsoft.AspNet.WebHooks.WebHook)
Summary: Delete all WorkPoint webhooks
Description: Delete all WorkPoint webhooks
Syntax:
WorkPoint.WebHookRegistrations_DeleteAll ()
Returns:
Type:WebHookRegistrations_DeleteAllResponse
Summary: Get a WorkPoint webhook based on id
Description: Get a WorkPoint webhook
Syntax:
WorkPoint.WebHookRegistrations_Lookup (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
Returns:
Type:Microsoft.AspNet.WebHooks.WebHook
Summary: Delete a WorkPoint webhook based on id
Description: Delete a WorkPoint webhook
Syntax:
WorkPoint.WebHookRegistrations_Delete (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
Returns:
Type:WebHookRegistrations_DeleteResponse
Summary: Update a WorkPoint webhook based on id
Description: Update a WorkPoint webhook
Syntax:
WorkPoint.WebHookRegistrations_Put (string id, Microsoft.AspNet.WebHooks.WebHook webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
|
|
webHook |
Microsoft.AspNet.WebHooks.WebHook
|
|
True |
Returns:
Type:WebHookRegistrations_PutResponse
Summary: Get field schema used for other entity actions in the WorkPoint Connector
Description: Get field schema used for other entity actions in the WorkPoint Connector
Syntax:
WorkPoint.Entity_GetEntityFieldSchema (string WorkPoint365Url, string businessModuleId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
businessModuleId |
string(uuid)
|
Business Module Id |
True |
Returns:
Type:Entity_GetEntityFieldSchemaResponse
Summary: Changes the stage for an entity and set field values
Description: Changes the stage for an entity and set field values
Syntax:
WorkPoint.Entity_ChangeStage (string WorkPoint365Url, string businessModuleId, integer entityId, string stageId, string overrideConstraints, boolean overrideRequiredFields, Entity_ChangeStageParameterData data)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
businessModuleId |
string(uuid) (Business module id) |
The id of the business module |
True |
|
|
entityId |
integer (The id of the entity) |
Entity Id |
True |
|
|
stageId |
string (Stage id) |
The id for the content type (stage) to change to |
True |
|
|
overrideConstraints |
string (Stage contraints behaviour)Values: [NoOverride, OverrideWarnings, OverrideErrors, OverrideWarningsAndErrors] |
Stage contraints behaviour |
True |
|
|
overrideRequiredFields |
boolean (Override required fields) |
If true, it is accepted that required fields does not have a value |
True |
|
|
data |
Entity_ChangeStageParameterData
|
|
True |
Returns:
Type:booleanStageChanged
Title: StageChanged
Description: Stage was changed
Summary: Create business module entity in WorkPoint
Description: Create business module entity in WorkPoint
Syntax:
WorkPoint.Entity_Create (string WorkPoint365Url, string businessModuleId, boolean createSite, Entity_CreateParameterData data)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
businessModuleId |
string(uuid) (Business module id) |
The id of the business module |
True |
|
|
createSite |
boolean (Create site) |
Create site |
True |
|
|
data |
|
|
True |
Returns:
Type:integer(int32)
Summary: Update business module entity in WorkPoint
Description: Update business module entity in WorkPoint
Syntax:
WorkPoint.Entity_Update (string WorkPoint365Url, string businessModuleId, integer entityId, Entity_UpdateParameterData data)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WorkPoint365Url |
string (WorkPoint365 URL) |
SharePoint site with WorkPoint365 installed |
True |
|
|
businessModuleId |
string(uuid) (Business module id) |
The id of the business module |
True |
|
|
entityId |
integer (The id of the entity) |
Entity Id |
True |
|
|
data |
|
|
True |
Returns:
Type:integer(int32)
Summary: Triggers when a WorkPoint event occurs
Description: Creates a WorkPoint webhook
Syntax:
WorkPoint.WebHookRegistrations_Post (WebHookRegistrations_PostParameterWebHook webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
WebHookRegistrations_PostParameterWebHook
|
|
True |
Returns:
Type:Microsoft.AspNet.WebHooks.WebHook
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string Id |
Unique web hook id |
|
Description |
string Description |
Web hook description |
|
IsPaused |
boolean Active state |
Web hook active state |
|
Properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WorkPointUrl |
string WorkPoint365 URL |
SharePoint site with WorkPoint365 installed |
|
BusinessModuleId |
string(uuid) Business Module Id |
Business module id attached to web hook |
|
WorkPointTrigger |
string(uuid) Trigger Id |
Trigger id attached to web hook |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string Id |
Unique web hook id |
|
WebHookUri |
string Callback URI |
Web hook callback property |
|
Description |
string Description |
Web hook description |
|
IsPaused |
boolean Active state |
Web hook active state |
|
Properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WorkPointUrl |
string WorkPoint365 URL |
SharePoint site with WorkPoint365 installed |
|
BusinessModuleId |
string(uuid) Business Module Id |
Business module id attached to web hook |
|
WorkPointTrigger |
string(uuid) Trigger Id |
Trigger id attached to web hook |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Title |
string Action title |
The Title of the Action |
|
Id |
string(uuid) Unique action id |
The Id of the Action |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Title |
string
|
The title of the business module |
|
EntityName |
string
|
The name of a single entity (typical a singular expression) |
|
Template |
integer(int32)
|
The business module template |
|
Category |
integer(int32)
|
The category used to set entity move behaviour. It is only possible to move entities of same category across business modules |
|
Parent |
string(uuid)
|
The parent business module |
|
ParentRelationName |
string
|
The parent field name |
|
SitesEnabled |
boolean
|
The value indicating whether sites are enabled |
|
IconUrl |
string
|
The business module icon url |
|
EnableEMMIntegration |
boolean
|
The value indicating if EMM is enabled |
|
Id |
string(uuid)
|
The business module identifier |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
EntityListId |
string(uuid) Entity list id |
The id of the entity list |
|
EntityItemId |
integer(int32) Entity item id |
The id of the entity item |
|
StageId |
string Stage id |
The id for the content type (stage) to change to |
|
OverrideConstraints |
string Stage contraints behaviour |
Stage contraints behaviour Values: [NoOverride, OverrideWarnings, OverrideErrors, OverrideWarningsAndErrors] |
|
OverrideRequiredFields |
boolean Override required fields |
If true, it is accepted that required fields does not have a value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
DocumentSiteUrl |
string absolute document site URL |
The absolute url of the site where the document is saved |
|
DocumentUrl |
string Absolute document URL |
The absolute url of the document to be converted to pdf |
|
OutputSiteUrl |
string Absolute output site URL |
The absolute url of the site where the output document should be saved |
|
OutputUrl |
string Absolute output URL |
The url of the location where the converted pdf should be saved |
|
OutputExistsBehaviour |
string Override behaviour |
The override behaviour Values: [Cancel, Overwrite, Rename] |
|
PdfFormat |
string PdfFormat |
The PDF conversion format. If not specified the default PDF format will be used Values: [PDF_A_1A, PDF_A_1B, PDF_A_2A, PDF_A_3A, PDF_A_2B, PDF_A_2U, PDF_A_3B, PDF_A_3U, PDF_v_1_3, PDF_v_1_4, PDF_v_1_5, PDF_v_1_6, PDF_v_1_7, PDF_UA_1, PDF_X_1A, PDF_X_3] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
TransactionID |
string Transaction id |
The transaction id |
|
DocumentSiteUrl |
string Absolute document site url |
The absolute site url of where the document is saved |
|
DocumentUrl |
string Absolute document url |
The absolute document url |
|
SigningSetPropertiesBehaviour |
string Signing properties behaviour |
The signing properties behaviour Values: [IgnoreErrors, ReturnOnErrors] |
|
SigningDeclareAsRecordBehaviour |
string Record declaration setting |
The record declaration setting Values: [DoNotDeclare, DeclareOriginalDocument, DeclarePdf, DeclareOriginalDocumentAndPdf] |
|
SigningType |
string Signing type |
The signing type Values: [StandardSigning, Appendix] |
|
PdfFormat |
string PdfFormat |
The PDF conversion format. If not specified the default PDF format will be used Values: [PDF_A_1A, PDF_A_1B, PDF_A_2A, PDF_A_3A, PDF_A_2B, PDF_A_2U, PDF_A_3B, PDF_A_3U, PDF_v_1_3, PDF_v_1_4, PDF_v_1_5, PDF_v_1_6, PDF_v_1_7, PDF_UA_1, PDF_X_1A, PDF_X_3] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
PdfUrl |
string Pdf url |
Pdf url |
|
PdfServerRelativeUrl |
string Pdf server relative url |
Pdf server relative url |
|
Errors |
array of (WorkPoint365.WebAPI.Model.Document.DigitalSignatureError) A collection of errors |
A collection of errors |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
TransactionID |
string Transaction id |
The transaction id |
|
FileName |
string File name |
The file name with extension to complete |
|
SignedPdfBase64String |
string Base64 PDF document |
The PDF document as a base64 string |
|
SigningStatus |
string Signing status |
The signing status Values: [InProgress, Signed, Approved, Cancelled, Rejected, Failed] |
|
Message |
string Message |
An optional message |
|
UndeclareOriginalDocumentOrAppendixFileAsRecord |
boolean Document undeclaration behaviour |
The document undeclaration behaviour. If set to true, the original document is undeclared as record |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
TransactionID |
string Transaction id |
The transaction id |
|
FileName |
string File name |
The file name with extension to complete |
|
SignedPdfBytes |
string(binary) Signed PDF bytes |
The PDF document bytes |
|
SigningStatus |
string Signing status |
The signing status Values: [InProgress, Signed, Approved, Cancelled, Rejected, Failed] |
|
Message |
string Message |
An optional message |
|
UndeclareOriginalDocumentOrAppendixFileAsRecord |
boolean Document undeclaration behaviour |
The document undeclaration behaviour. If set to true, the original document is undeclared as record |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
TransactionID |
string Transaction id |
The transaction id |
|
SigningProvider |
string Signing provider |
The signing provider Values: [Penneo, Visma, DocuSign, AdobeSign, Other] |
|
LogTitle |
string Log title |
The log title |
|
LogDescription |
string Log description |
The log description. |
|
BusinessModuleID |
string Business module id |
The business module id |
|
EntityID |
integer(int32) Entity id |
The entity id |
|
TotalSigningCount |
integer(int32) Total signing count |
The total signing count |
|
TotalAppendixCount |
integer(int32) Total appendix count |
The total appendix count |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ErrorType |
string Error type |
Error type Values: [LogEntryNotFound, SetPropertyError, DeclareOriginalDocumentAsRecordError, DeclarePdfFileAsRecordError, DeclareAppendixFileAsRecordError, UndeclareOriginalDocumentAsRecordError, UndeclarePdfFileAsRecordError, UndeclareAppendixFileAsRecordError, IllegalSigningStatus, FileNotFoundInLog, MultipleFilesFoundInLog, DocumentHasAlreadyBeenAdded, DocumentAlreadySigned, DocumentAlreadyApproved, PdfFileIsCheckedOut, FileDoesNotExistsInSharePoint] |
|
Text |
string Text |
Text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
UserName |
string User name |
User name |
|
Password |
string Password |
Password |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Html |
string HTML |
The HTML |
|
Bytes |
string(byte) Bytes |
The document bytes |
|
FileName |
string Filename |
The Filename |
|
Subject |
string Subject |
The Subject |
|
ErrorMessages |
array of (string) Error messages |
The error messages |
|
Ok |
boolean MailMergeDocumentResult ok |
Gets a value indicating whether MailMergeDocumentResult is ok. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Html |
string HTML |
The HTML. |
|
Subject |
string Subject |
The Subject. |
|
ErrorMessages |
array of (string) Error messages |
The error messages. |
|
Ok |
boolean MailMergeHtmlResult ok |
Gets a value indicating whether MailMergeHtmlResult is ok. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SourceEntityListID |
string(uuid) The source entity list id |
The source entity list id |
|
SourceEntityID |
integer(int32) The source entity id |
The source entity id |
|
TargetEntityListID |
string(uuid) Target entity list id |
Target entity list id |
|
TargetEntityContentTypeID |
string Target entity content type id |
Target entity content type id |
|
ValidateOnly |
boolean Validate only |
Value indicating whether validate only |
|
IncludeProgressLogInResult |
boolean Include progress log |
Value indicating whether to include progress log in result |
|
RunAsJob |
boolean Run as job |
Value indicating whether to run as job |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Ok |
boolean MoveEntityResult ok |
Value indicating whether MoveEntityResult is ok |
|
Errors |
array of (string) Errors |
Errors. |
|
Warnings |
array of (string) Warnings |
Warnings |
|
ProgressLog |
string Progress Log |
Progress Log |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Entity |
WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.EntityInfo
|
|
|
Library |
WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.LibraryInfo
|
|
|
Documents |
array of (WorkPoint365.WebAPI.Model.PowerAppAndFlowParameter.DocumentInfo)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int32) Document id |
Document id |
|
Name |
string Document name |
Document name |
|
ServerRelativeUrl |
string Document server relative url |
Document server relative url. |
|
Properties |
Dictionary containing property names with corresponding values |
Dictionary containing property names with corresponding values. |
Summary: Dictionary containing property names with corresponding values
Description: Dictionary containing property names with corresponding values.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ListId |
string(uuid) Entity list id |
Entity list id |
|
ListItemId |
integer(int32) Entity list item id |
Entity list item id |
|
Title |
string Entity title |
Entity title |
|
ServerRelativeUrl |
string Entity server relative url |
Entity server relative url |
|
Properties |
Dictionary containing property names with corresponding values |
Dictionary containing property names with corresponding values. |
Summary: Dictionary containing property names with corresponding values
Description: Dictionary containing property names with corresponding values.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string(uuid) Library id |
The id of the library |
|
ServerRelativeUrl |
string Library server relative url |
Library server relative url |
|
Name |
string Library name |
Library name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Title |
string Trigger title |
The Title of the Trigger |
|
Id |
string(uuid) Unique trigger id |
The Id of the Trigger |