Connectors Reference

ProjectWise Design Integration

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.

 

Status: Preview

Tier: Standard

Version: v1

 

Actions:

Name

Summary

GetDocumentSchema (string connectedProjectId, string federatedRepositoryId, [Optional]string projectFolderPathOrId, [Optional]string environment, [Optional]string accessScope)

GetDocumentSchema

GetAttributeSchemaByEnvironment (string connectedProjectId, string federatedRepositoryId, string environmentId, [Optional]string accessScope)

GetAttributeSchemaByEnvironment

GetAttributes (string connection, [Optional]string environmentId, [Optional]string accessScope)

GetAttributes

GetAttributeSchema_V2 (string connection, [Optional]string environmentInstanceIdOrName, [Optional]string accessScope)

GetAttributeSchema_V2

GetDocuments (string connectedProjectId, string federatedRepositoryId, string projectFolderPathOrId, [Optional]string environment, [Optional]integer Top, [Optional]integer Skip)

List documents in a folder

FindDocumentReferences (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [Optional]string environment)

Find references of a document by path or GUID

FindDocumentVersions (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [Optional]string environment)

Find versions of a document by path or GUID

ListDocumentsInSet (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [Optional]string environment, [Optional]integer Top, [Optional]integer Skip)

List documents in a set

FindDocument (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [Optional]string environment)

Find a document by path or GUID

EditDocument (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, DocumentModelNameNotRequired documentModel, [advanced][Optional]string environment)

Modify a document

FindDocumentsBySavedSearch (string connectedProjectId, string federatedRepositoryId, integer savedSearchId, [Optional]string environment)

Find documents by saved search

CreateDocument (string connectedProjectId, string federatedRepositoryId, string projectIdentifier, DocumentModel documentModel, [advanced][Optional]string environment)

Create a new document

ChangeDocumentState (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, DocumentStateChangeModelV1 documentModel)

Change document state

GetDocuments_V2 (string connection, string projectFolderPathOrId, [Optional]string environment, [Optional]integer Top, [Optional]integer Skip)

List documents in a folder (V2)

FindDocumentReferences_V2 (string connection, string documentIdentifier, [Optional]string environment)

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

FindDocumentVersions_V2 (string connection, string documentIdentifier, [Optional]string environment)

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

ListDocumentsInSet_V2 (string connection, string documentIdentifier, [advanced][Optional]string environment, [Optional]integer Top, [Optional]integer Skip)

List documents in a set (V2)

FindDocument_V2 (string connection, string documentIdentifier, [Optional]string environment)

Find a document by path or GUID (V2)

EditDocument_V2 (string connection, string documentIdentifier, [advanced][Optional]string environment, DocumentModelNameNotRequiredV2 documentModel)

Modify a document (V2)

FindDocumentsBySavedSearch_V2 (string connection, string savedSearchPathOrId, [Optional]string environment)

Find documents by saved search (V2)

CreateDocument_V2 (string connection, string projectIdentifier, [advanced][Optional]string environment, DocumentModelV2 documentModel)

Create a new document (V2)

ChangeDocumentState_V2 (string connection, string documentIdentifier, DocumentStateChangeModelV2 documentModel)

Change document state (V2)

SynchronizeDocumentAttributes_V2 (string connection, string documentIdentifier, AttributeSynchronizationModel attributeSynchronizationModel)

Synchronize document attributes (V2)

GetSelections (string connectedProjectId, string federatedRepositoryId, string selectableTypes, [Optional]string parentType, [Optional]string parentId, [Optional]string parentPath)

 

ConnectionPicker (string connection, [Optional]string featureId, [Optional]string projectType)

 

DocumentPicker (string connection, [Optional]string parentId, [Optional]string parentPath, [Optional]string documentTypes)

 

FolderPicker (string connection, [Optional]string parentId, [Optional]string parentPath)

 

SavedSearchPicker (string connection, [Optional]string savedSearchTypes, [Optional]string parentId, [Optional]string parentPath, [Optional]string parentType)

 

GetSelections_V2 (string connection, string selectableTypes, [Optional]string parentType, [Optional]string parentId, [Optional]string parentPath, [Optional]string featureId, [Optional]string connectedProjectId, [Optional]string federatedRepositoryId)

 

GetEnvironments (string connectedProjectId, string federatedRepositoryId)

GetEnvironments

GetEnvironments_V2 (string connection)

GetEnvironments_V2

GetFederatedRepositories (string connectedProjectId, [internal][Optional]string featureId)

GetFederatedRepositories

GetFile (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [internal][Optional]string chunkRef, [internal][Optional]string docType)

Get document file

UploadFile (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, string fileContent, string x-bs-file-name)

Upload document file

UploadFileChunk (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, string fileChunkContent, [Optional]string chunkRef)

Upload document file chunk

GetFile_V2 (string connection, string documentIdentifier, [internal][Optional]string chunkRef, [internal][Optional]string docType)

Get document file (V2)

UploadFile_V2 (string connection, string documentIdentifier, string fileContent, string x-bs-file-name)

Upload document file (V2)

UploadFileChunk_V2 (string connection, string documentIdentifier, string fileChunkContent, [Optional]string chunkRef)

Upload document file chunk (V2)

GetChildProjects (string connectedProjectId, string federatedRepositoryId, string parentProjectId, [internal][Optional]string parentProjectPath, [Optional]integer Top, [Optional]integer Skip)

List folders

CreateFolder (string connectedProjectId, string federatedRepositoryId, ProjectModel project)

Create a new folder

FindFolderByPathOrGuid (string connectedProjectId, string federatedRepositoryId, string folderIdentifier)

Find folder by path or GUID

FindFoldersBySavedSearch (string connectedProjectId, string federatedRepositoryId, integer savedSearchId)

Find folders by saved search

GetChildProjects_V2 (string connection, string parentProjectId, [internal][Optional]string parentProjectPath, [Optional]integer Top, [Optional]integer Skip)

List folders (V2)

CreateFolder_V2 (string connection, ProjectModelV2 project)

Create a new folder (V2)

FindFolderByPathOrGuid_V2 (string connection, string folderIdentifier)

Find folder by path or GUID (V2)

FindFoldersBySavedSearch_V2 (string connection, string savedSearchPathOrId)

Find folders by saved search (V2)

GetConnectedProjects ([internal][Optional]string featureId)

GetConnectedProjects

InvokeWorkflowCommand (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, WorkflowCommandRunModel workflowCommandRunModel)

Invoke workflow command by label

InvokeWorkflowCommand_V2 (string connection, string documentIdentifier, WorkflowCommandRunModel workflowCommandRunModel)

Invoke workflow command by label (V2)

GetWorkflows (string connectedProjectId, string federatedRepositoryId)

Get all workflows

GetWorkflows_V2 (string connection)

Get all workflows (V2)

GetAllWorkflowStates (string connectedProjectId, string federatedRepositoryId)

Get all workflow states

GetAllWorkflowStates_V2 (string connection)

Get all workflow states (V2)

ExecuteWsgRequest (string connectedProjectId, string federatedRepositoryId, WsgRequestModel wsgRequestBody)

Execute WSG request

ExecuteWsgRequest_V2 (string connection, WsgRequestModel wsgRequestBody)

Execute WSG request (V2)

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AttributeModel

 

AttributeResponseModel

 

AttributeSynchronizationModel

 

ConnectedProject

 

ConnectionSelectionResponseModel

 

DocumentModel

 

DocumentModelNameNotRequired

 

DocumentModelNameNotRequiredV2

 

DocumentModelResponse

 

DocumentModelResponseV2

 

DocumentModelV2

 

DocumentSelectionResponseModel

 

DocumentStateChangeModelV1

 

DocumentStateChangeModelV2

 

EnvironmentResponseModel

 

FileModel

 

FileModelResponse

 

FolderSelectionResponseModel

 

JsonResponseModel

 

JsonSchema

 

PickerSelectionResponseModel

 

ProjectModel

 

ProjectModelV2

 

ProjectResponseModel

 

QueryParameterModel

 

RepositoryModel

 

SavedSearchSelectionResponseModel

 

WorkflowCommandRunMessageResponseModel

 

WorkflowCommandRunModel

 

WorkflowCommandRunResponseModel

 

WorkflowResponseModel

 

WorkflowStateResponseModel

 

WorkflowStateResponseModelV2

 

WsgRequestModel

 

 

Actions:

GetDocumentSchema

Summary: GetDocumentSchema

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetDocumentSchema (string connectedProjectId, string federatedRepositoryId, [Optional]string projectFolderPathOrId, [Optional]string environment, [Optional]string accessScope)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

 

 

True

federatedRepositoryId

string(uuid)

 

 

True

projectFolderPathOrId

string

 

 

False

environment

string

 

 

False

accessScope

string

Values: [read, write]

 

False

 

Returns:

          Type:JsonSchema

 

GetAttributeSchemaByEnvironment

Summary: GetAttributeSchemaByEnvironment

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetAttributeSchemaByEnvironment (string connectedProjectId, string federatedRepositoryId, string environmentId, [Optional]string accessScope)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

 

 

True

federatedRepositoryId

string(uuid)

 

 

True

environmentId

string

 

 

True

accessScope

string

Values: [read, write]

 

False

 

Returns:

          Type:JsonSchema

 

GetAttributes

Summary: GetAttributes

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetAttributes (string connection, [Optional]string environmentId, [Optional]string accessScope)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

environmentId

string

 

 

False

accessScope

string

Values: [read, write]

 

False

 

Returns:

          Type:array of (AttributeResponseModel)

 

GetAttributeSchema_V2

Summary: GetAttributeSchema_V2

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetAttributeSchema_V2 (string connection, [Optional]string environmentInstanceIdOrName, [Optional]string accessScope)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

environmentInstanceIdOrName

string

 

 

False

accessScope

string

Values: [read, write]

 

False

 

Returns:

          Type:JsonSchema

 

GetDocuments

Summary: List documents in a folder

Description: Lists all the documents in the folder

 

Syntax:

ProjectWiseDesignIntegration.GetDocuments (string connectedProjectId, string federatedRepositoryId, string projectFolderPathOrId, [Optional]string environment, [Optional]integer Top, [Optional]integer Skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

projectFolderPathOrId

string

(Folder)

Folder path or GUID

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments

Top

integer(int32)

(Top count)

Total number of documents to retrieve

False

Skip

integer(int32)

(Skip count)

Total number of documents to skip

False

 

Returns:

          Type:array of (DocumentModelResponse)

 

FindDocumentReferences

Summary: Find references of a document by path or GUID

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

 

Syntax:

ProjectWiseDesignIntegration.FindDocumentReferences (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments

 

Returns:

          Type:array of (DocumentModelResponse)

 

FindDocumentVersions

Summary: Find versions of a document by path or GUID

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

 

Syntax:

ProjectWiseDesignIntegration.FindDocumentVersions (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments

 

Returns:

          Type:array of (DocumentModelResponse)

 

ListDocumentsInSet

Summary: List documents in a set

Description: Lists all the documents in the set

 

Syntax:

ProjectWiseDesignIntegration.ListDocumentsInSet (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [Optional]string environment, [Optional]integer Top, [Optional]integer Skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments

Top

integer(int32)

(Top count)

Total number of documents to retrieve

False

Skip

integer(int32)

(Skip count)

Total number of documents to skip

False

 

Returns:

          Type:array of (DocumentModelResponse)

 

FindDocument

Summary: Find a document by path or GUID

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

 

Syntax:

ProjectWiseDesignIntegration.FindDocument (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments

 

Returns:

          Type:DocumentModelResponse

 

EditDocument

Summary: Modify a document

Description: Modifies ProjectWise Design Integration document

 

Syntax:

ProjectWiseDesignIntegration.EditDocument (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, DocumentModelNameNotRequired documentModel, [advanced][Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

documentModel

DocumentModelNameNotRequired

 

 

True

environment

string

(Environment)

The environment to use for attributes

False

GetEnvironments

 

Returns:

          Type:DocumentModelResponse

 

FindDocumentsBySavedSearch

Summary: Find documents by saved search

Description: Finds documents in ProjectWise Design Integration work area by saved search

 

Syntax:

ProjectWiseDesignIntegration.FindDocumentsBySavedSearch (string connectedProjectId, string federatedRepositoryId, integer savedSearchId, [Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

savedSearchId

integer(int32)

(Saved Search)

ProjectWise Design Integration saved search

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments

 

Returns:

          Type:array of (DocumentModelResponse)

 

CreateDocument

Summary: Create a new document

Description: Creates a new document in ProjectWise Design Integration work area

 

Syntax:

ProjectWiseDesignIntegration.CreateDocument (string connectedProjectId, string federatedRepositoryId, string projectIdentifier, DocumentModel documentModel, [advanced][Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

projectIdentifier

string

(Folder)

Destination folder path or GUID

True

documentModel

DocumentModel

 

 

True

environment

string

(Environment)

The environment to use for attributes

False

GetEnvironments

 

Returns:

          Type:DocumentModelResponse

 

ChangeDocumentState

Summary: Change document state

Description: Changes a workflow state of a document

 

Syntax:

ProjectWiseDesignIntegration.ChangeDocumentState (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, DocumentStateChangeModelV1 documentModel)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

documentModel

DocumentStateChangeModelV1

 

 

True

 

Returns:

          Type:WorkflowStateResponseModel

 

GetDocuments_V2

Summary: List documents in a folder (V2)

Description: Lists all the documents in the folder

 

Syntax:

ProjectWiseDesignIntegration.GetDocuments_V2 (string connection, string projectFolderPathOrId, [Optional]string environment, [Optional]integer Top, [Optional]integer Skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

projectFolderPathOrId

string

(Folder)

Folder path or GUID

True

environment

string

(Environment)

The environment to use for attributes

False

GetEnvironments_V2

Top

integer(int32)

(Top count)

Total number of documents to retrieve

False

Skip

integer(int32)

(Skip count)

Total number of documents to skip

False

 

Returns:

          Type:array of (DocumentModelResponseV2)

 

FindDocumentReferences_V2

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

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

 

Syntax:

ProjectWiseDesignIntegration.FindDocumentReferences_V2 (string connection, string documentIdentifier, [Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments_V2

 

Returns:

          Type:array of (DocumentModelResponseV2)

 

FindDocumentVersions_V2

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

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

 

Syntax:

ProjectWiseDesignIntegration.FindDocumentVersions_V2 (string connection, string documentIdentifier, [Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments_V2

 

Returns:

          Type:array of (DocumentModelResponseV2)

 

ListDocumentsInSet_V2

Summary: List documents in a set (V2)

Description: Lists all the documents in the set

 

Syntax:

ProjectWiseDesignIntegration.ListDocumentsInSet_V2 (string connection, string documentIdentifier, [advanced][Optional]string environment, [Optional]integer Top, [Optional]integer Skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment)

The environment to use for attributes

False

GetEnvironments_V2

Top

integer(int32)

(Top count)

Total number of documents to retrieve

False

Skip

integer(int32)

(Skip count)

Total number of documents to skip

False

 

Returns:

          Type:array of (DocumentModelResponseV2)

 

FindDocument_V2

Summary: Find a document by path or GUID (V2)

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

 

Syntax:

ProjectWiseDesignIntegration.FindDocument_V2 (string connection, string documentIdentifier, [Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment for result)

The environment to use for attributes in the result

False

GetEnvironments_V2

 

Returns:

          Type:DocumentModelResponseV2

 

EditDocument_V2

Summary: Modify a document (V2)

Description: Modifies ProjectWise Design Integration document

 

Syntax:

ProjectWiseDesignIntegration.EditDocument_V2 (string connection, string documentIdentifier, [advanced][Optional]string environment, DocumentModelNameNotRequiredV2 documentModel)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

environment

string

(Environment)

The environment to use for attributes

False

GetEnvironments_V2

documentModel

DocumentModelNameNotRequiredV2

 

 

True

 

Returns:

          Type:DocumentModelResponseV2

 

FindDocumentsBySavedSearch_V2

Summary: Find documents by saved search (V2)

Description: Finds documents in ProjectWise Design Integration work area by saved search

 

Syntax:

ProjectWiseDesignIntegration.FindDocumentsBySavedSearch_V2 (string connection, string savedSearchPathOrId, [Optional]string environment)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

savedSearchPathOrId

string

(Saved Search)

ProjectWise Design Integration saved search

True

environment

string

(Environment)

The environment to use for attributes

False

GetEnvironments_V2

 

Returns:

          Type:array of (DocumentModelResponseV2)

 

CreateDocument_V2

Summary: Create a new document (V2)

Description: Creates a new document in ProjectWise Design Integration work area

 

Syntax:

ProjectWiseDesignIntegration.CreateDocument_V2 (string connection, string projectIdentifier, [advanced][Optional]string environment, DocumentModelV2 documentModel)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

projectIdentifier

string

(Folder)

Destination folder path or GUID

True

environment

string

(Environment)

The environment to use for attributes

False

GetEnvironments_V2

documentModel

DocumentModelV2

 

 

True

 

Returns:

          Type:DocumentModelResponseV2

 

ChangeDocumentState_V2

Summary: Change document state (V2)

Description: Changes a workflow state of a document

 

Syntax:

ProjectWiseDesignIntegration.ChangeDocumentState_V2 (string connection, string documentIdentifier, DocumentStateChangeModelV2 documentModel)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

documentModel

DocumentStateChangeModelV2

 

 

True

 

Returns:

          Type:WorkflowStateResponseModelV2

 

SynchronizeDocumentAttributes_V2

Summary: Synchronize document attributes (V2)

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

 

Syntax:

ProjectWiseDesignIntegration.SynchronizeDocumentAttributes_V2 (string connection, string documentIdentifier, AttributeSynchronizationModel attributeSynchronizationModel)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

attributeSynchronizationModel

AttributeSynchronizationModel

 

 

True

 

Returns:

 

GetSelections

Summary:

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetSelections (string connectedProjectId, string federatedRepositoryId, string selectableTypes, [Optional]string parentType, [Optional]string parentId, [Optional]string parentPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

 

 

True

federatedRepositoryId

string(uuid)

 

 

True

selectableTypes

string

Values: [folder, document, savedSearchForFolders, savedSearchForDocuments, flatSet, logicalSet, documentLogicalSet, documentFlatSetLogicalSet, all]

 

True

parentType

string

Values: [folder, savedSearch, foldersGroup, savedSearchesGroup, globalSavedSearchesGroup, personalSavedSearchesGroup]

 

False

parentId

string

 

 

False

parentPath

string

 

 

False

 

Returns:

          Type:array of (PickerSelectionResponseModel)

 

ConnectionPicker

Summary:

Description:

 

Syntax:

ProjectWiseDesignIntegration.ConnectionPicker (string connection, [Optional]string featureId, [Optional]string projectType)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

featureId

string(uuid)

 

 

False

projectType

string

Values: [none, recent, favorite, user, all]

 

False

 

Returns:

          Type:array of (ConnectionSelectionResponseModel)

 

DocumentPicker

Summary:

Description:

 

Syntax:

ProjectWiseDesignIntegration.DocumentPicker (string connection, [Optional]string parentId, [Optional]string parentPath, [Optional]string documentTypes)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

parentId

string(uuid)

 

 

False

parentPath

string

 

 

False

documentTypes

string

Values: [Document, FlatSet, LogicalSet, DocumentFlatSet, DocumentLogicalSet, FlatSetLogicalSet, DocumentFlatSetLogicalSet, All]

 

False

 

Returns:

          Type:array of (DocumentSelectionResponseModel)

 

FolderPicker

Summary:

Description:

 

Syntax:

ProjectWiseDesignIntegration.FolderPicker (string connection, [Optional]string parentId, [Optional]string parentPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

parentId

string(uuid)

 

 

False

parentPath

string

 

 

False

 

Returns:

          Type:array of (FolderSelectionResponseModel)

 

SavedSearchPicker

Summary:

Description:

 

Syntax:

ProjectWiseDesignIntegration.SavedSearchPicker (string connection, [Optional]string savedSearchTypes, [Optional]string parentId, [Optional]string parentPath, [Optional]string parentType)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

savedSearchTypes

string

Values: [document, folder, all]

 

False

parentId

string

 

 

False

parentPath

string

 

 

False

parentType

string

Values: [folder, savedSearch, foldersGroup, savedSearchesGroup, globalSavedSearchesGroup, personalSavedSearchesGroup]

 

False

 

Returns:

          Type:array of (SavedSearchSelectionResponseModel)

 

GetSelections_V2

Summary:

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetSelections_V2 (string connection, string selectableTypes, [Optional]string parentType, [Optional]string parentId, [Optional]string parentPath, [Optional]string featureId, [Optional]string connectedProjectId, [Optional]string federatedRepositoryId)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

selectableTypes

string

Values: [connection, folder, document, flatSet, logicalSet, savedSearchForFolders, savedSearchForDocuments, all]

 

True

parentType

string

Values: [projectWiseProject, favoriteProjectWiseProjectGroup, recentProjectWiseProjectGroup, userProjectWiseProjectGroup, folder, savedSearch, foldersGroup, savedSearchesGroup, globalSavedSearchesGroup, personalSavedSearchesGroup]

 

False

parentId

string

 

 

False

parentPath

string

 

 

False

featureId

string(uuid)

 

 

False

connectedProjectId

string(uuid)

 

 

False

federatedRepositoryId

string(uuid)

 

 

False

 

Returns:

          Type:array of (PickerSelectionResponseModel)

 

GetEnvironments

Summary: GetEnvironments

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetEnvironments (string connectedProjectId, string federatedRepositoryId)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

 

 

True

federatedRepositoryId

string(uuid)

 

 

True

 

Returns:

          Type:array of (EnvironmentResponseModel)

 

GetEnvironments_V2

Summary: GetEnvironments_V2

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetEnvironments_V2 (string connection)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

 

Returns:

          Type:array of (EnvironmentResponseModel)

 

GetFederatedRepositories

Summary: GetFederatedRepositories

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetFederatedRepositories (string connectedProjectId, [internal][Optional]string featureId)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

 

 

True

featureId

string

 

 

False

 

Returns:

          Type:array of (RepositoryModel)

 

GetFile

Summary: Get document file

Description: Gets ProjectWise Design Integration document file

 

Syntax:

ProjectWiseDesignIntegration.GetFile (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, [internal][Optional]string chunkRef, [internal][Optional]string docType)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

chunkRef

string

 

 

False

docType

string

Values: [Document, LogicalSet]

 

False

 

Returns:

          Type:string(binary)

          Summary: File content

          Description: Content of the file

 

UploadFile

Summary: Upload document file

Description: Uploads a new file or replaces existing file for a document

 

Syntax:

ProjectWiseDesignIntegration.UploadFile (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, string fileContent, string x-bs-file-name)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

fileContent

string(binary)

 

 

True

x-bs-file-name

string

(File name)

Name of the file

True

 

Returns:

 

UploadFileChunk

Summary: Upload document file chunk

Description: Uploads file chunk for a document

 

Syntax:

ProjectWiseDesignIntegration.UploadFileChunk (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, string fileChunkContent, [Optional]string chunkRef)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

 

 

True

federatedRepositoryId

string(uuid)

 

 

True

documentIdentifier

string

 

 

True

fileChunkContent

string(binary)

 

 

True

chunkRef

string

 

 

False

 

Returns:

 

GetFile_V2

Summary: Get document file (V2)

Description: Gets ProjectWise Design Integration document file

 

Syntax:

ProjectWiseDesignIntegration.GetFile_V2 (string connection, string documentIdentifier, [internal][Optional]string chunkRef, [internal][Optional]string docType)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

chunkRef

string

 

 

False

docType

string

Values: [Document, LogicalSet]

 

False

 

Returns:

          Type:string(binary)

          Summary: File content

          Description: Content of the file

 

UploadFile_V2

Summary: Upload document file (V2)

Description: Uploads a new file or replaces existing file for a document

 

Syntax:

ProjectWiseDesignIntegration.UploadFile_V2 (string connection, string documentIdentifier, string fileContent, string x-bs-file-name)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

fileContent

string(binary)

 

 

True

x-bs-file-name

string

(File name)

Name of the file

True

 

Returns:

 

UploadFileChunk_V2

Summary: Upload document file chunk (V2)

Description: Uploads file chunk for a document

 

Syntax:

ProjectWiseDesignIntegration.UploadFileChunk_V2 (string connection, string documentIdentifier, string fileChunkContent, [Optional]string chunkRef)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

documentIdentifier

string

 

 

True

fileChunkContent

string(binary)

 

 

True

chunkRef

string

 

 

False

 

Returns:

 

GetChildProjects

Summary: List folders

Description: Lists all the sub-folders of the folder

 

Syntax:

ProjectWiseDesignIntegration.GetChildProjects (string connectedProjectId, string federatedRepositoryId, string parentProjectId, [internal][Optional]string parentProjectPath, [Optional]integer Top, [Optional]integer Skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

parentProjectId

string

(Folder)

Folder path or GUID

True

parentProjectPath

string

(Folder)

Folder path or GUID

False

Top

integer(int32)

(Top count)

Total number of folders to retrieve

False

Skip

integer(int32)

(Skip count)

Total number of folders to skip

False

 

Returns:

          Type:array of (ProjectResponseModel)

 

CreateFolder

Summary: Create a new folder

Description: Creates a new folder in ProjectWise Design Integration work area

 

Syntax:

ProjectWiseDesignIntegration.CreateFolder (string connectedProjectId, string federatedRepositoryId, ProjectModel project)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

project

ProjectModel

 

 

True

 

Returns:

          Type:ProjectResponseModel

 

FindFolderByPathOrGuid

Summary: Find folder by path or GUID

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

 

Syntax:

ProjectWiseDesignIntegration.FindFolderByPathOrGuid (string connectedProjectId, string federatedRepositoryId, string folderIdentifier)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

folderIdentifier

string

(Folder)

Folder path or GUID

True

 

Returns:

          Type:ProjectResponseModel

 

FindFoldersBySavedSearch

Summary: Find folders by saved search

Description: Find folders in ProjectWise Design Integration work area by saved search

 

Syntax:

ProjectWiseDesignIntegration.FindFoldersBySavedSearch (string connectedProjectId, string federatedRepositoryId, integer savedSearchId)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

savedSearchId

integer(int32)

(Saved Search)

ProjectWise Design Integration saved search

True

 

Returns:

          Type:array of (ProjectResponseModel)

 

GetChildProjects_V2

Summary: List folders (V2)

Description: Lists all the sub-folders of the folder

 

Syntax:

ProjectWiseDesignIntegration.GetChildProjects_V2 (string connection, string parentProjectId, [internal][Optional]string parentProjectPath, [Optional]integer Top, [Optional]integer Skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

parentProjectId

string

(Folder)

Folder path or GUID

True

parentProjectPath

string

(Folder)

Folder path or GUID

False

Top

integer(int32)

(Top count)

Total number of folders to retrieve

False

Skip

integer(int32)

(Skip count)

Total number of folders to skip

False

 

Returns:

          Type:array of (ProjectResponseModel)

 

CreateFolder_V2

Summary: Create a new folder (V2)

Description: Creates a new folder in ProjectWise Design Integration work area

 

Syntax:

ProjectWiseDesignIntegration.CreateFolder_V2 (string connection, ProjectModelV2 project)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

project

ProjectModelV2

 

 

True

 

Returns:

          Type:ProjectResponseModel

 

FindFolderByPathOrGuid_V2

Summary: Find folder by path or GUID (V2)

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

 

Syntax:

ProjectWiseDesignIntegration.FindFolderByPathOrGuid_V2 (string connection, string folderIdentifier)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

folderIdentifier

string

(Folder)

Folder path or GUID

True

 

Returns:

          Type:ProjectResponseModel

 

FindFoldersBySavedSearch_V2

Summary: Find folders by saved search (V2)

Description: Find folders in ProjectWise Design Integration work area by saved search

 

Syntax:

ProjectWiseDesignIntegration.FindFoldersBySavedSearch_V2 (string connection, string savedSearchPathOrId)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

savedSearchPathOrId

string

(Saved Search)

ProjectWise Design Integration saved search

True

 

Returns:

          Type:array of (ProjectResponseModel)

 

GetConnectedProjects

Summary: GetConnectedProjects

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetConnectedProjects ([internal][Optional]string featureId)

 

Parameters:

Name

Type

Summary

Required

Related Action

featureId

string

 

 

False

 

Returns:

          Type:array of (ConnectedProject)

 

InvokeWorkflowCommand

Summary: Invoke workflow command by label

Description: Invokes a workflow command for a document

 

Syntax:

ProjectWiseDesignIntegration.InvokeWorkflowCommand (string connectedProjectId, string federatedRepositoryId, string documentIdentifier, WorkflowCommandRunModel workflowCommandRunModel)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

documentIdentifier

string

(Document)

Document path or GUID

True

workflowCommandRunModel

WorkflowCommandRunModel

 

 

True

 

Returns:

          Type:WorkflowCommandRunResponseModel

 

InvokeWorkflowCommand_V2

Summary: Invoke workflow command by label (V2)

Description: Invokes a workflow command for a document

 

Syntax:

ProjectWiseDesignIntegration.InvokeWorkflowCommand_V2 (string connection, string documentIdentifier, WorkflowCommandRunModel workflowCommandRunModel)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

documentIdentifier

string

(Document)

Document path or GUID

True

workflowCommandRunModel

WorkflowCommandRunModel

 

 

True

 

Returns:

          Type:WorkflowCommandRunResponseModel

 

GetWorkflows

Summary: Get all workflows

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetWorkflows (string connectedProjectId, string federatedRepositoryId)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

 

 

True

federatedRepositoryId

string(uuid)

 

 

True

 

Returns:

          Type:array of (WorkflowResponseModel)

 

GetWorkflows_V2

Summary: Get all workflows (V2)

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetWorkflows_V2 (string connection)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

 

Returns:

          Type:array of (WorkflowResponseModel)

 

GetAllWorkflowStates

Summary: Get all workflow states

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetAllWorkflowStates (string connectedProjectId, string federatedRepositoryId)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

 

 

True

federatedRepositoryId

string(uuid)

 

 

True

 

Returns:

          Type:array of (WorkflowStateResponseModel)

 

GetAllWorkflowStates_V2

Summary: Get all workflow states (V2)

Description:

 

Syntax:

ProjectWiseDesignIntegration.GetAllWorkflowStates_V2 (string connection)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

 

 

True

 

Returns:

          Type:array of (WorkflowStateResponseModel)

 

ExecuteWsgRequest

Summary: Execute WSG request

Description: Execute Web Services Gateway request

 

Syntax:

ProjectWiseDesignIntegration.ExecuteWsgRequest (string connectedProjectId, string federatedRepositoryId, WsgRequestModel wsgRequestBody)

 

Parameters:

Name

Type

Summary

Required

Related Action

connectedProjectId

string(uuid)

(ProjectWise Project)

ProjectWise project

True

GetConnectedProjects

federatedRepositoryId

string(uuid)

(Connection)

ProjectWise Design Integration connection

True

GetFederatedRepositories

wsgRequestBody

WsgRequestModel

 

 

True

 

Returns:

          Type:JsonResponseModel

 

ExecuteWsgRequest_V2

Summary: Execute WSG request (V2)

Description: Execute Web Services Gateway request

 

Syntax:

ProjectWiseDesignIntegration.ExecuteWsgRequest_V2 (string connection, WsgRequestModel wsgRequestBody)

 

Parameters:

Name

Type

Summary

Required

Related Action

connection

string

(Connection)

Connection to ProjectWise Design Integration work area

True

wsgRequestBody

WsgRequestModel

 

 

True

 

Returns:

          Type:JsonResponseModel

 


 

AttributeModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Name of the attribute

value

string

Value

Value of the attribute


 

AttributeResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 


 

AttributeSynchronizationModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

direction

string

Direction

Attribute synchronization direction  Values: [fromFile, toFile]


 

ConnectedProject

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

title

string

 

 


 

ConnectionSelectionResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

connection

string

 

 

fullTitle

string

 

 

projectType

string

 

Values: [none, recent, favorite, user, all]

title

string

 

 

isParent

boolean

 

 


 

DocumentModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Name of the document

description

string

Description

Description of the document

file

FileModel

 

 

version

string

Version

The version of the document

attributes

Attributes

 

 

 

Attributes

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

DocumentModelNameNotRequired

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Name of the document

description

string

Description

Description of the document

file

FileModel

 

 

version

string

Version

The version of the document

attributes

Attributes

 

 

 

Attributes

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

DocumentModelNameNotRequiredV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Name of the document

attributes

array of (AttributeModel)

Attribute

 

description

string

Description

Description of the document

file

FileModel

 

 

version

string

Version

The version of the document


 

DocumentModelResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

attributes

Attributes

 

 

createdBy

string

Created By

User who created the document

creationTime

string(date-time)

Creation Time

The time when the document was created

description

string

Description

Description of the document

documentType

string

Document Type

The type of the document  Values: [Document, FlatSet, LogicalSet, DocumentFlatSet, DocumentLogicalSet, FlatSetLogicalSet, DocumentFlatSetLogicalSet, All]

file

FileModelResponse

 

 

fileModificationTime

string(date-time)

File Modification Time

The time when the file was last modified

fileSize

integer(int64)

File Size

The size of the file

fileUpdatedBy

string

File Updated By

User who last updated the file of the document

id

string(uuid)

Document GUID

GUID of the document

isLatest

boolean

Is Current Version

Is this the current version of the document?

modificationTime

string(date-time)

Document Modification Time

The time when the document was last modified

name

string

Document Name

Name of the document

projectId

string

Folder GUID

GUID of the folder that the document resides in

projectShareUrl

string

Document Share Link

The link to access a document via ProjectWise Share

projectWiseUrl

string

Document URN

The URN link for use with ProjectWise Explorer

stateName

string

State Name

The workflow state of the document

status

string

Status

The status of the document

updatedBy

string

Updated By

User who last updated the document

version

string

Version

The version of the document

workflowId

integer(int32)

Workflow ID

Workflow ID of the document

workflowName

string

Workflow Name

The workflow name of the document

 

Attributes

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

DocumentModelResponseV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

attributes

Attributes

 

 

createdBy

string

Created By

User who created the document

creationTime

string(date-time)

Creation Time

The time when the document was created

description

string

Description

Description of the document

documentType

string

Document Type

The type of the document  Values: [Document, FlatSet, LogicalSet, DocumentFlatSet, DocumentLogicalSet, FlatSetLogicalSet, DocumentFlatSetLogicalSet, All]

file

FileModelResponse

 

 

fileModificationTime

string(date-time)

File Modification Time

The time when the file was last modified

fileSize

integer(int64)

File Size

The size of the file

fileUpdatedBy

string

File Updated By

User who last updated the file of the document

id

string(uuid)

Document GUID

GUID of the document

isLatest

boolean

Is Current Version

Is this the current version of the document?

modificationTime

string(date-time)

Document Modification Time

The time when the document was last modified

name

string

Document Name

Name of the document

projectId

string

Folder GUID

GUID of the folder that the document resides in

projectShareUrl

string

Document Share Link

The link to access a document via ProjectWise Share

projectWiseUrl

string

Document URN

The URN link for use with ProjectWise Explorer

stateName

string

State Name

The workflow state of the document

status

string

Status

The status of the document

updatedBy

string

Updated By

User who last updated the document

version

string

Version

The version of the document

workflowId

integer(int32)

Workflow ID

Workflow ID of the document

workflowName

string

Workflow Name

The workflow name of the document

 

Attributes

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

DocumentModelV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

attributes

array of (AttributeModel)

Attribute

 

name

string

Name

Name of the document

description

string

Description

Description of the document

file

FileModel

 

 

version

string

Version

The version of the document


 

DocumentSelectionResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

path

string

 

 

title

string

 

 

isParent

boolean

 

 


 

DocumentStateChangeModelV1

Summary:

Description:

 

          Properties:

Name

Type

Summary

stateId

integer(int32)

State ID

Workflow state ID


 

DocumentStateChangeModelV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

stateName

string

State name

Workflow state name


 

EnvironmentResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 


 

FileModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

File name

Name of the file

content

string(byte)

File content

Content of the file


 

FileModelResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

File name

Name of the file


 

FolderSelectionResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

path

string

 

 

title

string

 

 

isParent

boolean

 

 


 

JsonResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

httpStatusCode

integer(int32)

Http status code

Http status code

body

Body

JSON body

JSON body

 

Body

Summary: JSON body

Description: JSON body

 

          Properties:

Name

Type

Summary

 


 

JsonSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary

title

string

 

 

type

string

 

Values: [string, object, number, integer]

properties

Properties

 

 

x-ms-visibility

string

 

Values: [default, internal, advanced, important]

description

string

 

 

readonly

boolean

 

 

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

PickerSelectionResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

Values: [projectWiseProject, favoriteProjectWiseProjectGroup, recentProjectWiseProjectGroup, userProjectWiseProjectGroup, folder, savedSearch, foldersGroup, savedSearchesGroup, globalSavedSearchesGroup, personalSavedSearchesGroup]

id

string

 

 

path

string

 

 

title

string

 

 

isFolder

boolean

 

 


 

ProjectModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

environmentId

string

Environment

Environment of the folder

workflowId

integer(int32)

Workflow

Workflow of the folder

parent

string

Parent Folder

Parent folder path or GUID

name

string

Name

Name of the folder

description

string

Description

Description of the folder


 

ProjectModelV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

parent

string

Parent Folder

Parent folder path or GUID

environmentName

string

Environment

Environment of the folder

workflowName

string

Workflow

Workflow of the folder

name

string

Name

Name of the folder

description

string

Description

Description of the folder


 

ProjectResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

creationTime

string(date-time)

Creation Time

The time when the folder was created

description

string

Description

Description of the folder

environmentId

string

Environment ID

Environment ID of the folder

environmentName

string

Environment Name

Environment name of the folder

id

string

Folder GUID

GUID of the folder

isAssociatedToProject

boolean

Is Associated to Project

Specifies if this folder has an association to ProjectWise Project

isWorkArea

boolean

Is Work Area

Specifies if this folder is a work area

modificationTime

string(date-time)

Modification Time

The time when the folder was last modified

name

string

Folder Name

Name of the folder

parent

string

Parent Folder

GUID of the parent folder

path

string

Path

Path to the folder

projectShareUrl

string

Folder Share Link

The link to access a folder via ProjectWise Share

projectWiseUrl

string

Folder URN

The URN link for use with ProjectWise Explorer

workflowId

integer(int32)

Workflow ID

Workflow ID of the folder

workflowName

string

Workflow Name

Workflow name of the folder


 

QueryParameterModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Parameter

Parameter  Values: [$select, $filter, $top, $skip, $orderby]

value

string

Value

Value


 

RepositoryModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 


 

SavedSearchSelectionResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

Values: [folder, savedSearch, foldersGroup, savedSearchesGroup, globalSavedSearchesGroup, personalSavedSearchesGroup]

id

string

 

 

path

string

 

 

title

string

 

 

isParent

boolean

 

 


 

WorkflowCommandRunMessageResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

Message

Message containing information about workflow command run

severity

integer(int32)

Message Severity

Severity code of the message


 

WorkflowCommandRunModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

label

string

Label

Label of the workflow command

comment

string

Audit trail comment

Audit trail comment


 

WorkflowCommandRunResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Instance Id of the workflow command run

Id

messages

array of (WorkflowCommandRunMessageResponseModel)

Messages containing information about the workflow command run

Messages

isFinished

boolean

Is workflow command run finished

Is finished

commandSucceeded

boolean

Messages contain no error messages

Workflow command succeeded

status

integer(int32)

Status code of the workflow command run

Status Code

statusMessage

string

Status message of the workflow command run

Status Message


 

WorkflowResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

 

name

string

 

 


 

WorkflowStateResponseModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

State ID

Workflow state ID

name

string

 

 


 

WorkflowStateResponseModelV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

State name

Workflow state name

id

integer(int32)

State ID

Workflow state ID


 

WsgRequestModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

wsgUrlPart

string

URI

WSG relative part

method

string

Method

Http method to use for request  Values: [get, post, delete]

queryParameters

array of (QueryParameterModel)

Query

Query

body

string

Body

Body of http request