Master Data Management with webMethods OneData : Working with webMethods OneData MDR : OneData MDR APIs : OneData-Registry Specific API functions : getAdministeredItemSummarybyName
getAdministeredItemSummarybyName
This service incorporates three functions called from the web services or API interface for ISO/IEC Registry template.
a) getAdministeredItemSummaryByName (web service)
b) getAdministeredItemSummaryXMLByName (API)
c) getAdministeredItemSummaryRowSetByName (API)
Function returns a list of administered items and their details based on the name filter specified. Item type specific information is also returned. No data about the child entities is provided.
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
Item Type ID
String List Required. Must correspond to the Item Type List in OneData-Registry.
Name
String Required. Name or partial name on which to filter.
Context
String Optional. Context name as in the registry. If context is specified, search for Preferred or Alternates Name only within that context.
Name Column
String Optional. Name of column on which the 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.
Exclude Audit Columns
String Required. Indicates whether to include audit columns in the output. Does not apply for getAdministeredItemSummaryRowSetByName.
*True.    Excludes audit columns in the output.
*False.  Includes audit columns in the output.
Additional Filter Criteria
String Optional. To be provided if any additional filter condition is required.
Ouput Parameters
getAdministeredItemSummaryByName and getAdministeredItemSummaryXMLByName returns XML. getAdministeredItemSummaryRowSetByName returns a rowset with the same information as the other two functions.
Copyright © 2011-2017 Software AG, Darmstadt, Germany. (Innovation Release)

Product LogoContact Support   |   Community   |   Feedback