webMethods, OneData, and Terracotta  10.2 | Managing Master Data with webMethods OneData | Developing for webMethods OneData | API Functions and Web Services in OneData | Generic API Functions | getStructure
 
getStructure
This function returns structure information about the entity or table whose name is provided. The function accepts input as XML and returns XML string as output.
The structure of the input XML is as follows:
<?xml version="1.0" encoding="UTF-8"?>
<ONEDATA_REQUEST>
<REPOSITORYID></REPOSITORYID>
<ENTITYNAME></ENTITYNAME>
<TABLENAME></TABLENAME>
<CLIENTID></CLIENTID>
<PROJECTID> </PROJECTID>
<SCHEMAID> </SCHEMAID>
<USERID></USERID>
<PASSWORD></PASSWORD>
</ONEDATA_REQUEST>
Input XML Tags
REPOSITORYID
Optional. ID of the repository in which the entity or table resides. If you do not provide the ID, the ID of the first repository from the list of available repositories is used by default. This tag is case sensitive.
ENTITYNAME
Optional. Logical name of the object in OneData. (Required if TABLENAME is not provided).
TABLENAME
Optional. Physical table name in the database. (Required if ENTITYNAME is not provided).
CLIENTID
Optional. Client ID if more than one client is defined in the metadata.
PROJECTID
Optional. Project ID if more than one project is defined for the client in the metadata.
SCHEMAID
Optional. Determines whether the data is retrieved from the work area or the release area where there is a dual schema landscape.

USERID
PASSWORD
Optional. ID and service layer security password of the user calling this web service. Required if service layer security is enabled.
For more information about the service layer security password, see Retrieving Password for Service Layer Security.
Copyright © 2011-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release