SOAP Data Tables with Web Services 2.0

This topic discusses Web Services 2.0. For information on Web Services 1.0, see Web Services 1.0.

Overview

You can generate a skeleton input for each operation in the Data Tables WSDL, which contains the following operations:

get
add
modify
update
delete
deploy

For each operation, the following fields are always required in the header:

UsernameToken
- Username
- Password Type
category: Security
schemaLocation

Data Tables SOAP API Details

For all APIs, the Failure Response Variables are exceptionCode and exceptionMessage.

API	Description	Required Input Variable	Success Response Variables
get	Returns a specified record in the criteria from the selected Data Table. You can only retrieve 300 rows at a time using a 'get' call on a Data Table.	category schemaLocation table_name field value comparator	status success message Data Tables each_record table_name
add	Adds a record to a Data Table.	category schemaLocation table_name Rows that need to be added Example <bm:each_record> <bm:currencyCode>USD</bm:CurrencyCode> <!--currencyCode is a column in the table--> <bm:conversionRate>1.0</bm:conversionRate> <!--conversionRate is a column in the table --> </bm:each_record>	status success message
modify	The "modify" action will insert or update a data table row based on the actual Id of the row, whether that is the Natural Key or the row Id. When a Natural Key or row Id is provided the row will be updated; otherwise, a new row will be inserted into the data table.	category schemaLocation table_name Rows that need to be inserted or modified	status success message
		Update Example <urn:modify> <urn:DataTables urn:table_name="SOAPSingleKey"> <urn:each_record> <urn:StringIndexKey>CPQCS-72139</urn:StringIndexKey> <urn:Int>2</urn:Int> <urn:Flo>2.0</urn:Flo> </urn:each_record> </urn:DataTables> </urn:modify>	<bm:modifyResponse xmlns:bm="urn:soap.bigmachines.com"> <bm:status> <bm:success>true</bm:success> <bm:message>Fri Jul 28 09:52:24 PDT 2017 - Successfully processed API for slc13kwz</bm:message> <bm:records_read>1</bm:records_read> <bm:records_failed>0</bm:records_failed> <bm:records_deleted>0</bm:records_deleted> <bm:records_inserted>0</bm:records_inserted> <bm:records_updated>1</bm:records_updated> </bm:status> </bm:modifyResponse>
		Insert Example <urn:modify> <urn:DataTables urn:table_name="Table4SOAP"> <urn:each_record> <urn:State>CPQCS-72136</urn:State><urn:TranslatedState>Translation</urn:TranslatedState> <urn:Freight>72136</urn:Freight> <urn:Tax>0.0</urn:Tax> </urn:each_record> </urn:DataTables> </urn:modify>	<bm:modifyResponse xmlns:bm="urn:soap.bigmachines.com"> <bm:status> <bm:success>true</bm:success> <bm:message>Fri Jul 28 09:50:21 PDT 2017 - Successfully processed API for slc13kwz</bm:message> <bm:records_read>1</bm:records_read> <bm:records_failed>0</bm:records_failed> <bm:records_deleted>0</bm:records_deleted> <bm:records_inserted>1</bm:records_inserted> <bm:records_updated>0</bm:records_updated> </bm:status> </bm:modifyResponse>
update	Adds an existing record in a given Data Table. If you performing an update and your natural keys do not match, it will result in an error message.	category schemaLocation table_name Rows that need to be updated	status success message
delete	Deletes a record in a given Data Table.	category schemaLocation table_name field value comparator	status success message
deploy	Deploys a given Data Table and adds an entry in the script table about the selected Data Table.	category schemaLocation table_name	status success message

Supported Basic SQL Standard Comparators

Comparator	Notes
<	Less than
>	Greater than
=	Equals
!=	Not Equals. With CDATA tags, we can use <>
Like	Use for string fields.
In	Use for locating numeric data
Where Clause

Administration

Accessing Data Tables WSDL and Generating Skeleton Input

Header Information for Web Services 2.0

For each API, the body of the SOAP XML is the same as it was for Web Services 1.0. This is the information contained between the <soapenv:Body> and </soapenv:Body> tags.

The header, contained between the <soapenv:Header> and </soapenv:Header> header, has changed with Web Services 2.0.

Comment	Header: Web Services 1.0	Header: Web Services 2.0
No change	<soapenv:Header>	<soapenv:Header>
New tags		<wsse:Security xmlns:wsse= "http://docs.oasis-open.org/wss/2004/ 01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
New user information replaces sessionId	<bm:userInfo . . . > <bm:sessionId> . . . . . </bm:sessionId> </bm:userInfo>	<wsse:UsernameToken wsu:Id="UsernameToken-2"> <wsse:Username/><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"/> </wsse:UsernameToken>
This is now in the URL, with the unique end point specified.	<bm:category xmlns:bm="urn:soap.bigmachines.com"> Commerce </bm:category>	Now reflected in the SOAP Server URL field.
No longer needed	<bm:xsdInfo . . . . . </bm:xsdInfo>
Ending the new authentication		</wsse:Security>
No change	</soapenv:Header>	</soapenv:Header>