Plant Information Catalog Web Service

You can maintain a plant information catalog in any MII instance. This function fetches the details of the groups, tags, and their properties. The following WSDLs are used:

Catalog Administration/Maintenance: PlantInformationMaintenanceService/PlantInformationMaintenanceServiceBean?wsdl&mode=ws_policy
Browse Plant Information Catalog: http://<server>:<port>/PlantInformationCatalogService/PlantInformationCatalogServiceBean?wsdl&mode=ws_policy
Change List
http://<servername>:<port>/ChangeListServices/ChangeListServicesBean?wsdl&mode=ws_policy

Features

The following operations are available in the working version and the live version:

Catalog Services

Operation	Input Parameters	Mandatory Parameters	Output Parameters	Description
BrowseGroups	Group Name Namespace of the group	Any one of the parameter.	List of object Group	Lists all the groups along with their description that are under the selected group. Returns all the groups under Root if there are no input parameters. Returns the first occurrence of the group if namespace is not provided.
BrowseTags	Group Name Namespace of the group	Any one of the parameter.	List of object Tag	List of tags under the specified tag with details (such as Data Server Name, Alias, and Description) are returned. Returns all the tags under Root if there are no input parameters. Returns the tags under the first occurrence of the group if namespace is not provided.
GetTagDetails	Tag Name Namespace	Any one of the parameter is mandatory.	Tag object	The details of a tag along with the properties are returned. Returns the first occurrence of the group if namespace is not provided.
GetCategories	none	-	List of group type objects	Gets the categories associated with this plant tag catalog.
GetGroupdetails	groupName groupNamespace	Any one of the parameter is mandatory	Group object	Group object
GetPropertyValue	tagNamespace propertyname	Both	List of TagProp objects	List of properties matching the parameters
SearchTags	Namespace Tag Name Search Keyword PropertySets Properties PropertyType Inactive Tags Description LastChangedSince CreatedSince		List of Tag objects	List of tags matching the search criteria with all details. Note The parameter InactiveTags must be set to False to facilitate search tags. When set to True, the search criteria returns only the list of inactive tags. End of the note.
SearchGroups	CategoryLevel GroupName Namespace searchKeyword Description LastChangedSince CreatedSince		List of group objects	List of groups matching the search criteria with all details.
FetchAllCustomProperties	NA	NA	List of TagProp objects	List of custom properties

CatalogAdminServices

Operation	Input Parameters	Mandatory Parameters	Output Parameters	Description
CreateTag	Parent namespace Tag object Change List ID	yes	createTagResult (Boolean) Tag namespace	Creates the tag and returns the namespace of the tag created.
CreateGroup	Parent namespace Group object (Name & Description) Change List ID	yes	createGroupResult (Boolean) Group namespace	Creates the group and returns the namespace of the tag created.
MaintainTag	Tag object Change List ID	yes	updateTagResult (Boolean)	Updates the tag and returns a Boolean to indicate whether the update was successful or not.
MaintainGroup	Group object Change List ID	yes	updateGroupResult (Boolean)	Updates the group and returns a Boolean to indicate whether the update was successful or not.
DeleteTag	Tag namespace Change List ID	yes	deleteTagResult (Boolean)	Deletes the tag and returns a Boolean to indicate whether the delete was successful or not.
DeleteGroup	Tag namespace Change List ID	yes	deleteGroupResult (Boolean)	Deletes the group and returns a Boolean to indicate whether the delete was successful or not.
GetPropertyValue	tagNamespace propertyname	Both	List of TagProp objects	List of properties matching the parameters
DeleteProperties	namespace changeListId List of propertySets List of customProperties	Yes	deletePropertiesResult (Boolean)	Deletes the properties that match the input parameters. The properties can either be properties under property set or any custom property
addProperties	; changeListId; List of propertySets; List of customProperties; namespace changeListId List of propertySets List of customProperties	Yes	addPropertiesResult (Boolean)	Adds properties to the tag. The properties can either be properties under property set or any custom property
GetTagDetails	Tag Name Namespace	Any one of the parameter is mandatory.	Tag object	The details of a tag along with the properties are returned. Returns the first occurrence of the group if namespace is not provided.
GetGroupdetails	groupName groupNamespace	Any one of the parameter is mandatory	Group object	Group object
SearchTags	Namespace Tag Name Search Keyword PropertySets Properties PropertyType Inactive Tags Description LastChangedSince CreatedSince		List of tag objects	List of tags matching the search criteria with all details. Note The parameter InactiveTags must be set to False to facilitate search tags. When set to True, the search criteria returns only the list of inactive tags. End of the note.
SearchGroups	CategoryLevel GroupName Namespace searchKeyword Description LastChangedSince CreatedSince		List of group objects	List of groups matching the search criteria with all details.
BrowseGroups	Group Name Namespace of the group	Any one of the parameter.	List of object Group	Lists all the groups along with their description that are under the selected group. Returns all the groups under Root if there are no input parameters. Returns the first occurrence of the group if namespace is not provided.
BrowseTags	Group Name Namespace of the group	Any one of the parameter.	List of object Tag	List of tags under the specified tag with details (such as Data Server Name, Alias, and Description) are returned. Returns all the tags under Root if there are no input parameters. Returns the tags under the first occurrence of the group if namespace is not provided.

Change Lists Services

Operation	Input Parameters	Mandatory Parameters	Output Parameters	Description
CreateChangeList	Change List Name Change List Description	Yes No	Change List Object	Creates a new change list and returns the change list object upon successful creation.
SearchChangeLists	Change List Name Change List status isDefault userID created From created To	No	List of Change List Objects	Returns the list of change lists that match the user query. Returns all the change list if there are no input parameters. Note If there are no inputs to SearchChangeLists operation, the following checks are performed: If the user has change list admin rights, then change lists of all users are returned If the user has only tag catalog Read rights, then change lists are returned for that user. End of the note.
ApplyChanges	Nil	NA	Boolean: Success	Applies the changes to the active version and returns Boolean indicating the status of operation.
MaintainChangeListStatus	ChangeListID Status Open Submit Approve Reject Close ChangeListID	ChangeListID	Boolean: Success	Maintains the status of the change list.
ResetObjects	ChangeListID GroupList TagList	ChangeListID	Boolean: Success	Resets objects associated with the change list at the line level

Property Set Sevices

Operation	Input Parameters	Mandatory Parameters	Output Parameters	Description
Get Property Sets	Property Set Name Property Set Description	None	List of Property Set Objects with all properties	Gets all the property sets based on your input
Create Property Set	Property Set Name Property Set Description Property Name Property Value Property Description	Property Set Name Property Name & Value (if property has to be added)	Boolean (true or false)	Creates a property set based on your input.
Edit Property Set	Property Set Name Property Set Description Property Name Property Value Property Description Change List Id	Property Set Name Change List Id	Boolean (true or false)	Edits a property set based on your input.
Delete Property Set	Property Set Name	Property Set Name	Boolean (true or false)	Deletes a property set.