webMethods, OneData, and Terracotta  10.2 | Managing Master Data with webMethods OneData | Developing for webMethods OneData | API Functions and Web Services in OneData | Read-Write Web Services | Mandatory Tags
 
Mandatory Tags
A mandatory field indicates that the tag must exist in the correct order in the tag hierarchy within the input XML. Failing to specify this tag may result in the service failing. A mandatory tag may be skipped if the parent tag is optional and is omitted. For example, in the structure where the GET_STRUCTURE element is optional and the child tag, NAME, is mandatory, if GET_STRUCTURE is omitted, NAME can also be omitted because it is only required if the parent GET_STRUCTURE tag exists.
The following table shows the input tag specifications for the OD_REQUEST parameter, which is mandatory.
Input Tags
The order of the input tags is as follows:
<OD_REQUEST>
<USER_ID>
<PASSWORD>
<REPOSITORY_ID>
<GET_STRUCTURE>
<NAME>
<INSERT>
<OBJECT>
<NAME>
<ROWS>
<ROW>
<COLUMN>
<NAME>
<VALUE>
<UPDATE>
<OBJECT>
<NAME>
<ROWS>
<ROW>
<COLUMN>
<NAME>
<VALUE>
<FILTER_LIST>
<ROW>
<CONDITION>
<NAME>
<VALUE>
<DELETE or RESTORE or PURGE>
<OBJECT>
<NAME>
<FILTER_LIST>
<ROW>
<CONDITION>
<NAME>
<VALUE>
<SELECT>
<OBJECT>
<NAME>
<ROW_START_COUNT>
<ROW_MAX_COUNT>
<FILTER_LIST>
<ROW>
<CONDITION>
<NAME>
<VALUE>
Parameter
Description
OD_REQUEST
Root tag.

USER_ID
PASSWORD
User ID and hashed password used for login.
REPOSITORY_ID
Repository in which the object resides.
GET_STRUCTURE
Structure of the entities defined in the NAME sub tag. If valid object names are not specified in the NAME tags, no structure will be returned. You can specify multiple NAME tags in this tag. Optional.
Includes the following sub-element.
NAME. Name of the object. Mandatory.
INSERT
Action wrapper tag to perform single or multiple row inserts. Optional. If this parameter is provided, all sub-elements are mandatory. You can specify the following sub-elements:
OBJECT. Object action wrapper. Mandatory.
*NAME. Name of the object. Mandatory.
*ROWS. Wrapper for ROW. Can include multiple ROW tags. Mandatory.
*ROW. Row of data in an object. You can define multiple columns. Mandatory.
*COLUMN. Represents a column of a row in an object. Mandatory.
NAME. Column name. Mandatory.
VALUE. Column value. For the date column type, use the format MM-DD-YYYY (for example, 12-31-2009). For the timestamp column type, use the format MM-DD-YYYY HH:MM:SS (for example, 12-31-2009 02:12:23). Formats follow the Java date format conventions. Mandatory.
UPDATE
Action wrapper tag to perform single or multiple column updates. Mandatory.
OBJECT. Object action wrapper. Mandatory.
*NAME. Name of the object. Mandatory.
*ROWS: Wrapper for ROW. Only a single ROW tag is allowed inside. Mandatory.
*ROW. Row of data in an object. You can define multiple columns. Mandatory.
*COLUMN. Represents a column of a row in an object. Mandatory.
NAME. Column name. Mandatory.
VALUE. Column value. For the date column type, use the format MM-DD-YYYY (for example, 12-31-2009). For the timestamp column type, use the format MM-DD-YYYY HH:MM:SS (for example, 12-31-2009 02:12:23). Formats follow the Java date format conventions. Mandatory.
*FILTER LIST. Wrapper tag for filter condition. Optional.
*ROW. Only one nested CONDITION tag is currently permitted. Mandatory.
*CONDITION. AND is the default operator between conditions. The default operator between the filter values is EQUALS. Only one element allowed. Mandatory.
NAME. Column name. Mandatory.
VALUE. Column value. For the date column type, use the format MM-DD-YYYY (for example, 12-31-2009). For the timestamp column type, use the format MM-DD-YYYY HH:MM:SS (for example, 12-31-2009 02:12:23). Formats follow the Java date format conventions. Mandatory.

DELETE
RESTORE
PURGE
Single or multiple row delete, restore, or purge based on the filter condition or all rows. Optional.
Note: All these operations use the same sub tag structure, but they should be specified separately.
OBJECT. Object action wrapper. Mandatory.
*NAME. Name of the object. Mandatory.
*FILTER LIST. Wrapper tag for filter condition. Optional.
*ROW. Row of data in an object. Only one CONDITION tag is allowed. Mandatory.
*CONDITION. AND is the default operator between conditions. The default operator between the filter values is EQUALS. Only one element allowed. Mandatory.
NAME. Column name. Mandatory
VALUE. Column value. For the date column type, use the format MM-DD-YYYY (for example, 12-31-2009). For the timestamp column type, use the format MM-DD-YYYY HH:MM:SS (for example, 12-31-2009 02:12:23). Formats follow the Java date format conventions. Mandatory.
SELECT
Single or multiple row select based on the filter condition or all rows. Optional.
OBJECT. Object action wrapper. Mandatory.
*NAME. Name of the object. Mandatory.
*ROW_START_COUNT. The counter start value, for example, if set to 101, rows starting from the 101st row to the next 'n' rows are returned as part of the result, where 'n' is the maximum number of rows that can be returned, defined by the ROW_MAX_COUNT tag. Default value is 1. Accepts values > 0. Optional.
*ROW_MAX_COUNT. Maximum number of rows to return for this object. The valid value range is 1-1000. The default upper limit value is 1000. Optional.
*FILTER LIST. Wrapper tag for filter condition. Optional.
*ROW. Row of data in an object. Only one CONDITION tag is allowed. Mandatory.
*CONDITION. AND is the default operator between conditions. The default operator between the filter values is 'EQUALS. Only one element allowed. Mandatory.
NAME. Column name. Mandatory.
VALUE. Column value. For the date column type, use the format MM-DD-YYYY (for example, 12-31-2009). For the timestamp column type, use the format MM-DD-YYYY HH:MM:SS (for example, 12-31-2009 02:12:23). Formats follow the Java date format conventions. Mandatory.
Output XML Specification
The reference output XML structure specification for reading the output from the web service response is listed below.
<OD_RESPONSE>
<GET_STRUCTURE>
<OBJECT>
<NAME>
<COLUMNS>
<COLUMN>
<NAME>
<TYPE>
<IS_PK>
<EDITABLE>
<READABLE>
<INSERT or UPDATE or DELETE or RESTORE or PURGE>
<OBJECT>
<NAME>
<ROWCOUNT>
<MESSAGE>
<SELECT>
<OBJECT>
<NAME>
<ROWCOUNT>
<MESSAGE>
<DATA>
<ROW>
<COLUMN>
<NAME>
<VALUE>
In the table below, “optional” indicates that the tag may or may not be present in the response XML. The presence of optional tags is controlled by the input XML request. If the parent of a mandatory tag is present, the mandatory tag is included in the response message. For example, if the INSERT tag was not specified in the input XML, no insert operations occurred and the response XML does not contain INSERT or any of its child element tags.
Parameter
Description
OD_RESPONSE
Root tag.
GET_STRUCTURE
Wrapper for the object. Optional. Includes the following child elements.
OBJECT. Object wrapper.
*NAME. Name of the object. Mandatory.
*COLUMNS. Wrapper for COLUMN. Mandatory.
*COLUMN. Represents a column in the object. Mandatory.
*NAME. Name of the column. Mandatory.
*TYPE. Data type of the column. Valid values are BOOLEAN, CHAR, DATE, FILETYPE, NUMERIC, PERCENTAGE, STRING, and TIMESTAMP. Mandatory.
*IS_PK. Whether the column is part of a primary key constraint. Can be TRUE or FALSE. Mandatory.
*EDITABLE. Whether the column is editable. Can be TRUE or FALSE.
*READABLE. Whether the column is readable. Can be TRUE or FALSE.
INSERT
DELETE
RESTORE
PURGE
If multiple actions are performed, multiple actions tags are generated. Each tag can have multiple OBJECT elements.
OBJECT. Object action wrapper. Mandatory.
*NAME. Name of the object. Mandatory.
*ROWCOUNT. Number of rows inserted, updated, deleted, restored, or purged. Mandatory.
*MESSAGE. Success message. Optional.
SELECT
Single or multiple row select based on the filter condition or all rows. Optional.
OBJECT Object action wrapper. Mandatory.
*NAME. Name of the object. Mandatory.
*ROWCOUNT. Number of rows selected. Mandatory.
*MESSAGE. Success message. Optional.
*DATA. Wrapper tag for filter condition. Optional.
The DATA element requires the following tags:
*ROW. Row of data in an object. Only one CONDITION tag is allowed. Mandatory.
*COLUMN. Column corresponding to the row.
*NAME. Column name. Mandatory.
*VALUE. Column value. For the date column type, use the format MM-DD-YYYY (for example, 12-31-2009). For the timestamp column type, use the format MM-DD-YYYY HH:MM:SS (for example, 12-31-2009 02:12:23). Formats follow the Java date format conventions. Mandatory.
Types of Web Services
Read Write web service is available in OneData through REST web services. For more details, see REST Web Services
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