Connectors Reference

Projectwise Share

ProjectWise Share is an instantly available, easy to configure File Sharing Service thatís associated with a CONNECT Project. It provides CONNECT Edition applications, Cloud Services and Mobile applications the ability to save and / or consume files from a common cloud repository and CONNECTED Users an easy, secure way to share files with Team Members.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

ActionCreateFile (string connectedProjectid, string folderId, PSConnector.CoreApi.Models.FileModel documentModel)

Create a file in ProjectWise Share

ActionDeleteFile (string connectedProjectid, string fileId)

Delete a file in ProjectWise Share

ActionCreateFolder (string connectedProjectid, string folderId, PSConnector.CoreApi.Models.FolderModel folder)

Create a folder in ProjectWise Share

DeleteFlowEntity ([Optional]string project, [Optional]string flowId)

Delete FlowEntity

GetProjectList ()

Get CONNECT project list

GetRootFolder (string Project, string types, [Optional]string parentType, [Optional]string parentId, [Optional]string parentPath)

This action is used for file-picker

GetSelections (string Project, string types, [Optional]integer parentType, [Optional]string parentId, [Optional]string parentPath)

This action is used for file-picker

GetDropdownlistOptions ()

Get DropDownListOptions

GetFileContentSchema (string selectedDropdownValue)

Get FileContent schema dynamically

 

Triggers:

Name

Summary

TriggerWhenFileIsMoved (string Project, string File, string FileContent, [internal]string Operation, TriggerWhenFileIsMovedParameterHook hook)

When a file is moved

TriggerWhenFileIsHardDeleted (string Project, string File, [internal]string Operation, TriggerWhenFileIsHardDeletedParameterHook hook)

When a file is deleted from Recycle Bin

TriggerWhenFileMovedToRecycleBin (string Project, string File, [internal]string Operation, TriggerWhenFileMovedToRecycleBinParameterHook hook)

When a file is moved to Recycle Bin

TriggerWhenFileRestored (string Project, string File, string FileContent, [internal]string Operation, TriggerWhenFileRestoredParameterHook hook)

When a file is restored from Recycle Bin

TriggerWhenFileIsCreated (string Project, string Folder, string FileContent, [internal]string Operation, TriggerWhenFileIsCreatedParameterHook hook)

When a file is created

TriggerWhenFileIsModified (string Project, string Folder, string FileContent, [internal]string Operation, TriggerWhenFileIsModifiedParameterHook hook)

When a file is modified

TriggerWhenFolderCreated (string Project, string Folder, [internal]string Operation, TriggerWhenFolderCreatedParameterHook hook)

When a folder is created

TriggerWhenFolderMovedToRecycleBin (string Project, string Folder, [internal]string Operation, TriggerWhenFolderMovedToRecycleBinParameterHook hook)

When a folder is moved to Recycle Bin

TriggerWhenFolderHardDeleted (string Project, string Folder, [internal]string Operation, TriggerWhenFolderHardDeletedParameterHook hook)

When a folder is deleted from Recycle Bin

 

Objects:

Name

Summary

Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter

 

PSConnector.CoreApi.Models.FileModel

 

PSConnector.CoreApi.Models.FolderModel

 

PSConnector.CoreApi.Models.Item

 

PSConnector.CoreApi.Models.JsonSchema

 

PSConnector.CoreApi.Models.ObjectResultResponse

 

PSConnector.CoreApi.Models.PickerSelectionResponseModel

 

TriggerWhenFileIsCreatedParameterHook

 

TriggerWhenFileIsHardDeletedParameterHook

 

TriggerWhenFileIsModifiedParameterHook

 

TriggerWhenFileIsMovedParameterHook

 

TriggerWhenFileMovedToRecycleBinParameterHook

 

TriggerWhenFileRestoredParameterHook

 

TriggerWhenFolderCreatedParameterHook

 

TriggerWhenFolderHardDeletedParameterHook

 

TriggerWhenFolderMovedToRecycleBinParameterHook

 

 

Actions:

ActionCreateFile

Summary: Create a file in ProjectWise Share

Description: Create a File in ProjectWise Share Service under selected project and folder

 

Syntax:

ProjectwiseShare.ActionCreateFile (string connectedProjectid, string folderId, PSConnector.CoreApi.Models.FileModel documentModel)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectid

string

(Project)

Bentley CONNECT project

True

GetProjectList

folderId

string

(Folder)

Project Share Folder

True

documentModel

PSConnector.CoreApi.Models.FileModel

 

 

True

 

Returns:

††††††††† Type:PSConnector.CoreApi.Models.ObjectResultResponse

 

ActionDeleteFile

Summary: Delete a file in ProjectWise Share

Description: Delete a File in ProjectWise Share Service under selected project and folder

 

Syntax:

ProjectwiseShare.ActionDeleteFile (string connectedProjectid, string fileId)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectid

string

(Project)

Bentley CONNECT project

True

GetProjectList

fileId

string

(File)

Project Share File

True

 

Returns:

††††††††† Type:PSConnector.CoreApi.Models.ObjectResultResponse

 

ActionCreateFolder

Summary: Create a folder in ProjectWise Share

Description: Create a folder in ProjectWise Share Service under selected project and folder

 

Syntax:

ProjectwiseShare.ActionCreateFolder (string connectedProjectid, string folderId, PSConnector.CoreApi.Models.FolderModel folder)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectid

string

(Project)

Bentley CONNECT project

True

GetProjectList

folderId

string

(Folder)

Project Share Folder

True

folder

PSConnector.CoreApi.Models.FolderModel

 

 

True

 

Returns:

††††††††† Type:PSConnector.CoreApi.Models.ObjectResultResponse

 

DeleteFlowEntity

Summary: Delete FlowEntity

Description: Delete FlowEntity(filter on FlowId)

 

Syntax:

ProjectwiseShare.DeleteFlowEntity ([Optional]string project, [Optional]string flowId)

 

Parameters:

Name

Type

Summary

Required

Related Action

project

string

 

 

False

flowId

string

 

 

False

 

Returns:

††††††††† Type:boolean

 

GetProjectList

Summary: Get CONNECT project list

Description: Get CONNECT project list

 

Syntax:

ProjectwiseShare.GetProjectList ()

 

Returns:

††††††††† Type:array of (PSConnector.CoreApi.Models.Item)

 

GetRootFolder

Summary: This action is used for file-picker

Description: This action is used for file-picker

 

Syntax:

ProjectwiseShare.GetRootFolder (string Project, string types, [Optional]string parentType, [Optional]string parentId, [Optional]string parentPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

 

 

True

types

string

Values: [folder, document, all]

 

True

parentType

string

Values: [folder, document, all]

 

False

parentId

string

 

 

False

parentPath

string

 

 

False

 

Returns:

††††††††† Type:array of (PSConnector.CoreApi.Models.PickerSelectionResponseModel)

 

GetSelections

Summary: This action is used for file-picker

Description: This action is used for file-picker

 

Syntax:

ProjectwiseShare.GetSelections (string Project, string types, [Optional]integer parentType, [Optional]string parentId, [Optional]string parentPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

 

 

True

types

string

Values: [folder, document, all]

 

True

parentType

integer(int32)

 

 

False

parentId

string

 

 

False

parentPath

string

 

 

False

 

Returns:

††††††††† Type:array of (PSConnector.CoreApi.Models.PickerSelectionResponseModel)

 

GetDropdownlistOptions

Summary: Get DropDownListOptions

Description: Get DropDownListOptions

 

Syntax:

ProjectwiseShare.GetDropdownlistOptions ()

 

Returns:

 

GetFileContentSchema

Summary: Get FileContent schema dynamically

Description: Get FileContent schema dynamically

 

Syntax:

ProjectwiseShare.GetFileContentSchema (string selectedDropdownValue)

 

Parameters:

Name

Type

Summary

Required

Related Action

selectedDropdownValue

string

 

 

True

 

Returns:

††††††††† Type:PSConnector.CoreApi.Models.JsonSchema

 

Triggers:

Trigger TriggerWhenFileIsMoved

Summary: When a file is moved

Description: When a file is moved

 

Syntax:

ProjectwiseShare.TriggerWhenFileIsMoved (string Project, string File, string FileContent, [internal]string Operation, TriggerWhenFileIsMovedParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

File

string

(File)

Project Share File

True

FileContent

string

(Include FileContent)

Include FileContent ?

True

GetDropdownlistOptions

Operation

string

 

 

True

hook

TriggerWhenFileIsMovedParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 

Trigger TriggerWhenFileIsHardDeleted

Summary: When a file is deleted from Recycle Bin

Description: When a file is deleted from Recycle Bin

 

Syntax:

ProjectwiseShare.TriggerWhenFileIsHardDeleted (string Project, string File, [internal]string Operation, TriggerWhenFileIsHardDeletedParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

File

string

(File)

Project Share File

True

Operation

string

 

 

True

hook

TriggerWhenFileIsHardDeletedParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 

Trigger TriggerWhenFileMovedToRecycleBin

Summary: When a file is moved to Recycle Bin

Description: When a file is moved to Recycle Bin

 

Syntax:

ProjectwiseShare.TriggerWhenFileMovedToRecycleBin (string Project, string File, [internal]string Operation, TriggerWhenFileMovedToRecycleBinParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

File

string

(File)

Project Share File

True

Operation

string

 

 

True

hook

TriggerWhenFileMovedToRecycleBinParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 

Trigger TriggerWhenFileRestored

Summary: When a file is restored from Recycle Bin

Description: When a file is restored from Recycle Bin

 

Syntax:

ProjectwiseShare.TriggerWhenFileRestored (string Project, string File, string FileContent, [internal]string Operation, TriggerWhenFileRestoredParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

File

string

(File)

Project Share File

True

FileContent

string

(Include FileContent)

Include FileContent ?

True

GetDropdownlistOptions

Operation

string

 

 

True

hook

TriggerWhenFileRestoredParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 

Trigger TriggerWhenFileIsCreated

Summary: When a file is created

Description: When a file is created

 

Syntax:

ProjectwiseShare.TriggerWhenFileIsCreated (string Project, string Folder, string FileContent, [internal]string Operation, TriggerWhenFileIsCreatedParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

Folder

string

(Folder)

Project Share Folder

True

FileContent

string

(Include FileContent)

Include FileContent ?

True

GetDropdownlistOptions

Operation

string

 

 

True

hook

TriggerWhenFileIsCreatedParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 

Trigger TriggerWhenFileIsModified

Summary: When a file is modified

Description: When a file is modified

 

Syntax:

ProjectwiseShare.TriggerWhenFileIsModified (string Project, string Folder, string FileContent, [internal]string Operation, TriggerWhenFileIsModifiedParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

Folder

string

(Folder)

Project Share Folder

True

FileContent

string

(Include FileContent)

Include FileContent ?

True

GetDropdownlistOptions

Operation

string

 

 

True

hook

TriggerWhenFileIsModifiedParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 

Trigger TriggerWhenFolderCreated

Summary: When a folder is created

Description: When a folder is created

 

Syntax:

ProjectwiseShare.TriggerWhenFolderCreated (string Project, string Folder, [internal]string Operation, TriggerWhenFolderCreatedParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

Folder

string

(Folder)

Project Share Folder

True

Operation

string

 

 

True

hook

TriggerWhenFolderCreatedParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 

Trigger TriggerWhenFolderMovedToRecycleBin

Summary: When a folder is moved to Recycle Bin

Description: When a folder moved to Recycle Bin

 

Syntax:

ProjectwiseShare.TriggerWhenFolderMovedToRecycleBin (string Project, string Folder, [internal]string Operation, TriggerWhenFolderMovedToRecycleBinParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

Folder

string

(Folder)

Project Share Folder

True

Operation

string

 

 

True

hook

TriggerWhenFolderMovedToRecycleBinParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 

Trigger TriggerWhenFolderHardDeleted

Summary: When a folder is deleted from Recycle Bin

Description: When a folder is deleted from Recycle Bin

 

Syntax:

ProjectwiseShare.TriggerWhenFolderHardDeleted (string Project, string Folder, [internal]string Operation, TriggerWhenFolderHardDeletedParameterHook hook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

string

(Project)

Bentley CONNECT project

True

GetProjectList

Folder

string

(Folder)

Project Share Folder

True

Operation

string

 

 

True

hook

TriggerWhenFolderHardDeletedParameterHook

 

 

True

 

Returns:

††††††††† Type:string

 


 

Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary


 

PSConnector.CoreApi.Models.FileModel

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

name

string

File Name

Name of the file

content

string(byte)

File Content

Content of the file


 

PSConnector.CoreApi.Models.FolderModel

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

name

string

Folder Name

Name of the Folder

description

string

Folder Description

Description of the Folder


 

PSConnector.CoreApi.Models.Item

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

instanceId

string

 

 

path

string

 

 

isFolder

boolean

 

 

name

string

 

 


 

PSConnector.CoreApi.Models.JsonSchema

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

type

string

 

Values: [string, object, number, integer]

properties

Properties

 

 

x-ms-visibility

string

 

Values: [default, internal, advanced, important]

 

Properties

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

 


 

PSConnector.CoreApi.Models.ObjectResultResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

value

Value

 

 

formatters

array of (Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter)

 

 

contentTypes

array of (string)

 

 

declaredType

string

 

 

statusCode

integer(int32)

 

 

 

Value

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

 


 

PSConnector.CoreApi.Models.PickerSelectionResponseModel

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

type

integer(int32)

 

 

id

string

 

 

path

string

 

 

title

string

 

 

isFolder

boolean

 

 


 

TriggerWhenFileIsCreatedParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 


 

TriggerWhenFileIsHardDeletedParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 


 

TriggerWhenFileIsModifiedParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 


 

TriggerWhenFileIsMovedParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 


 

TriggerWhenFileMovedToRecycleBinParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 


 

TriggerWhenFileRestoredParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 


 

TriggerWhenFolderCreatedParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 


 

TriggerWhenFolderHardDeletedParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 


 

TriggerWhenFolderMovedToRecycleBinParameterHook

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

active

boolean

 

 

name

string

 

 

config

Config

 

 

events

array of (string)

 

 

 

Config

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

content_type

string

 

 

url

string