Master Data Management with webMethods OneData : Working with webMethods OneData MDR : OneData MDR APIs : OneData-Registry Specific API functions : getClassificationSchemeItemHierarchyByName
getClassificationSchemeItemHierarchyByName
This incorporates three functions called from the web services or API interface:
a) getClassificationSchemeItemHierarchyByName (web service)
b) getClassificationSchemeItemHierarchyXMLByName (API)
c) getClassificationSchemeItemHierarchyRowSetByName (API)
Function returns the entire classification scheme item hierarchy for the specified Classification Scheme Item name or every top-level classification scheme item under the specified Classification Scheme Name. Optionally it also includes the Administered items linked to each Classification Scheme Item.
The following logic is used to retrieve the hierarchy, based on the parameter provided:
*If only ClassificationSchemeName is provided, then the service returns all the Classification Scheme Item hierarchies that match the search criteria for the Classification Schemes.
*If only ClassificationSchemeItemName is provided, then the service returns all the Classification Scheme Item hierarchies whose top-level Classification Scheme Items satisfy the search criterion. This search is done across all Classification Schemes.
*If both ClassificationSchemeItemName and ClassificationSchemeName are provided, then the service returns all the Classification Scheme Item hierarchies whose top-level Classification Scheme Items satisfy the search criterion. This search is further restricted to the Classification Schemes satisfying the search criterion.
Input Parameters
Repository
String If not provided, defaults to the first repository in the list of available repositories. Case sensitive.
User Id
String Required if service layer security is enabled. Login ID in the application of the user calling this function.
Password
String Required if service layer security is enabled.
Client Id
String Required. Client ID of the repository.
Project Id
String Required. ID of the project.
Schema Id
String Required. Indicates the schema. If workflow is licensed, then Schema Id is 2.
*1.   Work area
*2.   Release area
Classification Scheme Name
String Required if Classification Scheme Item Name is not provided. Classification scheme name or partial name on which to filter.
Context
String Context name as in the registry. If Context is specified, search for Preferred or Alternates Name only within that context.
Name Column
String Name of column on which to filter for administered name. OneData does not perform a search on alternate names. Not required if the search for the name is on the standard column.
Classification Scheme Item Name
String Required if Classification Scheme Name is not provided. Full or partial name of the classification scheme item.
Exclude Audit Columns
String Required. Indicates whether to include audit columns in the output. Does not apply to getAdministeredItemListRowSetByName.
*True.    Excludes audit columns in the output.
*False.  Includes audit columns in the output.
Include Administered Items
String If set to true then the Administered Items linked to each Classification Scheme Item are included in the output.
Copyright © 2011-2017 Software AG, Darmstadt, Germany. (Innovation Release)
Product LogoContact Support   |   Community   |   Feedback