Overview
You can generate a skeleton input for each operation in the Configuration WSDL, which contains the following operations:
- configure
- getBom
- getConfigurations
- getPrice
- getSpare
- deploy
For each operation, the following fields are always required in the header:
-
UsernameToken
- Username
- Password Type
- category: Security
- schemaLocation
For all SOAP APIs, the Failure Response Variables are exceptionCode and exceptionMessage.
| SOAP API | Description | Required Input Variables | Success Response Variables |
|---|---|---|---|
|
configure
|
Takes input of a particular product family, line, and model and generates a configuration. The response changes based on the options specified. For example, if SOAP XML mandates generating a transaction for the given configuration, then a transaction of the specified process is included in the response. Similarly, other details can be chosen to be included or not included in the response. The document_number attribute determines whether configure or reconfigure operations are invoked.
|
|
|
|
If "responseIncludes" is set to "true", the following items are returned: |
|
||
|
|
||
|
getBom |
Returns the BOM for the model. |
|
status
item
attributes flow bom
|
|
getConfigurations |
This operation is used to return configuration data that is saved for a client-side integration. This operation is not supported for multi-node configurations.
|
|
|
|
If "responseIncludes" is set to "true", the following items are returned: |
|
||
|
|
||
|
Optional input variables
|
|
||
|
getPrice |
Return the base price of the model. |
|
status
item
attributes flow price
|
|
getSpare |
Returns the recommended items for the model. |
|
status
item
attributes flow spare
|
|
deploy |
Deploys a specific product family. |
|
status
|
Administration
Accessing the Configuration WSDL and Generating Skeleton Input
- Click Admin to go to the Admin Home Page.
-
Click Web Services in the Integration Platform section.
The Web Services Test page opens.
- Confirm that the Web Service Version is 2.0.
- Click the Configuration tab.
- Select an API from the drop-down.
- Select one of the following:
- Punchin URL and enter the URL
- Product Family and choose the Product Family, Product Line, and Model from the corresponding drop-downs.
-
Click Generate Input to retrieve the skeleton.
For more information on the body of the Configuration Web Service, and for code examples, see the topic SOAP Configuration API with Web Services 1.0. With the exception of the header, the Web Services 1.0 code examples are valid in Web Services 2.0.
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.
| 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/ |
|
| New user information replaces sessionId |
<bm:userInfo . . . >
</bm:userInfo> |
<wsse:UsernameToken wsu:Id="UsernameToken-2">
</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> |
