ChangeStatus client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The ChangeStatus client API is used to set the status of a project, such as active or completed.

Argument

Description

Parameter 1

From state

Parameter 1 default

None

Parameter 1 description

The current status of the project.

Parameter 1 type

String

Parameter 2

To state

Parameter 2 default

None

Parameter 2 description

The next status of the project.

Parameter 2 type

String

Parameter 3

Cleanup Subscriptions

Parameter 3 default

None

Parameter 3 description

Clean up existing object notification subscriptions from one or more events that occur.

Parameter 3 type

String

The following methods use the ChangeStatus client API to set the status of a project.

  • CfgActivateConfiguration

  • CfgReActivateConfiguration

  • CfgSetConfigurationApproved

  • CfgSetConfigurationCancelled

  • CfgSetConfigurationCompleted

  • CfgSetConfigurationFinished

  • CfgSetConfigurationFinished2

  • CfgSetConfigurationMerged