webMethods Integration Cloud and Cloud Deployment Documentation 6.0.0 | webMethods Integration Cloud | SOAP APIs | Creating SOAP APIs from scratch
 
Creating SOAP APIs from scratch
When you create a SOAP API from scratch, you select one or more Integrations to use as operations. The operation signature becomes the input and output messages for the operations in the WSDL document. However, Integration Cloud allows constructs within operation signatures that cannot be represented in certain web service use/style combinations. When adding an Integration to or creating a SOAP API from scratch, Integration Cloud verifies that the operation signature can be represented in the use/style specified for the SOAP API. If an operation signature does not meet the use/style signature requirements, Integration Cloud will not add the Integration as an operation. Or, in the case of creating a SOAP API from scratch, Integration Cloud will not create the SOAP API.
Following is a list of operation signature restrictions and requirements for each use/style. Note that this list may not be exhaustive.
Signature Restrictions for Document - Literal
*body fields are not allowed at the top level
@attribute fields (fields starting with the “@” symbol) are not allowed at the top level
String table fields are not allowed
Signature Restrictions for RPC - Literal
*body fields are not allowed at the top level
@attribute fields (fields starting with the “@” symbol) are not allowed at the top level
String table fields are not allowed
List fields (String List, Document List, Document Reference List, and Object List) are not allowed at the top level
Duplicate field names (identically named fields) are not allowed at the top level
Top-level fields cannot be namespace qualified
Top-level field names cannot be in the format prefix:localName
Signature Restrictions for RPC - Encoded
* body fields are not allowed
@attribute fields are not allowed (fields starting with the “@” symbol)
Top-level fields cannot be namespace qualified
Top-level field names cannot be in the format prefix:localName
* To create a SOAP API from scratch
1. From the Integration Cloud navigation bar, click Projects > <Select a Project> > SOAP APIs.
The SOAP APIs page appears.
2. From the SOAP APIs page, click Add New SOAP API, select Build from scratch, and then click OK.
3. Complete the following fields and click Save.
The new SOAP API appears in the SOAP APIs page.
Field
Description
Name
Type a name for the SOAP API using any combination of letters, numbers, and/or underscore character.
SOAP Version
Whether SOAP messages for this SOAP API should use SOAP 1.1 or SOAP 1.2 message format.
Select Integration
Select the Integration to use as an operation. The operation signature becomes the input and output messages for the operation in the WSDL document.
Use and style for operations
A WSDL document describes a web service and a WSDL binding describes how the service is bound to a SOAP messaging protocol. A WSDL SOAP binding can be either a document style binding or a Remote Procedure Call (RPC) style binding. A SOAP binding can also have a literal or an encoded use.
Select the use/style for operations in the SOAP API:
*Document - Literal
*RPC - Literal
*RPC - Encoded
Enforce WS-I Basic Profile 1.1 compliance
Select this option if you want Integration Cloud to validate all the SOAP API objects and properties against the WS-I requirements before creating the SOAP API.
Validate schema using Xerces
Integration Cloud automatically uses an internal schema parser to validate the schemas associated with the XML Schema definition. Select this option if you want Integration Cloud to also use the Xerces parser to validate the schemas associated with the XML Schema definition. However, the Xerces parser provides stricter validation. As a result, some schemas that the internal schema parser considers to be valid might be considered invalid by the Xerces parser.
Attachment Enabled
The Attachment Enabled option is displayed when you edit the SOAP API. If attachments are enabled for the SOAP API, instances of XML-type base64Binary are transported using MIME attachments, which improves the performance of large binary payload transport. Integration Cloud supports SOAP attachments only for SOAP APIs that specify style/use of RPC-Literal or Document-Literal.
4. Click Save.
The Integration becomes an operation in the SOAP API. Integration Cloud uses the existing operation signature as the input and output messages for the operation. You can add operations to a SOAP API created from scratch.
5. To add operations, on the Operations page, click Add New Operation.
The Add New Operation dialog box appears.
6. In the Add New Operation dialog box, type a name for the WSDL operation, select an Integration, and then click Add.
The new operation appears on the Operations page. Using a SOAP client, you can invoke the SOAP operation externally by using either Basic Authentication or 2-way SSL. When the SOAP operation is invoked, the associated Integration gets executed.
Copyright © 2014- 2019 | 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.