Jaa

ProjectWise Design Integration (Preview)

  • Reference

ProjectWise Design Integration from Bentley Systems, Inc. is an information management and design collaboration system to accelerate infrastructure project delivery. Connect to Design Integration to store and modify documents in ProjectWise.

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 Standard 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 Standard 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
URL https://communities.bentley.com/products/betas/projectwise-design-integration-connector-for-microsoft-flow-early-access/f/discussions
Connector Metadata
Publisher Bentley Systems, Incorporated
Website https://www.bentley.com/en/products/product-line/project-delivery-software/projectwise-design-integration
Privacy policy https://www.bentley.com/en/privacy-policy

To use this connector you will need a ProjectWise Project with a configured Work Area connection to ProjectWise Design Integration datasource. Learn more here, how to set up ProjectWise Design Integration datasource for use in your workflows.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Change document state (Preview)

Changes a workflow state of a document
Change document state (V2) (Preview)

Changes a workflow state of a document
Create a new document (Preview)

Creates a new document in ProjectWise Design Integration work area
Create a new document (V2) (Preview)

Creates a new document in ProjectWise Design Integration work area
Create a new folder (Preview)

Creates a new folder in ProjectWise Design Integration work area
Create a new folder (V2) (Preview)

Creates a new folder in ProjectWise Design Integration work area
Execute WSG request (Preview)

Execute Web Services Gateway request
Execute WSG request (V2) (Preview)

Execute Web Services Gateway request
Find a document by path or GUID (Preview)

Finds a document in ProjectWise Design Integration work area by path or GUID
Find a document by path or GUID (V2) (Preview)

Finds a document in ProjectWise Design Integration work area by path or GUID
Find documents by saved search (Preview)

Finds documents in ProjectWise Design Integration work area by saved search
Find documents by saved search (V2) (Preview)

Finds documents in ProjectWise Design Integration work area by saved search
Find folder by path or GUID (Preview)

Finds a folder in ProjectWise Design Integration work area by path or GUID
Find folder by path or GUID (V2) (Preview)

Finds a folder in ProjectWise Design Integration work area by path or GUID
Find folders by saved search (Preview)

Find folders in ProjectWise Design Integration work area by saved search
Find folders by saved search (V2) (Preview)

Find folders in ProjectWise Design Integration work area by saved search
Find references of a document by path or GUID (Preview)

Finds references of a document in ProjectWise Design Integration work area by path or GUID
Find references of a document by path or GUID (V2) (Preview)

Finds references of a document in ProjectWise Design Integration work area by path or GUID
Find versions of a document by path or GUID (Preview)

Finds versions of a document in ProjectWise Design Integration work area by path or GUID
Find versions of a document by path or GUID (V2) (Preview)

Finds versions of a document in ProjectWise Design Integration work area by path or GUID
Get document file (Preview)

Gets ProjectWise Design Integration document file
Get document file (V2) (Preview)

Gets ProjectWise Design Integration document file
Invoke workflow command by label (Preview)

Invokes a workflow command for a document
Invoke workflow command by label (V2) (Preview)

Invokes a workflow command for a document
List documents in a folder (Preview)

Lists all the documents in the folder
List documents in a folder (V2) (Preview)

Lists all the documents in the folder
List documents in a set (Preview)

Lists all the documents in the set
List documents in a set (V2) (Preview)

Lists all the documents in the set
List folders (Preview)

Lists all the sub-folders of the folder
List folders (V2) (Preview)

Lists all the sub-folders of the folder
Modify a document (Preview)

Modifies ProjectWise Design Integration document
Modify a document (V2) (Preview)

Modifies ProjectWise Design Integration document
Synchronize document attributes (V2) (Preview)

Synchronize document attributes according to the specified direction: To File or From File
Upload document file (Preview)

Uploads a new file or replaces existing file for a document
Upload document file (V2) (Preview)

Uploads a new file or replaces existing file for a document

Change document state (Preview)

Operation ID:
ChangeDocumentState

Changes a workflow state of a document

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID
State ID
 stateId True integer

Workflow state ID

Returns

Body
WorkflowStateResponseModel

Change document state (V2) (Preview)

Operation ID:
ChangeDocumentState_V2

Changes a workflow state of a document

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
State name
 stateName True string

Workflow state name

Returns

Body
WorkflowStateResponseModelV2

Create a new document (Preview)

Operation ID:
CreateDocument

Creates a new document in ProjectWise Design Integration work area

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Folder
 projectIdentifier True string

Destination folder path or GUID
Document model
 documentModel True dynamic
Environment
 environment string

The environment to use for attributes

Returns

The outputs of this operation are dynamic.

Create a new document (V2) (Preview)

Operation ID:
CreateDocument_V2

Creates a new document in ProjectWise Design Integration work area

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Folder
 projectIdentifier True string

Destination folder path or GUID
Environment
 environment string

The environment to use for attributes
Name
 name string

Name of the attribute
Value
 value string

Value of the attribute
Name
 name True string

Name of the document
Description
 description string

Description of the document
File name
 name string

Name of the file
File content
 content byte

Content of the file
Version
 version string

The version of the document

Returns

The outputs of this operation are dynamic.

Create a new folder (Preview)

Operation ID:
CreateFolder

Creates a new folder in ProjectWise Design Integration work area

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Environment
 environmentId string

Environment of the folder
Workflow
 workflowId integer

Workflow of the folder
Parent Folder
 parent True string

Parent folder path or GUID
Name
 name True string

Name of the folder
Description
 description string

Description of the folder

Returns

Body
ProjectResponseModel

Create a new folder (V2) (Preview)

Operation ID:
CreateFolder_V2

Creates a new folder in ProjectWise Design Integration work area

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Parent Folder
 parent True string

Parent folder path or GUID
Environment
 environmentName string

Environment of the folder
Workflow
 workflowName string

Workflow of the folder
Name
 name True string

Name of the folder
Description
 description string

Description of the folder

Returns

Body
ProjectResponseModel

Execute WSG request (Preview)

Operation ID:
ExecuteWsgRequest

Execute Web Services Gateway request

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
URI
 wsgUrlPart True string

WSG relative part
Method
 method True string

Http method to use for request
Parameter
 name string

Parameter
Value
 value string

Value
Body
 body string

Body of http request

Returns

Body
JsonResponseModel

Execute WSG request (V2) (Preview)

Operation ID:
ExecuteWsgRequest_V2

Execute Web Services Gateway request

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
URI
 wsgUrlPart True string

WSG relative part
Method
 method True string

Http method to use for request
Parameter
 name string

Parameter
Value
 value string

Value
Body
 body string

Body of http request

Returns

Body
JsonResponseModel

Find a document by path or GUID (Preview)

Operation ID:
FindDocument

Finds a document in ProjectWise Design Integration work area by path or GUID

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID
Environment for result
 environment string

The environment to use for attributes in the result

Returns

The outputs of this operation are dynamic.

Find a document by path or GUID (V2) (Preview)

Operation ID:
FindDocument_V2

Finds a document in ProjectWise Design Integration work area by path or GUID

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
Environment for result
 environment string

The environment to use for attributes in the result

Returns

The outputs of this operation are dynamic.

Find documents by saved search (Preview)

Operation ID:
FindDocumentsBySavedSearch

Finds documents in ProjectWise Design Integration work area by saved search

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Saved Search
 savedSearchId True integer

ProjectWise Design Integration saved search
Environment for result
 environment string

The environment to use for attributes in the result

Returns

The outputs of this operation are dynamic.

Find documents by saved search (V2) (Preview)

Operation ID:
FindDocumentsBySavedSearch_V2

Finds documents in ProjectWise Design Integration work area by saved search

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Saved Search
 savedSearchPathOrId True string

ProjectWise Design Integration saved search
Environment
 environment string

The environment to use for attributes

Returns

The outputs of this operation are dynamic.

Find folder by path or GUID (Preview)

Operation ID:
FindFolderByPathOrGuid

Finds a folder in ProjectWise Design Integration work area by path or GUID

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Folder
 folderIdentifier True string

Folder path or GUID

Returns

Body
ProjectResponseModel

Find folder by path or GUID (V2) (Preview)

Operation ID:
FindFolderByPathOrGuid_V2

Finds a folder in ProjectWise Design Integration work area by path or GUID

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Folder
 folderIdentifier True string

Folder path or GUID

Returns

Body
ProjectResponseModel

Find folders by saved search (Preview)

Operation ID:
FindFoldersBySavedSearch

Find folders in ProjectWise Design Integration work area by saved search

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Saved Search
 savedSearchId True integer

ProjectWise Design Integration saved search

Returns

response
array of ProjectResponseModel

Find folders by saved search (V2) (Preview)

Operation ID:
FindFoldersBySavedSearch_V2

Find folders in ProjectWise Design Integration work area by saved search

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Saved Search
 savedSearchPathOrId True string

ProjectWise Design Integration saved search

Returns

response
array of ProjectResponseModel

Find references of a document by path or GUID (Preview)

Operation ID:
FindDocumentReferences

Finds references of a document in ProjectWise Design Integration work area by path or GUID

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID
Environment for result
 environment string

The environment to use for attributes in the result

Returns

The outputs of this operation are dynamic.

Find references of a document by path or GUID (V2) (Preview)

Operation ID:
FindDocumentReferences_V2

Finds references of a document in ProjectWise Design Integration work area by path or GUID

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
Environment for result
 environment string

The environment to use for attributes in the result

Returns

The outputs of this operation are dynamic.

Find versions of a document by path or GUID (Preview)

Operation ID:
FindDocumentVersions

Finds versions of a document in ProjectWise Design Integration work area by path or GUID

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID
Environment for result
 environment string

The environment to use for attributes in the result

Returns

The outputs of this operation are dynamic.

Find versions of a document by path or GUID (V2) (Preview)

Operation ID:
FindDocumentVersions_V2

Finds versions of a document in ProjectWise Design Integration work area by path or GUID

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
Environment for result
 environment string

The environment to use for attributes in the result

Returns

The outputs of this operation are dynamic.

Get document file (Preview)

Operation ID:
GetFile

Gets ProjectWise Design Integration document file

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID

Returns

Content of the file

File content
binary

Get document file (V2) (Preview)

Operation ID:
GetFile_V2

Gets ProjectWise Design Integration document file

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID

Returns

Content of the file

File content
binary

Invoke workflow command by label (Preview)

Operation ID:
InvokeWorkflowCommand

Invokes a workflow command for a document

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID
Label
 label True string

Label of the workflow command
Audit trail comment
 comment string

Audit trail comment

Returns

Body
WorkflowCommandRunResponseModel

Invoke workflow command by label (V2) (Preview)

Operation ID:
InvokeWorkflowCommand_V2

Invokes a workflow command for a document

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
Label
 label True string

Label of the workflow command
Audit trail comment
 comment string

Audit trail comment

Returns

Body
WorkflowCommandRunResponseModel

List documents in a folder (Preview)

Operation ID:
GetDocuments

Lists all the documents in the folder

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Folder
 projectFolderPathOrId True string

Folder path or GUID
Environment for result
 environment string

The environment to use for attributes in the result
Top count
 Top integer

Total number of documents to retrieve
Skip count
 Skip integer

Total number of documents to skip

Returns

The outputs of this operation are dynamic.

List documents in a folder (V2) (Preview)

Operation ID:
GetDocuments_V2

Lists all the documents in the folder

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Folder
 projectFolderPathOrId True string

Folder path or GUID
Environment
 environment string

The environment to use for attributes
Top count
 Top integer

Total number of documents to retrieve
Skip count
 Skip integer

Total number of documents to skip

Returns

The outputs of this operation are dynamic.

List documents in a set (Preview)

Operation ID:
ListDocumentsInSet

Lists all the documents in the set

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID
Environment for result
 environment string

The environment to use for attributes in the result
Top count
 Top integer

Total number of documents to retrieve
Skip count
 Skip integer

Total number of documents to skip

Returns

The outputs of this operation are dynamic.

List documents in a set (V2) (Preview)

Operation ID:
ListDocumentsInSet_V2

Lists all the documents in the set

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
Environment
 environment string

The environment to use for attributes
Top count
 Top integer

Total number of documents to retrieve
Skip count
 Skip integer

Total number of documents to skip

Returns

The outputs of this operation are dynamic.

List folders (Preview)

Operation ID:
GetChildProjects

Lists all the sub-folders of the folder

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Folder
 parentProjectId True string

Folder path or GUID
Top count
 Top integer

Total number of folders to retrieve
Skip count
 Skip integer

Total number of folders to skip

Returns

response
array of ProjectResponseModel

List folders (V2) (Preview)

Operation ID:
GetChildProjects_V2

Lists all the sub-folders of the folder

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Folder
 parentProjectId True string

Folder path or GUID
Top count
 Top integer

Total number of folders to retrieve
Skip count
 Skip integer

Total number of folders to skip

Returns

response
array of ProjectResponseModel

Modify a document (Preview)

Operation ID:
EditDocument

Modifies ProjectWise Design Integration document

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID
Document model
 documentModel True dynamic
Environment
 environment string

The environment to use for attributes

Returns

The outputs of this operation are dynamic.

Modify a document (V2) (Preview)

Operation ID:
EditDocument_V2

Modifies ProjectWise Design Integration document

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
Environment
 environment string

The environment to use for attributes
Name
 name string

Name of the document
Name
 name string

Name of the attribute
Value
 value string

Value of the attribute
Description
 description string

Description of the document
File name
 name string

Name of the file
File content
 content byte

Content of the file
Version
 version string

The version of the document

Returns

The outputs of this operation are dynamic.

Synchronize document attributes (V2) (Preview)

Operation ID:
SynchronizeDocumentAttributes_V2

Synchronize document attributes according to the specified direction: To File or From File

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
Direction
 direction True string

Attribute synchronization direction

Upload document file (Preview)

Operation ID:
UploadFile

Uploads a new file or replaces existing file for a document

Parameters

Name Key Required Type Description
ProjectWise Project
 connectedProjectId True uuid

ProjectWise project
Connection
 federatedRepositoryId True uuid

ProjectWise Design Integration connection
Document
 documentIdentifier True string

Document path or GUID
File content
 fileContent True binary

Content of the file
File name
 x-bs-file-name True string

Name of the file

Upload document file (V2) (Preview)

Operation ID:
UploadFile_V2

Uploads a new file or replaces existing file for a document

Parameters

Name Key Required Type Description
Connection
 connection True string

Connection to ProjectWise Design Integration work area
Document
 documentIdentifier True string

Document path or GUID
File content
 fileContent True binary

Content of the file
File name
 x-bs-file-name True string

Name of the file

Definitions

WorkflowStateResponseModel

Name Path Type Description
State ID
 id integer

Workflow state ID

WorkflowStateResponseModelV2

Name Path Type Description
State name
 name string

Workflow state name
State ID
 id integer

Workflow state ID

ProjectResponseModel

Name Path Type Description
Creation Time
 creationTime date-time

The time when the folder was created
Description
 description string

Description of the folder
Environment ID
 environmentId string

Environment ID of the folder
Environment Name
 environmentName string

Environment name of the folder
Folder GUID
 id string

GUID of the folder
Is Associated to Project
 isAssociatedToProject boolean

Specifies if this folder has an association to ProjectWise Project
Is Work Area
 isWorkArea boolean

Specifies if this folder is a work area
Modification Time
 modificationTime date-time

The time when the folder was last modified
Folder Name
 name string

Name of the folder
Parent Folder
 parent string

GUID of the parent folder
Folder Share Link
 projectShareUrl string

The link to access a folder via ProjectWise Share
Folder URN
 projectWiseUrl string

The URN link for use with ProjectWise Explorer
Workflow ID
 workflowId integer

Workflow ID of the folder
Workflow Name
 workflowName string

Workflow name of the folder

WorkflowCommandRunResponseModel

Name Path Type Description
Instance Id of the workflow command run
 id string

Id
Messages containing information about the workflow command run
 messages array of WorkflowCommandRunMessageResponseModel

Messages
Is workflow command run finished
 isFinished boolean

Is finished
Messages contain no error messages
 commandSucceeded boolean

Workflow command succeeded
Status code of the workflow command run
 status integer

Status Code
Status message of the workflow command run
 statusMessage string

Status Message

WorkflowCommandRunMessageResponseModel

Name Path Type Description
Message
 message string

Message containing information about workflow command run
Message Severity
 severity integer

Severity code of the message

JsonResponseModel

Name Path Type Description
Http status code
 httpStatusCode integer

Http status code
JSON body
 body object

JSON body

binary

This is the basic data type 'binary'.