Using the programming interface you can also perform the operations on change lists. This section describes the methods and most important parameters.
All the operations that can be performed in a Web Service call occur in the context of a single change list, which is either transferred during the call or newly created by the Web Service.
If you have created several change lists you must be sure that the objects that you would like to change in the Web Service call are not locked in one of the other change lists.
Using the programming interface you can perform the following operations on the configuration objects.
Operation |
Description |
---|---|
Create |
Creates a new change list Enter the name and description as an optional parameter. If you do not enter any parameters then a standard name is created. The change list ID and, if necessary, any error messages are displayed. |
Activate |
Activates the change list Enter the change list ID as the call parameter. Before activation a consistency check is performed on all the objects in the change list. If inconsistencies are found, then the change list is not activated and the system displays the corresponding error message. If the system does not display a message then the change list has been activated. |
Revert |
Rejects changes. Enter the change list ID as the call parameter. If the requested change list does not exist or is not in status Editing (Open), then the process is terminated and an error list is displayed. |
GetObjectIdentifiers |
Lists the objects in a change list. Enter the change list ID as the call parameter. If the requested change list does not exist or is not in status Editing (Open), then the process is terminated and an error list is displayed. The Web Service displays a list of object keys of all the objects contained in the change list. |
CheckContent |
Checks the objects in a change list for consistency. Enter the change list ID as the call parameter. |
GetState |
Specifies the status of the change list. Enter the change list ID as the call parameter. The status and, if necessary, any error messages are displayed. The following values are permitted: Open , Transportable , Closed , Consolidated |
GetCacheState |
Specifies the status of the runtime cache. Enter the change list ID as the call parameter. The status of the runtime cache (parameter ChangeListCacheState ) and, if necessary, any error messages are displayed. The ChangeListCacheState parameter contains the following values for an individual cache notification:
|
You can find the related service interface operations, message types, and data types in the Change List folder.