SOA Gateway SOAP Reference for Resource Access

list

The list operation returns a list of records or rows from your data source.

The data returned can be limited or restricted by providing key information.

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

• Key data

  Key data must be entered for at least one of the fields defined as a key.

  Refer to the section Specifying Key Data for more information.

• Options

  None

The result will be either :

• an XML document wrapped in a SOAP message and containing the requested data

• a SOAP fault message

select

The select operation returns a list of records or rows from your data source. The maximum number of rows/records returned can be set via the SOA Gateway Control Center.

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

The data returned can be limited or restricted by providing key information. The select operation extends the capability of the list operation by enabling searches on a larger set of criteria.

The key information for a select is wrapped in a condition block and can be repeated several times within that block. Each key entry represents an 'AND' condition. Condition blocks can also be repeated several times. Each condition block represents an 'OR' condition. The condition block accepts the following specifiers:

• Less than a specific value (LT).

• Less than or equal to a specific value (LE).

• Equal to a specific value (EQ).

• Greater than a specific value (GT).

• Greater than or equal to a specific value (GE).

• Not equal to a specific value (NE).

• Starting with a specific value (START). Character based fields only.

• Ending with a specific value (ENDS). Character based fields only.

• Containing a specific value (CONTAINS). Character based fields only.

<soapenv:Body>
  <cus:customerinformationGroupSelectElement>
	   <condition>
	     <CustomerNumber Condition="GE">40</CustomerNumber>
	     <CustomerNumber Condition="LT">50</CustomerNumber>
	   </condition>
	   <condition>
	     <CustomerNumber Condition="EQ">59</CustomerNumber>
   	</condition>
	   <condition>
	     <CustomerNumber Condition="EQ">61</CustomerNumber>
   	</condition>
  </cus:customerinformationGroupSelectElement>
 </soapenv:Body>

The example above specifies 3 condition blocks. This will return data where the (CustomerNumber >= 40 and CustomerNumber <= 50) or CustomerNumber = 59 or CustomerNumber = 61

• Key data

  Key data must be entered for at least one of the fields defined as a key.

  Refer to the section Specifying Key Data for more information.

• Options

  None

The result will be either :

• an XML document wrapped in a SOAP message and containing the requested data

• a SOAP fault message

selectNext

The selectNext operation returns a list of records or rows from your data source. A selectNext operation may only be called following a select and subsequently other selectNext calls. For this functionality the initial select operation has to initiate a new Conversation. See Conversational Processing. The resultant conversation id must be passed in any associated selectNext calls. selectNext calls may be issued until end of file is reached or may be terminated by a selectEnd call. The maximum number of rows/records will be that set for set via the Soa Gateway Control Center.

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

There is no key information for a selectNext operation as this will have been passed in by the initiating select operation.

• Key data

  None

• Options

  None

The result will be either :

• an XML document wrapped in a SOAP message and containing the requested data

• a SOAP fault message

selectEnd

The selectEnd operation terminates a sequence of select and/or selectNext calls with a conversation. A selectEnd operation may only be called following select or selectNext operations. For this functionality the select operation has to initiate a new Conversation. The resultant conversation id must be passed in the selectEnd call.

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

There is no key information for a selectEnd operation as this will have been passed by the initiating select operation.

• Key data

  None

• Options

  None

The result will be either :

• an XML document wrapped in a SOAP message containing an acknowledgement that the operation was successful

• a SOAP fault message

selectCount

The selectCount operation returns a count of the records or rows that match the criteria set in the condition block(s).

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

The selectCount operation is identical to that of the select operation in terms of its search capabilities.

The key information for a selectCount is wrapped in a condition block and can be repeated several times within that block. Each key entry represents an 'AND' condition. Condition blocks can also be repeated several times. Each condition block represents an 'OR' condition. The condition block accepts the following specifiers:

• Less than a specific value (LT).

• Less than or equal to a specific value (LE).

• Equal to a specific value (EQ).

• Greater than a specific value (GT).

• Greater than or equal to a specific value (GE).

• Not equal to a specific value (NE).

• Starting with a specific value (START). Character based fields only.

• Ending with a specific value (ENDS). Character based fields only.

• Containing a specific value (CONTAINS). Character based fields only.

• Key data

  Key data must be entered for at least one of the fields defined as a key.

  Refer to the section Specifying Key Data for more information.

• Options

  None

The result will be either :

• an XML document wrapped in a SOAP message and containing the number of records/rows satisfying the search criteria

• a SOAP fault message

get

The get operation returns a single record or row from your data source.

The data returned is specified by providing unique key information identifying a single record / row.

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

• Key Data

  Key data must be entered for at least one of the fields defined as a primary key field, so that a single record can be identified.

  Refer to the section Specifying Key Data for more information.

• Options

  None

The result will be either :

• an XML document wrapped in a SOAP message and containing the requested data

• a SOAP fault message

add

The add operation adds a single record or row of data to your data source.

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

• Add Data

  Provide values for each of the fields defined. These are the fields / columns of the data on your data source.

  You must add data for at least one of the fields specified as being primary key fields.

  Refer to the section Specifying Key Data for more information.

• Options

  None

The result will be either :

• a SOAP message indicating the operation succeeded

• a SOAP fault message

update

The update operation updates a single record or row of data.

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

• Update Data

  Provide values for each of the fields defined. These are the fields / columns of the data on your data source.

  Key data must be entered for at least one of the fields defined as a primary key field.

  Refer to the section Specifying Key Data for more information.

  Others fields may be left empty if you do not wish to change their value.

• Options

  None

The result will be either :

• a SOAP message indicating the operation succeeded

• a SOAP fault message

delete

The delete operation deletes a single record or row of data from the data source.

This operation will only be available when the web service is a "database" type, for example, Adabas or MySQL

• Key Data

  Key data must be entered for at least one of the fields defined as a primary key field, so that a single record can be identified.

  Refer to the section Specifying Key Data for more information.

• Options

  None

The result will be either :

• a SOAP message indicating the operation succeeded

• a SOAP fault message

invoke

The invoke operation makes a call to a function or program.

This operation will only be available when the web service is a "program" type, for example, NATURAL, COBOL or when the web service describes a database stored procedure.

• Parameters

  Each of the fields defined can be input, output, or input+output.

  Provide values for each of the fields defined as input or input+output. These match the function/program parameters that are required on the call.

The result will be either :

• a SOAP message return the results of the program/function invoked

• a SOAP fault message

A new conversation is being started. In this case, the ConversationID ( see below) value must by NULL or an error will occur.

An existing conversation is active with which the current SOAP message should be associated. When the SOAP request is processed, the conversation must remain active as there are further SOAP requests to be sent. The ConversationID found must have been returned as a result of a previous 'new' request.

An error will occur if the ConversationId ( see below ) provided cannot be found.

An existing conversation is active with which the current SOAP message should be associated. When the SOAP request is processed, the conversation must be terminated. The ConversationID ( see below ) found must have been returned as a result of a previous 'new' request.

An error will occur if the ConversationId provided cannot be found.

A new transaction is being started.

If no conversation will exist after this request, an error will result.

If the request is part of an existing conversation, and this conversation already has a transaction associated with it, this will also be rejected as an error.

An existing transaction is active with which the current SOAP message should be associated.

If no conversation exists for the SOAP request, or no conversation will exist after the SOAP request, an error will result.

If no transaction is active and associated with the current conversation, an error will result.

This will cause a commit to be issued when the current SOAP message has been processed.

If no conversation existed previously for this SOAP request, a new transaction will be started.

If a conversation does exist for this SOAP request, any updates made as a result of the previous SOAP requests will be committed.

When returned in the SOAP response, it indicates that the transaction has been committed.

This will cause a backout to be issued when the current SOAP message has been processed.

If a conversation does exist for this SOAP request, any updates made as a result of the previous SOAP requests will be backed out.

If no conversation existed previously for this SOAP request, an error will result.

When returned in the SOAP response, it indicates that the transaction has been backed out.

On a GET operation an ISN (Adabas Internal Sequence Number) can be used in lieu of a primary key to retrieve a record.

In addition to the specification of key data this header option can be used to further limit the result set by setting a starting ISN for LIST and SELECT operations.

Specify an "A" (the default) for ascending retrieval, a "D" for descending.

The result set can be sorted by up to three fields. Specify their XML names, comma separated, with this header option

The password required to access an Adabas file secured with ADASCR (Adabas Security). This password is different from that in the global "soap security" section.

Limit the number of records to be retrieved by a "multifetched" operation (LIST or SELECT / SELECTNEXT) with a single call to Adabas.