<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head profile="http://internetalchemy.org/2003/02/profile"> <link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" /> <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" /> <meta name="dc.title" content="Function: uddi_save_business - Virtuoso Functions Guide" /> <meta name="dc.subject" content="Function: uddi_save_business - Virtuoso Functions Guide" /> <meta name="dc.creator" content="OpenLink Software Documentation Team ; " /> <meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" /> <link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" /> <link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" /> <link rel="parent" href="functions.html" title="Chapter Contents" /> <link rel="prev" href="appendixa.html" title="Appendix" /> <link rel="next" href="functions.html#.html" title="" /> <link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" /> <link rel="stylesheet" type="text/css" href="doc.css" /> <link rel="stylesheet" type="text/css" href="/doc/translation.css" /> <title>Function: uddi_save_business - Virtuoso Functions Guide</title> <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" /> <meta name="author" content="OpenLink Software Documentation Team ; " /> <meta name="copyright" content="OpenLink Software, 1999 - 2009" /> <meta name="keywords" content="" /> <meta name="GENERATOR" content="OpenLink XSLT Team" /> </head> <body> <div id="header"> <a name="me_uddi_save_business" /> <img src="../images/misc/logo.jpg" alt="" /> <h1>22. Virtuoso Functions Guide - uddi_save_business</h1> </div> <div id="navbartop"> <div> <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="me_uddi_save_binding.html" title="uddi_save_binding">Prev</a> | <a class="link" href="me_uddi_save_service.html" title="uddi_save_service">Next</a> </div> </div> <div id="currenttoc"> <form method="post" action="/doc/adv_search.vspx"> <div class="search">Keyword Search: <br /> <input type="text" name="q" /> <input type="submit" name="go" value="Go" /> </div> </form> <div> <a href="http://www.openlinksw.com/">www.openlinksw.com</a> </div> <div> <a href="http://docs.openlinksw.com/">docs.openlinksw.com</a> </div> <br /> <div> <a href="index.html">Book Home</a> </div> <br /> <div> <a href="contents.html">Contents</a> </div> <div> <a href="preface.html">Preface</a> </div> <br /> <div> <a class="selected" href="functions.html">Virtuoso Functions Guide</a> </div> <br /> <div> <a href="functions.html#admin">Administration</a> </div> <div> <a href="functions.html#aggr">Aggregate Functions</a> </div> <div> <a href="functions.html#array">Array Manipulation</a> </div> <div> <a href="functions.html#bpel">BPEL APIs</a> </div> <div> <a href="functions.html#backup">Backup</a> </div> <div> <a href="functions.html#compression">Compression</a> </div> <div> <a href="functions.html#cursors">Cursor</a> </div> <div> <a href="functions.html#time">Date & Time Manipulation</a> </div> <div> <a href="functions.html#debug">Debug</a> </div> <div> <a href="functions.html#dict">Dictionary Manipulation</a> </div> <div> <a href="functions.html#encoding">Encoding & Decoding</a> </div> <div> <a href="functions.html#file">File Manipulation</a> </div> <div> <a href="functions.html#ft">Free Text</a> </div> <div> <a href="functions.html#hash">Hashing / Cryptographic</a> </div> <div> <a href="functions.html#ldap">LDAP</a> </div> <div> <a href="functions.html#localization">Locale</a> </div> <div> <a href="functions.html#mail">Mail</a> </div> <div> <a href="functions.html#misc">Miscellaneous</a> </div> <div> <a href="functions.html#number">Number</a> </div> <div> <a href="functions.html#phrz">Phrases</a> </div> <div> <a href="functions.html#rdf">RDF data</a> </div> <div> <a href="functions.html#rmt">Remote SQL Data Source</a> </div> <div> <a href="functions.html#repl">Replication</a> </div> <div> <a href="functions.html#soap">SOAP</a> </div> <div> <a href="functions.html#sql">SQL</a> </div> <div> <a href="functions.html#string">String</a> </div> <div> <a href="functions.html#txn">Transaction</a> </div> <div> <a href="functions.html#type">Type Mapping</a> </div> <div> <a class="selected" href="functions.html#uddi">UDDI</a> </div> <div class="selected"> <div> <a href="me_uddi_delete_binding.html">uddi_delete_binding</a> </div> <div> <a href="me_uddi_delete_business.html">uddi_delete_business</a> </div> <div> <a href="me_uddi_delete_service.html">uddi_delete_service</a> </div> <div> <a href="me_uddi_delete_tModel.html">uddi_delete_tmodel</a> </div> <div> <a href="me_uddi_discard_authToken.html">uddi_discard_authtok...</a> </div> <div> <a href="me_uddi_find_binding.html">uddi_find_binding</a> </div> <div> <a href="me_uddi_find_business.html">uddi_find_business</a> </div> <div> <a href="me_uddi_find_service.html">uddi_find_service</a> </div> <div> <a href="me_uddi_find_tModel.html">uddi_find_tmodel</a> </div> <div> <a href="me_uddi_get_authToken.html">uddi_get_authtoken</a> </div> <div> <a href="me_uddi_get_bindingDetail.html">uddi_get_bindingdeta...</a> </div> <div> <a href="me_uddi_get_businessDetail.html">uddi_get_businessdet...</a> </div> <div> <a href="me_uddi_get_businessDetailExt.html">uddi_get_businessdet...</a> </div> <div> <a href="me_uddi_get_registeredInfo.html">uddi_get_registeredi...</a> </div> <div> <a href="me_uddi_get_serviceDetail.html">uddi_get_servicedeta...</a> </div> <div> <a href="me_uddi_get_tModelDetail.html">uddi_get_tmodeldetai...</a> </div> <div> <a href="me_uddi_save_binding.html">uddi_save_binding</a> </div> <div> <a class="selected" href="me_uddi_save_business.html">uddi_save_business</a> </div> <div> <a href="me_uddi_save_service.html">uddi_save_service</a> </div> <div> <a href="me_uddi_save_tModel.html">uddi_save_tmodel</a> </div> </div> <div> <a href="functions.html#udt">User Defined Types & The CLR</a> </div> <div> <a href="functions.html#vad">VAD</a> </div> <div> <a href="functions.html#jvmpl">Virtuoso Java PL API</a> </div> <div> <a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a> </div> <div> <a href="functions.html#ws">Web & Internet</a> </div> <div> <a href="functions.html#xml">XML</a> </div> <div> <a href="functions.html#XPATH">XPATH & XQUERY</a> </div> <br /> <div> <a href="functionidx.html">Functions Index</a> </div> <br /> </div> <div id="text"> <h2>uddi_save_business</h2> <div class="refpurpose">Save or update information about a complete businessEntity structure.</div> <div class="refsect1"> <div class="refsect1title">Syntax</div> <div> <pre class="screen"> <uddi_save_business generic="1.0" xmlns="urn:uddi-org:api" > <authInfo/> <businessEntity/> [<businessEntity/>...] | <uploadRegister/> [<uploadRegister/>...] </uddi_save_business> </pre> </div> </div> <div class="refsect1"> <div class="refsect1title">Description</div> <p> The <span class="computeroutput">uddi_save_business</span> message is used to save or update information about a complete <span class="computeroutput">businessEntity</span> structure. This message has the broadest scope of all of the save calls in the publisher's API, and can be used to make sweeping changes to the published information for one or more <span class="computeroutput">businessEntity</span> structures controlled by an identity. </p> </div> <div class="refsect1"> <div class="refsect1title">Attributes & Children</div> <p> Either <span class="computeroutput">businessEntity</span> arguments or <span class="computeroutput">uploadRegister</span> arguments may be passed in a given <span class="computeroutput">uddi_save_business</span> message, but not both. Any number of <span class="computeroutput">businessEntity</span> or <span class="computeroutput">uploadRegister</span> values can be passed in a single save (up to a server-imposed limit), but the two types of parameters may not be mixed. </p> <div class="refsect2"> <span class="refsect2title">authInfo – </span>This required argument is an element that contains an authentication token obtained using the <span class="computeroutput">get_authToken</span> call.</div> <div class="refsect2"> <span class="refsect2title">businessEntity – </span>One or more complete <span class="computeroutput">businessEntity</span> structures can be passed. These structures can be obtained in advance by using the <span class="computeroutput">get_businessDetail</span> call or by any other means.</div> <div class="refsect2"> <span class="refsect2title">uploadRegister – </span>one or more resolvable HTTP URL addresses that each point to a single and valid <span class="computeroutput">businessEntity</span> or <span class="computeroutput">businessEntityExt</span> structure. This variant argument allows a registry to be updated to reflect the contents of an XML document that is URL-addressable. The URL must return a pure XML document that only contains a <span class="computeroutput">businessEntity</span> structure as its top-level element, and be accessible using the standard HTTP-GET protocol.</div> <div class="refsect2"> <span class="refsect2title">Behavior – </span>If any of the <span class="computeroutput">uuid_key</span> values within in a <span class="computeroutput">businessEntity</span> structure (e.g. any data with a key value regulated by a <span class="computeroutput">businessKey</span>, <span class="computeroutput">serviceKey</span>, <span class="computeroutput">bindingKey</span>, or <span class="computeroutput">tModelKey</span>) is passed with a blank value, this is a signal that the data that is so keyed is being inserted. This does not apply to structures that reference other keyed data, such as <span class="computeroutput">tModelKey</span> references within <span class="computeroutput">bindingTemplate</span> or <span class="computeroutput">keyedReference</span> structures, since these are references.</div> <p> To make this call perform an update to existing registered data, the keyed entities (<span class="computeroutput">businessEntity</span>, <span class="computeroutput">businessService</span>, <span class="computeroutput">bindingTemplate</span> or <span class="computeroutput">tModel</span>) should have <span class="computeroutput">uuid_key</span> values that correspond to the registered data. </p> <p> Data can be deleted with this call when registered information is different from the new information provided. Any <span class="computeroutput">businessService</span> or <span class="computeroutput">bindingTemplate</span> structures that are found in the controlling server but that are missing from the <span class="computeroutput">businessEntity</span> information provided in or referenced by this call will be deleted from the registry after processing this call. </p> <p> Data contained within one or more <span class="computeroutput">businessEntity</span> structures can be rearranged with this function when data passed to this function redefines parent container relationships for other registered information. For instance, if a new <span class="computeroutput">businessEntity</span> is saved with information about a <span class="computeroutput">businessService</span> that is registered already as part of a separate <span class="computeroutput">businessEntity</span>, the <span class="computeroutput">businessService</span> is moved from its current container to the new <span class="computeroutput">businessEntity</span>. This only applies if the entity controlling the data referenced is the same entity identified in the <span class="computeroutput">uddi_save_business</span> message. </p> <p> If the file located by the <span class="computeroutput">uploadRegister</span> URL is an extended business entity (<span class="computeroutput">businessEntityExt</span>) structure, only the <span class="computeroutput">businessEntity</span> data found within that structure will be registered. </p> <p> If a <span class="computeroutput">businessEntity</span> element is used to save data, then the UDDI-enabled server will create a URL specific to that server. This URL can be used to retrieve via HTTP-GET the <span class="computeroutput">businessEntity</span> structure being registered. This information will be added - if not already present - to the <span class="computeroutput">discoveryURL</span>'s collection automatically with a <span class="computeroutput">useType</span> value of <span class="computeroutput">businessEntity</span>. </p> </div> <div class="refsect1"> <div class="refsect1title">Return Types</div> <p> This message returns a <span class="computeroutput">businessDetail</span> message that reflects the new registered information for the <span class="computeroutput">businessEntity</span> information provided. </p> </div> <div class="refsect1title">Errors</div> <p> If an error occurs in processing this message, a <span class="computeroutput">dispositionReport</span> structure will be returned to the caller in a SOAP Fault. The following error information will be relevant: </p> <table class="data"> <tr> <th class="data">Error Code</th> <th class="data">Description</th> </tr> <tr> <td class="data"> <a name="errE_invalidKeyPassed" /> <span class="errorcode">E_invalidKeyPassed</span> </td> <td class="data">signifies that one of the uuid_key values passed did not match with any known serviceKey values. No partial results will be returned; if any serviceKey values passed are not valid, this error will be returned.</td> </tr> <tr> <td class="data"> <a name="errE_authTokenExpired" /> <span class="errorcode">E_authTokenExpired</span> </td> <td class="data">signifies that the authentication token value passed in the authInfo argument is no longer valid because the token has expired.</td> </tr> <tr> <td class="data"> <a name="errE_authTokenRequired" /> <span class="errorcode">E_authTokenRequired</span> </td> <td class="data">signifies that the authentication token value passed in the authInfo argument is either missing or is not valid.</td> </tr> <tr> <td class="data"> <a name="errE_userMismatch" /> <span class="errorcode">E_userMismatch</span> </td> <td class="data">signifies that one or more of the uuid_key values passed refers to data that is not controlled by the individual who is represented by the authentication token.</td> </tr> <tr> <td class="data"> <a name="errE_operatorMismatch" /> <span class="errorcode">E_operatorMismatch</span> </td> <td class="data">signifies that one or more of the businessKey values passed refers to data that is not controlled by the UDDI-enabled server that received the request for processing.</td> </tr> <tr> <td class="data"> <a name="errE_keyRetired" /> <span class="errorcode">E_keyRetired</span> </td> <td class="data">signifies that the request cannot be satisfied because one or more uuid_key values specified has previously been hidden or removed by the requester. This specifically applies to the tModelKey values passed.</td> </tr> <tr> <td class="data"> <a name="errE_invalidURLPassed" /> <span class="errorcode">E_invalidURLPassed</span> </td> <td class="data">an error occurred with one of the uploadRegister URL values.</td> </tr> <tr> <td class="data"> <a name="errE_accountLimitExceeded" /> <span class="errorcode">E_accountLimitExceeded</span> </td> <td class="data">signifies that user account limits have been exceeded.</td> </tr> </table> <br /> <p /> </div> <div id="footer"> <div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div> <div id="validation"> <a href="http://validator.w3.org/check/referer"> <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /> </a> <a href="http://jigsaw.w3.org/css-validator/"> <img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" /> </a> </div> </div> </body> </html>