Histórico da Página
| HTML |
|---|
<div id="main-content" class="wiki-content group"> <h1 id="UtilizaçãodeWebservices-Índice">Index</h1> <p> <style type='text/css'>/*<![CDATA[*/ div.rbtoc1412695617091 { padding: 0px; } div.rbtoc1412695617091 ul { list-style: none; margin-left: 0px; } div.rbtoc1412695617091 li { margin-left: 0px; padding-left: 0px; } /*]]>*/ </style> <div class='toc-macro rbtoc1412695617091'> <ul class='toc-indentation'> <li><span class='TOCOutline'>1</span> <a href='#UtilizaçãodeWebservices-Índice'>Index</a></li> <li><span class='TOCOutline'>2</span> <a href='#UtilizaçãodeWebservices-Objetivo'>Objective</a></li> <li><span class='TOCOutline'>3</span> <a href='#UtilizaçãodeWebservices-CriarStubs'>Create Stubs</a></li> <li><span class='TOCOutline'>4</span> <a href='#UtilizaçãodeWebservices-ConsideraçõesMétodosdeUpdate'>Update Method Considerations</a></li> <li><span class='TOCOutline'>5</span> <a href='#UtilizaçãodeWebservices-ECMAttributionMecanismService'>ECMAttributionMecanismService</a></li> <li><span class='TOCOutline'>6</span> <a href='#UtilizaçãodeWebservices-ECMBusinessPeriedService'>ECMBusinessPeriedService</a></li> <li><span class='TOCOutline'>7</span> <a href='#UtilizaçãodeWebservices-ECMCardIndexService'>ECMCardIndexService</a></li> <li><span class='TOCOutline'>8</span> <a href='#UtilizaçãodeWebservices-ECMCardService'>ECMCardService</a></li> <li><span class='TOCOutline'>9</span> <a href='#UtilizaçãodeWebservices-ECMColleagueGroupService'>ECMColleagueGroupService</a></li> <li><span class='TOCOutline'>10</span> <a href='#UtilizaçãodeWebservices-ECMColleagueReplacementService'>ECMColleagueReplacementService</a></li> <li><span class='TOCOutline'>11</span> <a href='#UtilizaçãodeWebservices-ECMColleagueService'>ECMColleagueService</a></li> <li><span class='TOCOutline'>12</span> <a href='#UtilizaçãodeWebservices-ECMCompanyService'>ECMCompanyService</a></li> <li><span class='TOCOutline'>13</span> <a href='#UtilizaçãodeWebservices-ECMCustomFieldsService'>ECMCustomFieldsService</a></li> <li><span class='TOCOutline'>14</span> <a href='#UtilizaçãodeWebservices-ECMDashBoardService'>ECMDashBoardService</a></li> <li><span class='TOCOutline'>15</span> <a href='#UtilizaçãodeWebservices-ECMDataServiceService'>ECMDataServiceService</a></li> <li><span class='TOCOutline'>16</span> <a href='#UtilizaçãodeWebservices-ECMDatasetService'>ECMDatasetService</a></li> <li><span class='TOCOutline'>17</span> <a href='#UtilizaçãodeWebservices-ECMDocumentService'>ECMDocumentService</a></li> <li><span class='TOCOutline'>18</span> <a href='#UtilizaçãodeWebservices-ECMFavoritesService'>ECMFavoritesService</a></li> <li><span class='TOCOutline'>19</span> <a href='#UtilizaçãodeWebservices-ECMFolderService'>ECMFolderService</a></li> <li><span class='TOCOutline'>20</span> <a href='#UtilizaçãodeWebservices-ECMGlobalParamService'>ECMGlobalParamService</a></li> <li><span class='TOCOutline'>21</span> <a href='#UtilizaçãodeWebservices-ECMGroupService'>ECMGroupService</a></li> <li><span class='TOCOutline'>22</span> <a href='#UtilizaçãodeWebservices-ECMOutstandingService'>ECMOutstandingService</a></li> <li><span class='TOCOutline'>23</span> <a href='#UtilizaçãodeWebservices-ECMReportService'>ECMReportService</a></li> <li><span class='TOCOutline'>24</span> <a href='#UtilizaçãodeWebservices-ECMSearchDocumentService'>ECMSearchDocumentService</a></li> <li><span class='TOCOutline'>25</span> <a href='#UtilizaçãodeWebservices-ECMSignalService'>ECMSignalService</a></li> <li><span class='TOCOutline'>26</span> <a href='#UtilizaçãodeWebservices-ECMTokenService'>ECMTokenService</a></li> <li><span class='TOCOutline'>27</span> <a href='#UtilizaçãodeWebservices-ECMWorkflowEngineService'>ECMWorkflowEngineService</a></li> <li><span class='TOCOutline'>28</span> <a href='#UtilizaçãodeWebservices-ECMWorkflowRoleService'>ECMWorkflowRoleService</a></li> </ul> </div> </p> <h1 id="UtilizaçãodeWebservices-Objetivo">Objective</h1> <p> The objective of this document is to describe the use of <em>Webservices</em>, display and explain all of their methods, provide class examples that use these <em>Webservices</em> and display examples for generating <em>stubs</em> that are required for <em>client</em> communication with the service. </p> <h1 id="UtilizaçãodeWebservices-CriarStubs">Create Stubs</h1> <p> The <em>stubs</em> are required so that <em>clients</em> that use the <em>Webservice</em> methods can communicate with the service. </p> <p> In order to create a <em>stub</em>, Fluig service needs to be started. After starting the service, open the command prompt and use the following syntax: wsimport -d <output_directory> <wsdl_url>, where output_directory is the directory where the stub will be created and wsdl_url is the service access url. After that, just press Enter and the result will display as shown in figure 1.  </p> <div class="aui-message warning shadowed information-macro"> <p class="title">Note</p> <span class="aui-icon icon-warning">Icon</span> <div class="message-content"> A facilitator was created to generate all the stubs, just download the <a href="http://tdn.totvs.com/download/attachments/73084007185741437/155812466Cliente%20Web%20Service.zip?version=1&modificationDate=1426097688000&api=v2">Cliente Web Service.zip</a> document. Just unzip it and run the "fluig-ws.sh" file, provide the server name and port. After running it, "fluig-ws-client.jar" will be generated. Import .jar to access the service. </div> </div> <p> </p> <p align="center"> <strong><img class="confluence-embedded-image" src="http://tdn.totvs.com/download/attachments/73084007/73408362image2013-8-29%2017%3A50%3A36.png?version=1&modificationDate=1377809334000&api=v2" data-image-src="http://tdn.totvs.com/download/attachments/73084007/73408362image2013-8-29%2017%3A50%3A36.png?version=1&modificationDate=1377809334000&api=v2"><br /></strong> </p> <p align="center"> <strong>Figure 1: Stub creation example</strong> </p> <p> </p> <p> </p> <span id='content_1' class='cloak'><p> Chart 1 shows the command required for creating stubs of each available service in Fluig.</p> <div class="table-wrap"> <table style="margin-left: auto;" class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p style="text-align: center;">Webservices (WSDL)</p></td> <td class="confluenceTd"><p>Command</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMAttributionMecanismService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMAttributionMecanismService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMBusinessPeriodService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMBusinessPeriodService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMCardIndexService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardIndexService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMCardService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMColleagueGroupService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueGroupService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMColleagueReplacementService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueReplacementService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMColleagueService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMCompanyService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCompanyService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMCustomFieldsService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCustomFieldsService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMDashBoardService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDashBoardService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMDataServiceService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDataServiceService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMDatasetService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDatasetService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMDocumentService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDocumentService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMFavoritesService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFavoritesService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMFolderService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFolderService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMGlobalParamService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGlobalParamService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMGroupService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGroupService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMOutstandingService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMOutstandingService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMReportService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMReportService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMSearchDocumentService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSearchDocumentService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMSignalService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSignalService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMTokenService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMTokenService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMWorkflowEngineService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowEngineService?wsdl</p></td> </tr> <tr> <td class="confluenceTd"><p>ECMWorkflowRoleService</p></td> <td class="confluenceTd"><p>wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowRoleService?wsdl</p></td> </tr> </tbody> </table> </div> <p style="text-align: center;"> <strong>Chart 1: Commands for creating stubs.</strong> </p> <p> </p></span> <h1 id="UtilizaçãodeWebservices-ConsideraçõesMétodosdeUpdate">Update Method Considerations</h1> <p>For the update methods that receive complex objectives (DocumentDto, ColleagueDto, GroupDto, etc.), you must pass all object fields changed. The fields not provided will be substituted for blank, null or zero, depending on the type.</p> <p>In order to avoid this situation, we suggest always using the get methods to recover the object, change the required fields and send them to the update method.</p> <div class="aui-message warning shadowed information-macro"> <p class="title">Note</p> <span class="aui-icon icon-warning">Icon</span> <div class="message-content"> <p>We identified, in some objects, the method return attributes. If you haven't found the object that you are looking for, you can search the datasets and thus identify the attributes.</p> <p> </p> <p> <img class="confluence-embedded-image image-center" width="500" src="plugins/servlet/confluence/placeholder/unknown-attachmenthttp://tdn.totvs.com/download/attachments/73084007/print2.png?version=1&modificationDate=1418130908000&api=v2" title="image2014-8-19 11:26:7.png"> </p> <p style="text-align: center;"> <strong>Figure 1: Dataset query.</strong> </p> <p style="text-align: center;"> <strong><br /></strong> </p> <p style="text-align: center;"> <strong><br /></strong> </p> <img class="confluence-embedded-image image-center" width="800" src="plugins/servlet/confluence/placeholder/unknown-attachmenthttp://tdn.totvs.com/download/attachments/73084007/print.png?version=1&modificationDate=1418130882000&api=v2" title="01.PNG"> <p style="text-align: center;"> <strong>Figure 2: Colleague dataset query result.</strong> </p> <p style="text-align: center;"> <strong><br /></strong> </p> </div> </div> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMAttributionMecanismService">ECMAttributionMecanismService</h1> <p>Webservice responsible for performing operations related to the assignment mechanisms registered in Fluig. It can be used to search the assignment mechanisms of a specific company.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos">Methods </h4> <span id='content_2' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>getAttributionMecanism</p></td> <td class="confluenceTd"><p>Returns the company assignment mechanisms.</p> <p> </p> <p>Method:</p> <p>getAttributionMecanism(String user, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: AttributionMecanismDto[].</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 2: Methods of </strong><strong>AttributionMecanismService.</strong> </p> <p> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/AttributionMecanismServiceClient.java?version=2&modificationDate=1426272565862&api=v2">AttributionMecanismServiceClient.java</a> class, it exemplifies the use of the main methods of the AttributionMecanismService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMBusinessPeriedService">ECMBusinessPeriedService</h1> <p>Webservice responsible for performing operations related to the working hours registered in Fluig. It can be used to search the working hours of a specific company.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.1">Methods</h4> <span id='content_3' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd">getBusinessPeriods</td> <td class="confluenceTd"><p>Returns the working hours of the company.</p> <p> </p> <p>Method:</p> <p>getBusinessPeriods(String user, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: BusinessPeriodDto[].</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 3: BusinessPeriodService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <p> </p> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.1">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/BusinessPeriodServiceClient.java?version=2&modificationDate=1426272586284&api=v2">BusinessPeriodServiceClient.java</a> class, it exemplifies the use of the main methods of the BusinessPeriodService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMCardIndexService">ECMCardIndexService</h1> <p>Webservice responsible for performing operations related to the forms registered in Fluig.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.2">Methods</h4> <span id='content_4' class='cloak'><div class="table-wrap"> <table style="margin-left: auto;" class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createSimpleCardIndex</p></td> <td class="confluenceTd"><p>Simple creation of a form.</p> <p> </p> <p>Method:</p> <p>createSimpleCardIndex (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, AttachmentArray attachments, CardEventDtoArray customEvents)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>parentDocumentId: form number.</li> <li>publisherId: author code.</li> <li>documentDescription: description.</li> <li>cardDescription: name.</li> <li>attachments: attached file.</li> <li>customEvents: events.</li> </ul> <p> </p> <p>Return: WebServiceMessageArray [].</p></td> </tr> <tr> <td class="confluenceTd"><p>createSimpleCardIndexWithDataset</p></td> <td class="confluenceTd"><p>Simple creation of a form with datasets.</p> <p> </p> <p>Method:</p> <p>createSimpleCardIndexWithDataset (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>parentDocumentId: form number.</li> <li>publisherId: author code.</li> <li>documentDescription: description.</li> <li>cardDescription: name.</li> <li>datasetName: dataset name.</li> <li>attachments: attached file.</li> <li>customEvents: events.</li> </ul> <p> </p> <p>Return: WebServiceMessageArray [].</p></td> </tr> <tr> <td class="confluenceTd"><p>createSimpleCardIndexWithDatasetPersisteType</p></td> <td class="confluenceTd"><p>Simple creation of a form with datasets, determining the persistence type (Form or List).</p> <p> </p> <p>createSimpleCardIndexWithDatasetPersisteType (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents, Integer persistenceType)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code;</li> <li>parentDocumentId: form number.</li> <li>publisherId: author code.</li> <li>documentDescription: description.</li> <li>cardDescription: name.</li> <li>datasetName: dataset name.</li> <li>attachments: attached file.</li> <li>customEvents: events.</li> <li>persistenceType: persistence type that will be used.</li> </ul> <p> </p> <p>Return: WebServiceMessageArray [].</p></td> </tr> <tr> <td class="confluenceTd"><p>getActiveCardIndex</p></td> <td class="confluenceTd"><p>Returns the active form.</p> <p> </p> <p>Method:</p> <p>getActiveCardIndex (String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: form number.</li> <li>colleagueId: user number.</li> </ul> <p> </p> <p>Return: DocumentDtoArray [].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAttachmentsList</p></td> <td class="confluenceTd"><p>Returns the form attachment list.</p> <p> </p> <p>Method:</p> <p>getAttachmentsList (String user, String password, int companyId, int documentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: form number.</li> </ul> <p> </p> <p>Return: StringArray [].</p></td> </tr> <tr> <td class="confluenceTd"><p>getCardIndexContent</p></td> <td class="confluenceTd"><p>Returns the content of a form.</p> <p> </p> <p>Method:</p> <p>getCardIndexContent (String user, String password, int companyId, int documentId, String colleagueId, int version, String nomeArquivo)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: form number.</li> <li>colleagueId: user registration for checking form permission.</li> <li>version: form version number.</li> <li>nomeArquivo: attachment file name.</li> </ul> <p> </p> <p>Return: byte[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getCardIndexesWithoutApprover</p></td> <td class="confluenceTd"><p>Returns the forms without approvers to which the user has permission.</p> <p> </p> <p>Method:</p> <p>getCardIndexesWithoutApprover(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration for checking form permission.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getCustomizationEvents</p></td> <td class="confluenceTd"><p>Returns the form events.</p> <p> </p> <p>Method:</p> <p>getCustomizationEvents (String user, String password, int companyId, int documentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: form number.</li> </ul> <p> </p> <p>Return: CardEventDtoArray [].</p></td> </tr> <tr> <td class="confluenceTd"><p>getFormFields</p></td> <td class="confluenceTd"><p>Returns the form fields.</p> <p> </p> <p>Method:</p> <p>getFormFields(String user, String password, int companyId, int documentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: form number.</li> </ul> <p> </p> <p>Return: String[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateSimpleCardIndex</p></td> <td class="confluenceTd"><p>Form simple update.</p> <p> </p> <p>Method:</p> <p>updateSimpleCardIndex (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, AttachmentArray attachments, CardEventDtoArray customEvents)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: form number.</li> <li>publisherId: author code.</li> <li>cardDescription: name.</li> <li>descriptionField: description.</li> <li>attachments: attached file.</li> <li>customEvents: events.</li> </ul> <p> </p> <p>Return: WebServiceMessageArray [].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateSimpleCardIndexWithDataset</p></td> <td class="confluenceTd"><p>Simple update of the form with datasets.</p> <p> </p> <p>Method:</p> <p>updateSimpleCardIndexWithDataset (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: form number.</li> <li>publisherId: author code.</li> <li>cardDescription: name.</li> <li>descriptionField: description.</li> <li>datasetName: dataset name.</li> <li>attachments: attached file.</li> <li>customEvents: events.</li> </ul> <p> </p> <p>Return: WebServiceMessageArray [].</p></td> </tr> </tbody> </table> </div> <p align="center"> <strong>Chart 4: CardIndexService method.</strong> </p> <p align="center"> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.2">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/CardServiceClient.java?version=2&modificationDate=1426272586872&api=v2">CardIndexServiceClient.java</a> class, it exemplifies the use of the main methods of the CardIndexService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMCardService">ECMCardService</h1> <p>Webservice responsible for performing operations related to forms in Fluig. It can be used to create, change, delete and search forms, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.3">Methods</h4> <span id='content_5' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>create</p></td> <td class="confluenceTd"><p>Creates a form.</p> <p> </p> <p>Method:</p> <p>create(int companyId, String user, String password, CardDto[] carddtos)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>carddtos: form that will be created.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>deleteCard</p></td> <td class="confluenceTd"><p>Deletes a form and sends it to the bin.</p> <p> </p> <p>Method:</p> <p>deleteCard(int companyId, String user, String password, int cardId)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>cardId: form number.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getCardVersion</p></td> <td class="confluenceTd"><p>Returns the version of a form.</p> <p> </p> <p>Method:</p> <p>getCardVersion(int companyId, String user, String password, int nrDocumentId, int version, String colleagueId)</p> <p> </p> <p>Method:</p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>nrDocumentId: form number.</li> <li>version: form version.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: CardDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateCard</p></td> <td class="confluenceTd"><p>Changes the metadata of a form.</p> <p> </p> <p>Method:</p> <p>updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>cardDtos: form that will be changed.</li> <li>attachs: form attachment.</li> <li>docsecurity: form security.</li> <li>docapprovers: form approvers.</li> <li>reldocs: documents related to form.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateCardData</p></td> <td class="confluenceTd"><p>Changes the fields of a form.</p> <p> </p> <p>Method:</p> <p>updateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>cardId: form number.</li> <li>cardData: form fields that will be changed.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 5: CardService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.3">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/CardServiceClient.java?version=2&modificationDate=1426272586872&api=v2">CardServiceClient.java</a> class, it exemplifies the use of the main methods of the CardService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMColleagueGroupService">ECMColleagueGroupService</h1> <p>Webservice responsible for performing operations related to user groups in Fluig. It can be used to relate a user to a group of users and it can also be used to change, delete and search these created relationships.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.4">Methods</h4> <span id='content_6' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createColleagueGroup</p></td> <td class="confluenceTd"><p>Associates a user to a group.</p> <p> </p> <p>Method:</p> <p>createColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code;</li> <li>grupo_colaborador: group that will be associated with a user.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>deleteColleagueGroup</p></td> <td class="confluenceTd"><p>Deletes a user from a group.</p> <p> </p> <p>Method:</p> <p>deleteColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>groupId: group code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getAllColleagueGroups</p></td> <td class="confluenceTd"><p>Returns all the groups that have related users.</p> <p> </p> <p>Method:</p> <p>getAllColleagueGroups(String username, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: ColleagueGroupDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getColleagueGroup</p></td> <td class="confluenceTd"><p>Returns only a group that a certain user participates in.</p> <p> </p> <p>Method:</p> <p>getColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>groupId: group code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: ColleagueGroupDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>colleagueId</p></li> <li><p>companyId</p></li> <li><p>groupId</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getColleagueGroupsByColleagueId</p></td> <td class="confluenceTd"><p>Returns the groups that a user participates in.</p> <p> </p> <p>Method:</p> <p>getColleagueGroupsByColleagueId(String username, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: ColleagueGroupDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>colleagueId</p></li> <li><p>companyId</p></li> <li><p>groupId</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p> getColleagueGroupsByGroupId</p></td> <td class="confluenceTd"><p>Returns the users that participate from a group of users.</p> <p> </p> <p>Method:</p> <p>getColleagueGroupsByGroupId(String username, String password, int companyId, String groupId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>groupId: group code.</li> </ul> <p> </p> <p>Return: ColleagueGroupDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>colleagueId</p></li> <li><p>companyId</p></li> <li><p>groupId</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>updateColleagueGroup</p></td> <td class="confluenceTd"><p>Changes the association of a user with a group.</p> <p> </p> <p>Method:</p> <p>updateColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>grupo_colaborador: user group that will be changed.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 6: ColleagueGroupService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.4">Use example</h4> <p> Download the <a href="http://tdn.totvs.com/download/attachments/73084007185741437/155812387ColleagueGroupServiceClient.java?version=2&modificationDate=1426272587160&api=v2">ColleagueGroupServiceClient.java</a> class, it exemplifies the use of the main methods of the ColleagueGroupService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMColleagueReplacementService">ECMColleagueReplacementService</h1> <p>Webservice responsible for performing operations related to substitute users in Fluig. It can be used to create, change, delete and search substitute users, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.5">Methods</h4> <span id='content_7' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createColleagueReplacement</p></td> <td class="confluenceTd"><p>Creates a substitute.</p> <p> </p> <p>Method:</p> <p>createColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>crDto: substitute registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>deleteColleagueReplacement</p></td> <td class="confluenceTd"><p>Deletes a substitute registration.</p> <p> </p> <p>Method:</p> <p>deleteColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: source user registration.</li> <li>replacementId: substitute user registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getColleagueReplacement</p></td> <td class="confluenceTd"><p>Returns a substitute of a user.</p> <p> </p> <p>Method:</p> <p>getColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: source user registration.</li> <li>replacementId: substitute user registration.</li> </ul> <p> </p> <p>Return: ColleagueReplacementDto.</p></td> </tr> <tr> <td class="confluenceTd"><p> getReplacementsOfUser</p></td> <td class="confluenceTd"><p> </p> <p>Returns all the substitutes of a user.</p> <p> </p> <p>Method:</p> <p>getReplacementsOfUser(String username, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: source user registration.</li> </ul> <p> </p> <p>Return: ColleagueReplacementDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getValidReplacedUsers</p></td> <td class="confluenceTd"><p>Returns all the substitute users by a valid substitute.</p> <p> </p> <p>Method:</p> <p>getValidReplacedUsers(String username, String password, int companyId, String replacementId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code;</li> <li>replacementId: substitute user registration.</li> </ul> <p> </p> <p>Return: ColleagueReplacementDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getValidReplacement</p></td> <td class="confluenceTd"><p>Returns a valid substitute of a user.</p> <p> </p> <p>Method:</p> <p>getValidReplacement(String username, String password, int companyId, String colleagueId, String replacementId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: source user registration.</li> <li>replacementId: substitute user registration.</li> </ul> <p> </p> <p>Return: ColleagueReplacementDto.</p></td> </tr> <tr> <td class="confluenceTd"><p>getValidReplacementsOfUser</p></td> <td class="confluenceTd"><p>Returns all the valid substitutes of a user.</p> <p> </p> <p>Method:</p> <p>getValidReplacementsOfUser(String username, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code;</li> <li>colleagueId: source user registration.</li> </ul> <p> </p> <p>Return: ColleagueReplacementDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateColleagueReplacement</p></td> <td class="confluenceTd"><p>Changes a substitute registration.</p> <p> </p> <p>Method:</p> <p>updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>crDto: user registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 7: ColleagueReplacementService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.5">Use example</h4> <p> Download the <a class="unresolved" href="#">ColleagueReplacementServiceClient.java</http://tdn.totvs.com/download/attachments/185741437/ColleagueReplacementServiceClient.java?version=2&modificationDate=1426272587452&api=v2">ColleagueReplacementServiceClient.java</a> class, it exemplifies the use of the main methods of the ColleagueReplacementService class. </p> <h1 id="UtilizaçãodeWebservices-ECMColleagueService">ECMColleagueService</h1> <p>Webservice responsible for performing operations related to users in Fluig. It can be used to create, change, delete and search users, among other features.</p> <p> <strong>Attention:</strong> The createColleague, createColleaguewithDependencies, updateColleague and updateColleaguewithDependencies methods, in one of their paramters, receives a list of ColleagueDto, in the objects of these lists, the values for the <em>password</em> fields must be encrypted with the <em>hash </em>MD5 algorithm.   </p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.6">Methods</h4> <span id='content_8' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createColleague</p></td> <td class="confluenceTd"><p>Creates a user.</p> <p> </p> <p>Method:</p> <p>createColleague(String username, String password, int companyId, ColleagueDto[] colleagues)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagues: users.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>createColleaguewithDependencies</p></td> <td class="confluenceTd"><p>Creates a user with groups and roles.</p> <p> </p> <p>Method:</p> <p>createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagues: users.</li> <li>grupos: groups.</li> <li>papeis: roles.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getColleague</p></td> <td class="confluenceTd"><p>Returns a user.</p> <p> </p> <p>Method:</p> <p>getColleague(String username, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: ColleagueDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>active </p></li> <li><p>adminUser </p></li> <li><p>maxPrivateSize</p></li> <li><p>colleagueName </p></li> <li><p>companyId </p></li> <li><p>defaultLanguage </p></li> <li><p>dialectID </p></li> <li><p>emailHtml </p></li> <li><p>gedUser </p></li> <li><p>login</p></li> <li><p>mail</p></li> <li><p>colleagueId </p></li> <li><p>menuConfig</p></li> <li><p>newsPublisher</p></li> <li><p>rowId</p></li> <li><p>usedSpace</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getColleagueByLogin </p></td> <td class="confluenceTd"><p>Returns the user from the login.</p> <p>Method:</p> <p>getColleagueByLogin(String username, String password)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> </ul> <p> </p> <p>Return: ColleagueDto.</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>active </p></li> <li><p>adminUser </p></li> <li><p>maxPrivateSize</p></li> <li><p>colleagueName </p></li> <li><p>companyId </p></li> <li><p>defaultLanguage </p></li> <li><p>dialectID </p></li> <li><p>emailHtml </p></li> <li><p>gedUser </p></li> <li><p>login</p></li> <li><p>mail</p></li> <li><p>colleagueId </p></li> <li><p>menuConfig</p></li> <li><p>newsPublisher</p></li> <li><p>rowId</p></li> <li><p>usedSpace</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getColleagues</p></td> <td class="confluenceTd"><p>Returns all active users.</p> <p> </p> <p>Method:</p> <p>getColleagues(String username, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: ColleagueDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>active </p></li> <li><p>adminUser </p></li> <li><p>maxPrivateSize</p></li> <li><p>colleagueName </p></li> <li><p>companyId </p></li> <li><p>defaultLanguage </p></li> <li><p>dialectID </p></li> <li><p>emailHtml </p></li> <li><p>gedUser </p></li> <li><p>login</p></li> <li><p>mail</p></li> <li><p>colleagueId </p></li> <li><p>menuConfig</p></li> <li><p>newsPublisher</p></li> <li><p>rowId</p></li> <li><p>usedSpace</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getColleaguesMail</p></td> <td class="confluenceTd"><p>Returns a user using an email.</p> <p> </p> <p>Method:</p> <p>getColleaguesMail(String username, String password, int companyId, String mail)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>mail: user email.</li> </ul> <p> </p> <p>Return: ColleagueDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>active </p></li> <li><p>adminUser </p></li> <li><p>maxPrivateSize</p></li> <li><p>colleagueName </p></li> <li><p>companyId </p></li> <li><p>defaultLanguage </p></li> <li><p>dialectID </p></li> <li><p>emailHtml </p></li> <li><p>gedUser </p></li> <li><p>login</p></li> <li><p>mail</p></li> <li><p>colleagueId </p></li> <li><p>menuConfig</p></li> <li><p>newsPublisher</p></li> <li><p>rowId</p></li> <li><p>usedSpace</p></li> <li>volumeId</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getColleagueWithMap</p></td> <td class="confluenceTd"><p>Returns a message informing if the user was created correctly.</p> <p> </p> <p>Method:</p> <p>getColleagueWithMap(String colleagueXML, String username, String password)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>colleagueXML: document normalized list.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getGroups</p></td> <td class="confluenceTd"><p>Returns the groups that the user participates in.</p> <p> </p> <p>Method:</p> <p>getGroups(String username, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: GroupDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>companyId </p></li> <li>groupDescription</li> <li><p>groupId</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getSimpleColleague</p></td> <td class="confluenceTd"><p>Returns the user.</p> <p> </p> <p>Method:</p> <p>getSimpleColleague(String username, String password)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> </ul> <p> </p> <p>Return: ColleagueDto.</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>active </p></li> <li><p>adminUser </p></li> <li><p>maxPrivateSize</p></li> <li><p>colleagueName </p></li> <li><p>companyId </p></li> <li><p>defaultLanguage </p></li> <li><p>dialectID </p></li> <li><p>emailHtml </p></li> <li><p>gedUser </p></li> <li><p>login</p></li> <li><p>mail</p></li> <li><p>colleagueId </p></li> <li><p>menuConfig</p></li> <li><p>newsPublisher</p></li> <li><p>rowId</p></li> <li><p>usedSpace</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getSummaryColleagues</p></td> <td class="confluenceTd"><p>Returns all active users.</p> <p> </p> <p>Method:</p> <p>getSummaryColleagues(int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: ColleagueDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>active </p></li> <li><p>colleagueId</p></li> <li><p>colleagueName</p></li> <li><p>companyId</p></li> <li><p>maxPrivateSize</p></li> <li><p>rowId</p></li> <li><p>usedSpace</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>removeColleague</p></td> <td class="confluenceTd"><p>Deactivates a user.</p> <p> </p> <p>Method:</p> <p>removeColleague(String username, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">activateColleague</td> <td colspan="1" class="confluenceTd"><p>Activates a user.</p> <p> </p> <p>Method:</p> <p>activateColleague(String username, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>updateColleague</p></td> <td class="confluenceTd"><p>Changes a user.</p> <p> </p> <p>Method:</p> <p>updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagues: users.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>updateColleaguewithDependencies</p></td> <td class="confluenceTd"><p>Changes a user with groups and roles.</p> <p> </p> <p>Method:</p> <p>updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagues: users.</li> <li>grupos: groups.</li> <li>papeis: roles.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>validateColleagueLogin</p></td> <td class="confluenceTd"><p>Validates a user access in the product.</p> <p> </p> <p>Method:</p> <p>validateColleagueLogin(int companyId, String colleagueId, String password)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>password: user password.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 8: ColleagueService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.6">Use example</h4> <p> Download the <a href="http://tdn.totvs.com/download/attachments/73084007185741437/155812386ColleagueServiceClient10.java?version=1&modificationDate=1426272587726&api=v2">ColleagueServiceClient.java</a> class, it exemplifies the use of the main methods of the ColleagueService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMCompanyService">ECMCompanyService</h1> <p>Webservice responsible for performing operations related to the company in Fluig. It can be used to create, change, delete and search companies, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.7">Methods</h4> <p> </p> <span id='content_9' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createCompany</p></td> <td class="confluenceTd"><p>Creates a company in Fluig.</p> <p> </p> <p>Method:</p> <p>createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>description: company description.</li> <li>urlAccessName: Access URL.</li> <li>phisicalPath: physical path.</li> <li>webdeskServer: server.</li> <li>webPort: port.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>delete</p></td> <td class="confluenceTd"><p>Deletes a company in Fluig.</p> <p> </p> <p>Method:</p> <p>delete(String username, String password, String companyId, Boolean deleteFiles)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>deleteFiles: indicates if the physical path should be deleted.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getCompanies</p></td> <td class="confluenceTd"><p>Returns all the companies registered in Fluig.</p> <p> </p> <p>Method:</p> <p>getCompanies(String username, String password, String companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: CompanyDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getCompany</p></td> <td class="confluenceTd"><p>Returns a company registered in Fluig.</p> <p> </p> <p>Method:</p> <p>getCompany(int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: CompanyDto.</p></td> </tr> <tr> <td class="confluenceTd"><p>updateCompany</p></td> <td class="confluenceTd"><p>Changes a company in Fluig.</p> <p> </p> <p>Method:</p> <p>updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>description: company description.</li> <li>urlAccessName: Access URL.</li> <li>phisicalPath: physical path.</li> <li>webdeskServer: server.</li> <li>webPort: port.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 9: CompanyService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.7">Use example</h4> <p> Download the <a class="unresolved" href="#">CompanyServiceClient.java</a> class, it exemplifies the use of the main methods of the CompanyService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMCustomFieldsService">ECMCustomFieldsService</h1> <p>Webservice responsible for interacting with the Fluig customized fields. It can be used to create, change, delete and search customized fields, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.8">Methods</h4> <span id='content_10' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createCustomFields</p></td> <td class="confluenceTd"><p>Creates a customized field.</p> <p> </p> <p>Method:</p> <p>createCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>customFieldsDto: customized field that will be created.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getAllCustomField</p></td> <td class="confluenceTd"><p>Returns all the customized fields.</p> <p> </p> <p>Method:</p> <p>getAllCustomField(String user, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: CustomFieldsDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAllDocumentCustomField</p></td> <td class="confluenceTd"><p>Returns all the customized fields of a document.</p> <p> </p> <p>Method:</p> <p>getAllDocumentCustomField(String user, String password, int companyId, int documentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: document number.</li> <li>version: document version.</li> </ul> <p> </p> <p>Return: DocumentCustomFieldsDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>removeCustomField</p></td> <td class="confluenceTd"><p>Deletes a customized field.</p> <p> </p> <p>Method:</p> <p>removeCustomField(String user, String password, int companyId, String customFieldsId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>customFieldsId: customized field code.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>removeDocumentCustomField</p></td> <td class="confluenceTd"><p>Deletes a document customized field.</p> <p> </p> <p>Method:</p> <p>removeDocumentCustomField(String user, String password, int companyId, String customFieldsId, int documentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>customFieldsId: customized field code.</li> <li>documentId: document number.</li> <li>version: document version.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>setDocumentCustomFields</p></td> <td class="confluenceTd"><p>Creates or changes a document-customized field.</p> <p> </p> <p>Method:</p> <p>setDocumentCustomFields(String user, String password, int companyId, DocumentCustomFieldsDto[] documentCustomFieldsDto)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentCustomFieldsDto: document with customized field.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>updateCustomFields</p></td> <td class="confluenceTd"><p>Changes a customized field.</p> <p> </p> <p>Method:</p> <p>updateCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>customFieldsDto: customized field that will be changed.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 10: CustomFieldsService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.8">Use example</h4> <p> Download the <a class="unresolved" href="#">CustomFieldsServiceClient.java</a> class, it exemplifies the use of the main methods of the CustomFieldsService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMDashBoardService">ECMDashBoardService</h1> <p>Webservice responsible for interacting with the Fluig task central. It can be used to search the information available in the task central.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.9">Methods</h4> <span id='content_11' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>findMyDocuments</p></td> <td class="confluenceTd"><p>Returns the user documents that need to be approved.</p> <p> </p> <p>Method:</p> <p>findMyDocuments(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findMyDocumentsOnDemand</p></td> <td class="confluenceTd"><p>Returns the user documents that need to be approved, paged.</p> <p> </p> <p>Method:</p> <p>findMyDocumentsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findDocumentsToApprove</p></td> <td class="confluenceTd"><p>Returns the documents that the user needs to approve.</p> <p> </p> <p>Method:</p> <p>findDocumentsToApprove(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findDocumentsToApproveOnDemand</p></td> <td class="confluenceTd"><p>Returns the documents that the user needs to approve, paged.</p> <p> </p> <p>Method:</p> <p>findDocumentsToApproveOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findAgreementDocuments</p></td> <td class="confluenceTd"><p>Returns the user documents that are in concensus.</p> <p> </p> <p>Method:</p> <p>findAgreementDocuments(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findCheckoutDocuments</p></td> <td class="confluenceTd"><p>Returns the user documents that are in checkout.</p> <p> </p> <p>Method:</p> <p>findCheckoutDocuments(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findCancelledTasks</p></td> <td class="confluenceTd"><p>Returns tasks assigned to the user that were canceled.</p> <p> </p> <p>Method:</p> <p>findCancelledTasks(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findCompletedTasks</p></td> <td class="confluenceTd"><p>Returns tasks assigned to the user that were finished.</p> <p> </p> <p>Method:</p> <p>findCompletedTasks(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findConsensusTasks</p></td> <td class="confluenceTd"><p>Returns tasks assigned to the user that are in consensus.</p> <p> </p> <p>Method:</p> <p>findConsensusTasks(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findTransferredTasks</p></td> <td class="confluenceTd"><p>Returns tasks assigned to the user that were transfered.</p> <p> </p> <p>Method:</p> <p>findTransferredTasks(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findWorkflowTasks</p></td> <td class="confluenceTd"><p>Returns the user tasks that are open.</p> <p> </p> <p>Method:</p> <p>findWorkflowTasks(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findWorkflowTasksOnDemand</p></td> <td class="confluenceTd"><p>Returns the user tasks that are open, paged.</p> <p> </p> <p>Method:</p> <p>findWorkflowTasksOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findMyRequests</p></td> <td class="confluenceTd"><p>Returns the open requests that were started by the user.</p> <p> </p> <p>Method:</p> <p>findMyRequests(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findMyRequestsOnDemand</p></td> <td class="confluenceTd"><p>Returns the open requests that were started by the user, paged.</p> <p> </p> <p>Method:</p> <p>findMyRequestsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findMyManagerTasks</p></td> <td class="confluenceTd"><p>Returns the tasks managed by the user.</p> <p> </p> <p>Method:</p> <p>findMyManagerTasks(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findExpiredWorkflowTasks</p></td> <td class="confluenceTd"><p>Returns the user tasks that are delayed.</p> <p> </p> <p>Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowProcessDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>fillStatusTask</p></td> <td class="confluenceTd"><p>Returns the amount of a user delayed tasks, within the deadline and without deadline.</p> <p> </p> <p>Method:</p> <p>fillStatusTask(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: int[].</p></td> </tr> <tr> <td class="confluenceTd"><p>fillChronoTasks</p></td> <td class="confluenceTd"><p>Returns the amount of tasks with a deadline that were assigned to the user and were not finished.</p> <p> </p> <p>Method:</p> <p>fillChronoTasks(String user, String password, int companyId, String colleagueId, int yearIni, int yearFin, int mounthIni, int mounthFin, int dayIni, int dayFin, int kindTask)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>yearIni: initial year.</li> <li>yearFin: final year.</li> <li>mounthIni: initial month.</li> <li>mounthFin: final month.</li> <li>dayIni: initial day.</li> <li>dayFin: final day.</li> <li>kindTask: task type.</li> </ul> <p> </p> <p>Return: int[].</p></td> </tr> <tr> <td class="confluenceTd"><p>fillTypeTasks</p></td> <td class="confluenceTd"><p>Returns the task types that the user has.</p> <p> </p> <p>Method:</p> <p>fillTypeTasks(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: TaskVODto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>fillTypeTasksOfReplacement</p></td> <td class="confluenceTd"><p>Returns the task types that the substitute user has.</p> <p> </p> <p>Method:</p> <p>fillTypeTasksOfReplacement(String user, String password, int companyId, String colleagueId, String replacementId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>replacementId: substitute user registration.</li> </ul> <p> </p> <p>Return: TaskVODto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getOpenTasksByColleagueGroups</p></td> <td class="confluenceTd"><p>Returns the tasks assigned to a group that the user participates in.</p> <p> </p> <p>Method:</p> <p>getOpenTasksByColleagueGroups(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowTaskDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getOpenTasksByColleagueGroupsOnDemand</p></td> <td class="confluenceTd"><p>Returns the tasks assigned to a group that the user participates in, paged.</p> <p> </p> <p>Method:</p> <p>getOpenTasksByColleagueGroupsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: WorkflowTaskDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getOpenTasksByColleagueRoles</p></td> <td class="confluenceTd"><p>Returns the tasks assigned to a role that the user participates in.</p> <p> </p> <p>Method:</p> <p>getOpenTasksByColleagueRoles(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WorkflowTaskDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getOpenTasksByColleagueRolesOnDemand</p></td> <td class="confluenceTd"><p>Returns the tasks assigned to a role workflow that the user participates in, paged.</p> <p> </p> <p>Method:</p> <p>getOpenTasksByColleagueRolesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: WorkflowTaskDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getSummaryRequests</p></td> <td class="confluenceTd"><p>Returns the Home pending counters.</p> <p> </p> <p>Method:</p> <p>getSummaryRequests(int companyId, String user, String password, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: HomeRequestSummaryDto[].</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">getUrlEcm</td> <td colspan="1" class="confluenceTd"><p>Returns the server url.</p> <p> </p> <p>Method:</p> <p>getUrlEcm(long companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.<br /> <br /></li> </ul> <div>Return: String.</div></td> </tr> </tbody> </table> </div> <p> <strong>Chart 11: DashBoardService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.9">Use example</h4> <p> Download the <a class="unresolved" href="#">DashBoardClient.java</a> class, it exemplifies the use of the main methods of the DashBoardService class. </p> <h1 id="UtilizaçãodeWebservices-ECMDataServiceService">ECMDataServiceService</h1> <p>Webservice responsible for interacting with the Fluig external services. It can be used to create, change, delete and search the existing external services.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.10">Methods</h4> <span id='content_12' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createDataService</p></td> <td class="confluenceTd"><p>Creates an external service.</p> <p> </p> <p>Method:</p> <p>createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>dataServiceDto: external service that will be created.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">deleteDataService </td> <td colspan="1" class="confluenceTd"><p>Removes an external service.</p> <p> </p> <p>Method:</p> <p>deleteDataService(int companyId, String user, String password, String dataServiceName)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>dataServiceName: external service name that will be removed.<br /> <br /> </li> </ul> <p>Return: void.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">getAllServices</td> <td colspan="1" class="confluenceTd"><p>Returns all the registered external services.</p> <p> </p> <p>Method:</p> <p>getAllServices(int companyId, String user, String password)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> </ul> <p> </p> <p>Return: dataServiceDto[].</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">loadDataService</td> <td colspan="1" class="confluenceTd"><p>Returns an external service.</p> <p> </p> <p>Method:</p> <p>loadDataService(int companyId, String user, String password, String dataServiceName)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>dataServiceName: external service name.</li> </ul> <p> </p> <p>Return: dataServiceDto.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">updateDataService</td> <td colspan="1" class="confluenceTd"><p>Updates an external service.</p> <p> </p> <p>Method:</p> <p>createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>dataServiceDto: external service that will be updated.</li> </ul> <p> <</p> <p>Return: void.</p></td> </tr> <tr> <td class="confluenceTd"><p>createDataServiceAuthenticated</p></td> <td class="confluenceTd"><p>Creates an external authenticated service.</p> <p> </p> <p>Method:</p> <p>createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto, OauthDTO oauthDTO)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>dataServiceDto: external service that will be created.</li> <li>oauthDTO: Settings object to service authentication.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">updateDataServiceAuthenticated</td> <td colspan="1" class="confluenceTd"><p>Updates an external authenticated service.</p> <p> </p> <p>Method:</p> <p>updateDataServiceAuthenticated(int companyId, String user, String password, DataServiceDto[] dataServiceDto, OauthDTO oauthDTO)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>dataServiceDto: external service that will be updated.</li> <li>oauthDTO: Settings object to service authentication.</li> </ul> <p> </p> <p>Return: void.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 12: DataServiceService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <h1 id="UtilizaçãodeWebservices-ECMDatasetService">ECMDatasetService</h1> <p>Webservice responsible for interacting with the Fluig datasets. It can be used to search the existing datasets.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.11">Methods</h4> <span id='content_13' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>addDataset</p></td> <td class="confluenceTd"><p>Creates a dataset.</p> <p> </p> <p>Method:</p> <p>addDataset(int companyId, String user, String password, String datasetName, String description, String impl)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>datasetName: name of the dataset that will be created.</li> <li>description: dataset description.</li> <li>impl: implementation for creating the dataset.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>deleteDataset</p></td> <td class="confluenceTd"><p>Removes a dataset.</p> <p> </p> <p>Method:</p> <p>deleteDataset(int companyId, String user, String password, String datasetName)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>datasetName: name of the dataset that will be removed.</li> </ul> <p> </p> <p>Return: void.</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableDatasets</p></td> <td class="confluenceTd"><p>Returns all the available datasets.</p> <p> </p> <p>Method:</p> <p>getAvailableDatasets(int companyId, String user, String password)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> </ul> <p> </p> <p>Return: Object[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getDataset</p></td> <td class="confluenceTd"><p>Returns information from a dataset.</p> <p> </p> <p>Method:</p> <p>getDataset(int companyId, String user, String password, String name, String[] fields, SearchConstraintDto[] constraintsDto, String[] order)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>name: dataset name.</li> <li>fields: dataset fields that will be returned.</li> <li>constraintsDto: record filter that will compose the dataset.</li> <li>order: fields used to order the dataset.</li> </ul> <p> </p> <p>Return: DatasetDto.</p></td> </tr> <tr> <td class="confluenceTd"><p>updateDataset</p></td> <td class="confluenceTd"><p>Updates a dataset.</p> <p> </p> <p>Method:</p> <p>updateDataset(int companyId, String user, String password, String datasetName, String description, String impl)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>datasetName: name of the dataset that will be updated.</li> <li>description: dataset description.</li> <li>impl: dataset implementation.</li> </ul> <p> </p> <p>Return: void.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 13: DataService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.10">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/DatasetServiceClient.java?version=2&modificationDate=1426272588823&api=v2">DatasetServiceClient.java</a> class, it exemplifies the use of the main methods of the DatasetService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMDocumentService">ECMDocumentService</h1> <p>Webservice responsible for performing operations related to Fluig documents. It can be used to create, change, delete and search documents, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.12">Methods</h4> <span id='content_14' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>approveDocument</p></td> <td class="confluenceTd"><p>Approves or rejects document pending approval.</p> <p> </p> <p>Method:</p> <p>approveDocument(int companyId, String userId, String password, int documentId, int version, String approverId, boolean approved, String observation)</p> <p> </p> <p>Parameters:</p> <p> </p> <ul> <li>user: integration user code.</li> <li>password: integration user password.</li> <li>companyId: company code.</li> <li>documentId: code of the document to be approved.</li> <li>version: version of the document to be approved.</li> <li>approverId: approver code</li> <li>approved: true if the document is approved and false if the document will be rejected.</li> <li>observation: note of approval or rejection.</li> </ul> <p> </p> <p>Return: WebServiceMessage[]</p> <p> </p></td> </tr> <tr> <td class="confluenceTd"><p>copyDocumentToUploadArea</p></td> <td class="confluenceTd"><p>Copies the files (main and attachments) of a document for the user upload area. This allows documents to be accessible through FTP.</p> <p>Method:</p> <p>copyDocumentToUploadArea(String user, String password, int companyId, int documentId, int version, String colleagueId)</p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: number of the document that will be copied.</li> <li>version: document version</li> <li>colleagueId: user registration whose upload area will be used</li> </ul> <p> </p> <p>Return: String[] name of the files that were made available in the upload area</p></td> </tr> <tr> <td class="confluenceTd"><p>createDocument</p></td> <td class="confluenceTd"><p>Creates a document.</p> <p> </p> <p>Method:</p> <p>createDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs,  DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docDtos: document that will be posted.</li> <li>attachs: file attached to post.</li> <li>docSecurity: security of the document that will be posted.</li> <li>docApprovers: approvers of document that will be posted.</li> <li>relDocs: documents related to the document that will be posted.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>createDocumentWithApprovementLevels</p></td> <td class="confluenceTd"><p>Creates a document with approval level.</p> <p> </p> <p>Method:</p> <p>createDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverWithLevelDto[] docApproversLevels, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docDtos: document that will be posted.</li> <li>attachs: file attached to post.</li> <li>docSecurity: security of the document that will be posted.</li> <li>docApproversLevel: approval level in which document approvers are inserted.</li> <li>levels: approval levels that the document will have.</li> <li>relDocs: documents related to the document that will be posted.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>createSimpleDocument</p></td> <td class="confluenceTd"><p>Creates a simple document.</p> <p> </p> <p>Method:</p> <p>createSimpleDocument(String user, String password, int company, int parentDocumentId, String publisherId, String documentDescription, Attachment[] attachments)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>parentDocumentId: parent folder number.</li> <li>publisherId: registration of the user that will post the document.</li> <li>documentDescription: document description.</li> <li>attachments: file attached to post.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>createSimpleDocumentPrivate</p></td> <td class="confluenceTd"><p>Creates a simple document in the private folder.</p> <p> </p> <p>Method:</p> <p>createSimpleDocumentPrivate(String colleagueId, String password, int companyId, int parentDocumentId, String documentDescription, Attachment[] attachments)</p> <p> </p> <p>Parameters:</p> <ul> <li>colleagueId: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>parentDocumentId: parent folder number.</li> <li>documentDescription: document description.</li> <li>attachments: file attached to post.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>deleteDocument</p></td> <td class="confluenceTd"><p>Deletes a document and sends it to the bin.</p> <p> </p> <p>Method:</p> <p>deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: number of the document that will be excluded.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>destroyDocument</p></td> <td class="confluenceTd"><p>Deletes a bin document.</p> <p> </p> <p>Method:</p> <p>destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: number of the document that will be excluded.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>destroyDocumentApproval</p></td> <td class="confluenceTd"><p>Deletes document pending approval.</p> <p> </p> <p>Method:</p> <p>destroyDocumentApproval(String userId, String password, int companyId, int documentId, String publisherId)</p> <p> </p> <p>Parameters:</p> <p> </p> <ul> <li>user: integration user code.</li> <li>password: integration user password.</li> <li>companyId: company code.</li> <li>documentId: code of the document to be deleted.</li> <li>publisherId: publisher code.</li> </ul> <p> </p> <p>Return: WebServiceMessage[]</p></td> </tr> <tr> <td class="confluenceTd"><p>findMostPopularDocuments</p></td> <td class="confluenceTd"><p>Returns the documents mostly accessed in Fluig to which the user has access permission.</p> <p> </p> <p>Method:</p> <p>findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>nr_resultados: amount of documents that will be returned.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li>accesCount</li> <li>activeVersion</li> <li>additionalComments</li> <li>allowMuiltiCardsPerUser</li> <li>approved</li> <li>colleagueId</li> <li>companyId</li> <li>crc</li> <li>createDate</li> <li>datasetName</li> <li>deleted</li> <li>documentDescription</li> <li>documentId</li> <li>documentType</li> <li>documentTypeId</li> <li>downloadEnabled</li> <li>draft</li> <li>expirationDate</li> <li>expires</li> <li>iconId</li> <li>imutable</li> <li>indexed</li> <li>inheritSecurity</li> <li>isEncrypted</li> <li>keyWord</li> <li>lastModifiedDate</li> <li>metaListId</li> <li>metaListRecordId</li> <li>parentDocumentId</li> <li>permissionType</li> <li>phisicalFile</li> <li>phisicalFileSize</li> <li>privateDocument</li> <li>protectedCopy</li> <li>publisherId</li> <li>restrictionType</li> <li>rowId</li> <li>securityLevel</li> <li>topicId</li> <li>translated</li> <li>UUID</li> <li>updateIsoProperties</li> <li>userNotify</li> <li>validationStartDate</li> <li>version</li> <li>versionDescription</li> <li>volumeId</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>findMostPopularDocumentsOnDemand</p></td> <td class="confluenceTd"><p>Returns the documents mostly accessed in Fluig to which the user has access permission, paged.</p> <p> </p> <p>Method:</p> <p>findMostPopularDocuments(int companyId, String user, String password, String colleagueId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li>accesCount</li> <li>activeVersion</li> <li>additionalComments</li> <li>allowMuiltiCardsPerUser</li> <li>approved</li> <li>colleagueId</li> <li>companyId</li> <li>crc</li> <li>createDate</li> <li>datasetName</li> <li>deleted</li> <li>documentDescription</li> <li>documentId</li> <li>documentType</li> <li>documentTypeId</li> <li>downloadEnabled</li> <li>draft</li> <li>expirationDate</li> <li>expires</li> <li>iconId</li> <li>imutable</li> <li>indexed</li> <li>inheritSecurity</li> <li>isEncrypted</li> <li>keyWord</li> <li>lastModifiedDate</li> <li>metaListId</li> <li>metaListRecordId</li> <li>parentDocumentId</li> <li>permissionType</li> <li>phisicalFile</li> <li>phisicalFileSize</li> <li>privateDocument</li> <li>protectedCopy</li> <li>publisherId</li> <li>restrictionType</li> <li>rowId</li> <li>securityLevel</li> <li>topicId</li> <li>translated</li> <li>UUID</li> <li>updateIsoProperties</li> <li>userNotify</li> <li>validationStartDate</li> <li>version</li> <li>versionDescription</li> <li>volumeId</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>findRecycledDocuments</p></td> <td class="confluenceTd"><p>Returns the documents from the bin.</p> <p> </p> <p>Method:</p> <p>findRecycledDocuments(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li>accesCount</li> <li>activeVersion</li> <li>additionalComments</li> <li>allowMuiltiCardsPerUser</li> <li>approved</li> <li>colleagueId</li> <li>companyId</li> <li>crc</li> <li>createDate</li> <li>datasetName</li> <li>deleted</li> <li>documentDescription</li> <li>documentId</li> <li>documentType</li> <li>documentTypeId</li> <li>downloadEnabled</li> <li>draft</li> <li>expirationDate</li> <li>expires</li> <li>iconId</li> <li>imutable</li> <li>indexed</li> <li>inheritSecurity</li> <li>isEncrypted</li> <li>keyWord</li> <li>lastModifiedDate</li> <li>metaListId</li> <li>metaListRecordId</li> <li>parentDocumentId</li> <li>permissionType</li> <li>phisicalFile</li> <li>phisicalFileSize</li> <li>privateDocument</li> <li>protectedCopy</li> <li>publisherId</li> <li>restrictionType</li> <li>rowId</li> <li>securityLevel</li> <li>topicId</li> <li>translated</li> <li>UUID</li> <li>updateIsoProperties</li> <li>userNotify</li> <li>validationStartDate</li> <li>version</li> <li>versionDescription</li> <li>volumeId</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getActiveDocument</p></td> <td class="confluenceTd"><p>Returns an active document.</p> <p> </p> <p>Method:</p> <p>getActiveDocument(String user, String password, int companyId, int nrDocumentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: document number.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getApprovers</p></td> <td class="confluenceTd"><p>Returns the approvers of a document.</p> <p> </p> <p>Method:</p> <p>getApprovers(String user, String password, int companyId, int nrDocumentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: document number.</li> <li>version: document version number.</li> </ul> <p> </p> <p>Return: ApproverWithLevelDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li>approverType</li> <li>colleagueId</li> <li>companyId</li> <li>documentId</li> <li>levelId</li> <li>version</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getDocumentApprovalHistory</p></td> <td class="confluenceTd"><p>Returns the approval history of the requested document.</p> <p> </p> <p>Method:</p> <p>getDocumentApprovalHistory(String user, String password, int companyId, int documentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: integration user code.</li> <li>password: integration user password.</li> <li>companyId: company code.</li> <li>documentId: document code for which you want to view the status.</li> <li>version: version of the document (if version 0 is provided, the last document version will be requested).</li> </ul> <p> </p> <p>Return: DocumentApprovementHistoryDto[]</p> <p> </p> <p>Return Attributes:</p> <ul> <li>colleagueId</li> <li>documentVersion</li> <li>iterationSequence</li> <li>levelId</li> <li>movementSequence</li> <li>observation</li> <li>signed</li> <li>status</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getDocumentApprovalStatus</p></td> <td class="confluenceTd"><p>Returns the document status related to the approval. The document status can be:</p> <p>0 - Approved.</p> <p>1 - Rejected.</p> <p>2 - Under approval.</p> <p> </p> <p>Method:</p> <p>getDocumentApprovalStatus(String user, String password, int companyId, int documentId, int version)</p> <p> </p> <p>Parameters:</p> <p> </p> <ul> <li>user: integration user code.</li> <li>password: integration user password.</li> <li>companyId: company code.</li> <li>documentId: document code for which you want to view the status.</li> <li>version: version of the document (if version 0 is provided, the last document version will be requested).</li> </ul> <p> </p> <p>Return: DocumentApprovalStatusDto[]</p> <p> </p> <p>Return Attributes:</p> <ul> <li>companyId</li> <li>documentId</li> <li>status</li> <li>version</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getDocumentByExternalId</p></td> <td class="confluenceTd"><p>Returns a document by the external code.</p> <p> </p> <p>Method:</p> <p>getDocumentByExternalId(String user, String password, int companyId, String externalDocumentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>externalDocumentId: document external code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getDocumentContent</p></td> <td class="confluenceTd"><p>Returns a document physical file code, if the user has permission to access it.</p> <p> </p> <p>Method:</p> <p>getDocumentContent(String user, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String nomeArquivo)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: document number.</li> <li>colleagueId: user registration.</li> <li>documentVersao: document version number.</li> <li>nomeArquivo: file name.</li> </ul> <p> </p> <p>Return: byte[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getDocumentVersion</p></td> <td class="confluenceTd"><p>Returns the version of a document.</p> <p> </p> <p>Method:</p> <p>getDocumentVersion(String user, String password, int companyId, int nrDocumentId, int version, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: document number.</li> <li>version: document version number.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li>accesCount</li> <li>activeVersion</li> <li>additionalComments</li> <li>allowMuiltiCardsPerUser</li> <li>approved</li> <li>colleagueId</li> <li>companyId</li> <li>crc</li> <li>createDate</li> <li>datasetName</li> <li>deleted</li> <li>documentDescription</li> <li>documentId</li> <li>documentType</li> <li>documentTypeId</li> <li>downloadEnabled</li> <li>draft</li> <li>expirationDate</li> <li>expires</li> <li>iconId</li> <li>imutable</li> <li>indexed</li> <li>inheritSecurity</li> <li>isEncrypted</li> <li>keyWord</li> <li>lastModifiedDate</li> <li>metaListId</li> <li>metaListRecordId</li> <li>parentDocumentId</li> <li>permissionType</li> <li>phisicalFile</li> <li>phisicalFileSize</li> <li>privateDocument</li> <li>protectedCopy</li> <li>publisherId</li> <li>restrictionType</li> <li>rowId</li> <li>securityLevel</li> <li>topicId</li> <li>translated</li> <li>UUID</li> <li>updateIsoProperties</li> <li>userNotify</li> <li>validationStartDate</li> <li>version</li> <li>versionDescription</li> <li>volumeId</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getRelatedDocuments</p></td> <td class="confluenceTd"><p>Returns all the documents related to a document.</p> <p> </p> <p>Method:</p> <p>getRelatedDocuments(String user, String password, int companyId, int nrDocumentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: document number.</li> <li>version: document version number.</li> </ul> <p> </p> <p>Return: RelatedDocumentDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li>companyId</li> <li>documentId</li> <li>relatedDocumentId</li> <li>version</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getReportSubjectId</p></td> <td class="confluenceTd"><p>Returns the report subject code within Fluig.</p> <p> </p> <p>Method:</p> <p>getReportSubjectId(String user, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: int.</p></td> </tr> <tr> <td class="confluenceTd"><p>getSecurity</p></td> <td class="confluenceTd"><p>Returns a document security.</p> <p> </p> <p>Method:</p> <p>getSecurity(String user, String password, int company, int nrDocumentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: document number.</li> <li>version: document version number.</li> </ul> <p> </p> <p>Return: DocumentSecurityConfigDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li>attributionType</li> <li>attributionValue</li> <li>companyId</li> <li>documentId</li> <li>permission</li> <li>securityLevel</li> <li>sequence</li> <li>showContent</li> <li>version</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getUserPermissions</p></td> <td class="confluenceTd"><p>Returns the user permissions over a document.</p> <p> </p> <p>Method:</p> <p>getUserPermissions(int companyId, String user, int nrDocumentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>nrDocumentId: document number.</li> <li>version: document version number.</li> </ul> <p> </p> <p>Return: Integer.</p> <p> </p> <p>Return Attributes:</p> <ul> <li>result</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>moveDocument</p></td> <td class="confluenceTd"><p>Moves documents to the target folder.</p> <p> </p> <p>Method:</p> <p>moveDocument(String user, String password, int companyId, int[] documentIds, String colleagueId, int destfolder)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentIds: list with document numbers that will be moved.</li> <li>colleagueId: registration of the user with permission to move the document</li> <li>destFolder: target folder number.</li> </ul> <p>Return: String[]</p></td> </tr> <tr> <td class="confluenceTd"><p>removeSecurity</p></td> <td class="confluenceTd"><p>Removes a document security.</p> <p> </p> <p>Method:</p> <p>removeSecurity(String user, String password, int companyId, int documentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: document number.</li> <li>version: document version number.</li> </ul> <p> </p> <p>Return: There is no return.</p></td> </tr> <tr> <td class="confluenceTd"><p>restoreDocument</p></td> <td class="confluenceTd"><p>Restores a document from the bin.</p> <p> </p> <p>Method:</p> <p>restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: number of the document that will be restored.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateDocument</p></td> <td class="confluenceTd"><p>Changes a document.</p> <p> </p> <p>Method:</p> <p>updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docDtos: document that will be changed.</li> <li>attachs: file attached to change.</li> <li>docSecurity: security of the document that will be changed.</li> <li>docApprovers: approvers of document that will be changed.</li> <li>relDocs: documents related to the document that will be changed.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateDocumentWithApprovementLevels</p></td> <td class="confluenceTd"><p>Changes a document with approval level.</p> <p> </p> <p>Methods:</p> <p>updateDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecutiry, ApproverWithLevelDto[]  docApprovers, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docDtos: document that will be changed.</li> <li>attachs: file attached to change.</li> <li>docSecurity: security of the document that will be changed.</li> <li>docApprovers: approval level in which document approvers are inserted.</li> <li>levels: approval levels that the document will have.</li> <li>relDocs: documents related to the document that will be changed.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateGroupSecurityType</p></td> <td class="confluenceTd"><p>Modifies the group security type in the permission and restriction. There are two options that will be represented by an integer:</p> <p>0 - ALL group users.</p> <p>1 - ONLY group common users.</p> <p> </p> <p>Method:</p> <p>updateGroupSecurityType(String user, String password, int companyId, int documentId, int version, int permissionType, int restrictionType, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: integration user code.</li> <li>password: integration user password.</li> <li>companyId: company code.</li> <li>documentId: document code.</li> <li>version: document version.</li> <li>permissionType: type of permission (0 - ALL group users / 1 - ONLY group common users)</li> <li>restrictionType: type of restriction (0 - ALL group users / 1 - ONLY group common users)</li> <li>colleagueId: user registration</li> </ul> <p> </p> <p>Return: WebServiceMessage[] </p></td> </tr> <tr> <td class="confluenceTd"><p>updateSimpleDocument</p></td> <td class="confluenceTd"><p>Changes a document in a simple way.</p> <p> </p> <p>Method:</p> <p>updateSimpleDocument(String username, String password, int companyId, int documentId, String publisherId, String documentDescription, Attachment[] attachments)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: integration user login.</li> <li>password: integration user password.</li> <li>companyId: company code.</li> <li>documentId: number of the document that will be changed.</li> <li>publisherId: user registration that will change the document.</li> <li>documentDescription: document description.</li> <li>attachments: files attached to change.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>validateIntegrationRequirements</p></td> <td class="confluenceTd"><p>Checks user integration in Fluig.</p> <p> </p> <p>Method:</p> <p>validateIntegrationRequirements (String user, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 14: DocumentService methods</strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.11">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/DocumentServiceClient.java?version=2&modificationDate=1426272589338&api=v2">DocumentServiceClient.java</a> class, it exemplifies the use of the main methods of the DocumentService class. </p> <div class="aui-message hint shadowed information-macro"> <p class="title">Note</p> <span class="aui-icon icon-hint">Icon</span> <div class="message-content"> <div> Some fields, among which <em>Approved</em>, <em>ApprovedDate</em>, <em>CreateDate</em>, <em>LastModifiedDate</em>, although they appear in the example provided, they cannot be modified, since they are system internal use fields. </div> <div>The fields are kept in the Document object, since they are required to recover this information.</div> </div> </div> <div class="aui-message hint shadowed information-macro"> <p class="title">Integrations</p> <span class="aui-icon icon-hint">Icon</span> <div class="message-content"> <p>For the document creation methods (createDocument, createSimpleDocument, etc...), you can use a user for authentication and another for post, since you may need to validate the permission of another user when creating the document in Fluig.</p> <p>In this case, when the file to be posted is not sent in the request (filecontent field of the Attachment parameter), you can get it in the publisher user upload folder or from the user used to authenticate in Fluig through WS. In order to do that, the document should be in the upload folder of the provided user, which can be done through FTP. This can be useful in integrations that use the same user (integrator) to authenticate in FTP and services.</p> </div> </div> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMFavoritesService">ECMFavoritesService</h1> <p>Webservice responsible for interacting with Fluig favorite documents and processes. It can be used to search the favorite documents and processes of each user.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.13">Methods</h4> <span id='content_15' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>addDocumentToFavorites</p></td> <td class="confluenceTd"><p>Adds a document to the provided user favorites.</p> <p> </p> <p>Method:</p> <p align="left">addDocumentToFavorites(String username, String password, int companyId, int nrDocument, int nrVersao,  String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocument: document number</li> <li>nrVersao: document version</li> <li>colleagueId: user registration.</li> </ul> <p align="left"> </p> <p align="left">Return: void.</p></td> </tr> <tr> <td class="confluenceTd"><p>addProcessToFavorites</p></td> <td class="confluenceTd"><p>Adds a process to the provided user favorites.</p> <p> </p> <p>Method:</p> <p>addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code</li> <li>colleagueId: user registration.</li> </ul> <div>Return: void.</div></td> </tr> <tr> <td class="confluenceTd"><p>findFavorites</p></td> <td class="confluenceTd"><p>Returns the user favorite documents.</p> <p> </p> <p>Method:</p> <p>findFavorites(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findFavoritesOnDemand</p></td> <td class="confluenceTd"><p>Returns the user favorite documents, paged.</p> <p> </p> <p>Method:</p> <p>findFavoritesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findFavoritesProcess</p></td> <td class="confluenceTd"><p>Returns the user favorite processes.</p> <p> </p> <p>Method:</p> <p>findFavoritesProcess (String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: ProcessDefinitionVersionDto[] .</p></td> </tr> <tr> <td class="confluenceTd"><p>findFavoritesProcessOnDemand</p></td> <td class="confluenceTd"><p>Returns the user favorite processes, paged.</p> <p> </p> <p>Method:</p> <p>findFavoritesProcess (String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: ProcessDefinitionVersionDto[] .</p></td> </tr> <tr> <td class="confluenceTd"><p>isFavoriteDocument</p></td> <td class="confluenceTd"><p>Checks if document is favorite.</p> <p> </p> <p>Method:</p> <p>isFavoriteDocument(String username, String password, int companyId, int nrDocument, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: integration user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocument: document code.</li> <li>colleagueId: user registration.</li> </ul> <p align="left"> </p> <p align="left">Return: Boolean.</p></td> </tr> <tr> <td class="confluenceTd"><p>removeFavoriteDocument</p></td> <td class="confluenceTd"><p>Removes a document from the provided user favorites.</p> <p> </p> <p>Method:</p> <p align="left">removeFavoriteDocument (String username, String password, int companyId, int nrDocument,  String colleagueId)</p> <p align="left"> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocument: document number</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: void.</p></td> </tr> <tr> <td class="confluenceTd"><p>removeFavoriteProcess</p></td> <td class="confluenceTd"><p>Removes a process from the provided user favorites.</p> <p> </p> <p>Method:</p> <p>addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: void.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 15: FavoritesService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.12">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/FavoritesServiceClient.java?version=2&modificationDate=1426272592293&api=v2">FavoritesServiceClient.java</a> class, it exemplifies the use of the main methods of the FavoritesService class. </p> <p> </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMFolderService">ECMFolderService</h1> <p>Webservice responsible for performing operations related to folders in Fluig. It can be used to create, change, delete and search folders, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.14">Methods</h4> <span id='content_16' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createFolder</p></td> <td class="confluenceTd"><p>Creates a folder.</p> <p> </p> <p>Method:</p> <p>createFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers )</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docdtos: folder that will be created.</li> <li>docsecurity: folder security.</li> <li>docapprovers: folder approvers.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>createFolderWithApprovementLevels</p></td> <td class="confluenceTd"><p>Creates a folder with approval level.</p> <p> </p> <p>Method:</p> <p>createFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docdtos: folder that will be created.</li> <li>docsecurity: folder security.</li> <li>docapprovers: approvers in levels.</li> <li>levels: folder approval levels.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>createSimpleFolder</p></td> <td class="confluenceTd"><p>Creates a simple folder.</p> <p> </p> <p>Method:</p> <p>createSimpleFolder(String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>parentDocumentId: parent document number.</li> <li>publisherId: registration of the publisher user.</li> <li>documentDescription: folder description.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>deleteDocument</p></td> <td class="confluenceTd"><p>Deletes a folder and sends it to the bin.</p> <p> </p> <p>Method:</p> <p>deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: folder number.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>destroyDocument</p></td> <td class="confluenceTd"><p>Deletes a folder from the bin.</p> <p> </p> <p>Method:</p> <p>destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: folder number.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>findRecycledDocuments</p></td> <td class="confluenceTd"><p>Returns all the documents from a user's bin.</p> <p> </p> <p>Method:</p> <p>findRecycledDocuments(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getApprovers</p></td> <td class="confluenceTd"><p>Returns the approvers of a folder.</p> <p> </p> <p>Method:</p> <p>getApprovers(String user, String password, int companyId, int nrDocumentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: folder number.</li> </ul> <p> </p> <p>Return: ApproverWithLevelDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getChildren</p></td> <td class="confluenceTd"><p>Returns all the documents of a folder.</p> <p> </p> <p>Method:</p> <p>getChildren(String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: folder number.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getFolder</p></td> <td class="confluenceTd"><p>Returns a folder.</p> <p> </p> <p>Method:</p> <p>getFolder(String user, String password, int companyId, int nrDocumentId, String colleagueId )</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: folder number.</li> <li>colleagueId: source user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getPrivateChildren</p></td> <td class="confluenceTd"><p>Returns all the documents of a private folder.</p> <p> </p> <p>Method:</p> <p>getPrivateChildren(String user, String password, int companyId, int parentDocumentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: folder number.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p> <p> </p></td> </tr> <tr> <td class="confluenceTd"><p>getRootFolders</p></td> <td class="confluenceTd"><p>Returns the root folders that a user has access to, expect the private folder.</p> <p> </p> <p>Method:</p> <p>getRootFolders(String user, String password, int companyId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getSecurity</p></td> <td class="confluenceTd"><p>Returns a folder security.</p> <p> </p> <p>Method:</p> <p>getSecurity(String user, String password, int companyId, int nrDocumentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: folder number.</li> </ul> <p> </p> <p>Return: DocumentSecurityConfigDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getSubFolders</p></td> <td class="confluenceTd"><p>Returns all the subfolders and files of a folder.</p> <p> </p> <p>Method:</p> <p>getSubFolders(String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: folder number.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getSubFoldersOnDemand</p></td> <td class="confluenceTd"><p>Returns all the sub-folders and files of a folder, paged.</p> <p> </p> <p>Method:</p> <p>getSubFoldersOnDemand(int companyId, String user, String password, int documentId, boolean privatefolder, String[] documenttypes, int limit , int lastRowId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user login.</li> <li>password: user password.</li> <li>documentId: folder number.</li> <li>privatefolder: identifies if it is a private folder.</li> <li>documenttypes: folder document types.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getSubFoldersPermission</p></td> <td class="confluenceTd"><p>Returns all the sub-folders where the user has the provided permission.</p> <p> </p> <p>Method:</p> <p>getSubFoldersPermission(String user, String password, int companyId, int documentId, String colleagueId, int permission)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: private folder number.</li> <li>colleagueId: user registration.</li> <li>permission: permission over the folder.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getSubPrivateFolders</p></td> <td class="confluenceTd"><p>Returns all sub-folders of a private folder.</p> <p> </p> <p>Method:</p> <p>getSubPrivateFolders(String colleagueId, String password, int companyId, int documentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>colleagueId: user registration.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: private folder number.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getUserPermissions</p></td> <td class="confluenceTd"><p>Returns the permission of a user over a folder.</p> <p> </p> <p>Method:</p> <p>getUserPermissions(int companyId, String user, int nrDocumentId, int version)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>user: user registration.</li> <li>nrDocumentId: folder number.</li> <li>version: folder version.</li> </ul> <p> </p> <p>Return: Integer.</p></td> </tr> <tr> <td class="confluenceTd"><p>restoreDocument</p></td> <td class="confluenceTd"><p>Restores a folder from the bin.</p> <p> </p> <p>Method:</p> <p>restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: folder number.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateFolder</p></td> <td class="confluenceTd"><p>Changes a folder.</p> <p> </p> <p>Method:</p> <p>updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docdtos: folder that will be changed.</li> <li>docsecurity: folder security.</li> <li>docapprovers: folder approvers.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateFolderWithApprovementLevels</p></td> <td class="confluenceTd"><p>Changes a folder with approval level.</p> <p> </p> <p>Method:</p> <p>updateFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docdtos: folder that will be changed.</li> <li>docsecurity: folder security.</li> <li>docapprovers: approvers in levels.</li> <li>levels: folder approval levels.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateSimpleFolder</p></td> <td class="confluenceTd"><p>Changes a folder in a simple way.</p> <p> </p> <p>Method:</p> <p>updateSimpleFolder(String user, String Password, int companyId, DocumentDto[] docdtos)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login</li> <li>password: user password</li> <li>companyId: company code</li> <li>docdtos: folder that will be changed.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 16: FolderService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.13">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/FolderServiceClient.java?version=2&modificationDate=1426272592562&api=v2">FolderServiceClient.java</a> class, it exemplifies the use of the main methods of the FolderService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMGlobalParamService">ECMGlobalParamService</h1> <p>Webservice responsible for interacting with the settings of Fluig general parameters. It can be used to create, change and search the general parameters.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.15">Methods</h4> <span id='content_17' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createGlobalParam</p></td> <td class="confluenceTd"><p>Creates general parameters for a company.</p> <p> </p> <p>Method:</p> <p>createGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>global: company general parameters.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getGlobalParam</p></td> <td class="confluenceTd"><p>Returns the general parameters of a company.</p> <p> </p> <p>Method:</p> <p>getGlobalParam(String username, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: GlobalParamDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getVolumes</p></td> <td class="confluenceTd"><p>Returns the company volumes.</p> <p> </p> <p>Method:</p> <p>getVolumes(String user, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: VolumeDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateConfigurations</p></td> <td class="confluenceTd"><p>Changes the system settings.</p> <p> </p> <p> Method:<br /> updateConfigurations( String username,String password, int companyId, String dbDriver, String dbUser, String dbPassword, String dbServer,<br /> String dbPort,String dbScheme, String dbInstance, String emailServer, String emailPort, String emailSender, boolean emailDefaultSender, String emailUser, String emailPassword, boolean emailTLS,String paramsRMTPTPort, String lsType, String paramsLSHost, String paramsLSPort, String paramsOpenOfficeDir, String paramsOpenOfficePorts, String portsSetName) </p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>dbDriver: database driver (MySql- com.mysql.jdbc.Driver. SQLServer - net.sourceforge.jtds.jdbc.Driver. Oracle -oracle.jdbc.driver.OracleDriver)</li> <li>dbUser: database username.</li> <li>dbPassword: database password.</li> <li>dbServer: database connection server.</li> <li>dbPort: database server port.</li> <li>dbScheme: database.</li> <li>dbInstance: database instance, used for SQLServer, if it is not the case of passing blank ("").</li> <li>mailServer: SMTP server name.</li> <li>emailSender: product default sender email.</li> <li>emailPort: SMTP server port.</li> <li>emailDefaultSender:</li> <li>emailUser: email user, only if the server needs authentication.</li> <li>emailPassword: email password, only if the server needs authentication.</li> <li>emailTLS: server will use encrypting whrn sending email (true/false)</li> <li>paramsRMTPTPort: port used by Flex.</li> <li>lsType: type of license used, LM/LS.</li> <li>paramsLSHost: license server.</li> <li>paramsLSPort: license server port.</li> <li>paramsOpenOfficeDir: OpenOffice install directory</li> <li>paramsOpenOfficePorts: port used by OpenOffice</li> <li>portsSetName: port used by the system (ports-default, ports-01, ports-02)</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>updateGlobalParam</p></td> <td class="confluenceTd"><p>Changes general parameters of a company.</p> <p> </p> <p>Method:</p> <p>updateGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>global: company general parameters.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 17: GlobalParamService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.14">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/GlobalParamServiceClient.java?version=2&modificationDate=1426272593228&api=v2">GlobalParamServiceClient.java</a> class, it exemplifies the use of the main methods of the GlobalParamService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMGroupService">ECMGroupService</h1> <p>Webservice responsible for performing operations related to groups in Fluig. It can be used to create, change, delete and search groups, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.16">Methods</h4> <span id='content_18' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createGroup</p></td> <td class="confluenceTd"><p>Creates a group in Fluig.</p> <p> </p> <p>Method:</p> <p>createGroup(String username, String password, int companyId, GroupDto[] grupos)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>grupos: group that will be created.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>deleteGroup</p></td> <td class="confluenceTd"><p>Deletes a group from Fluig.</p> <p> </p> <p>Method:</p> <p>deleteGroup(String username, String password, int companyId, String groupId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>GroupId: group code.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getGroup</p></td> <td class="confluenceTd"><p>Returns a group registered in Fluig.</p> <p> </p> <p>Method:</p> <p>getGroups(String username, String password, int companyId, String groupId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>groupId: group code.</li> </ul> <p> </p> <p>Return: GroupDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>companyId</p></li> <li><p>groupDescription</p></li> <li><p>groupId</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getGroups</p></td> <td class="confluenceTd"><p>Returns all the groups registered in Fluig.</p> <p> </p> <p>Method:</p> <p>getGroups(String username, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: GroupDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>companyId</p></li> <li><p>groupDescription</p></li> <li><p>groupId</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getGroupsByDescription</p></td> <td class="confluenceTd"><p>returns a group by description.</p> <p> </p> <p>Method:</p> <p>getGroupsByDescription(String username, String password, int companyId, String desc)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>desc: group description.</li> </ul> <p> </p> <p>Return: GroupDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li><p>companyId</p></li> <li><p>groupDescription</p></li> <li><p>groupId</p></li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getOcurrenceByKey</p></td> <td class="confluenceTd"><p>Returns if there is safety configuration for assignment and assignment value.</p> <p> </p> <p>Method:</p> <p>getOcurrenceByKey(String username, String password, int companyId, int pIdiAtribuic, String pDesValAtribuic)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>pIdiAtribuic: assignment code.</li> <li>pDesValAtribuic: assignment value.</li> </ul> <p> </p> <p>Return: boolean.</p></td> </tr> <tr> <td class="confluenceTd"><p>updateGroup</p></td> <td class="confluenceTd"><p>Changes a group in Fluig.</p> <p> </p> <p>Method:</p> <p>updateGroup(String username, String password, int companyId, GroupDto[] grupos)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>grupos: group that will be changed.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 18: GroupService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.15">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/GroupServiceClient.java?version=2&modificationDate=1426272593728&api=v2">GroupServiceClient.java</a> class, it exemplifies the use of the main methods of the GroupService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMOutstandingService">ECMOutstandingService</h1> <p> Webservice responsible for interacting with the Fluig pending transfers. It can be used to transfer pending from a user to another user.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.17">Methods </h4> <span id='content_19' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>transfer</p></td> <td class="confluenceTd"><p>Transfers pending of a user to another user.</p> <p> </p> <p>Method:</p> <p>transfer(String user, String password, int companyId, String colleagueIdFrom, String colleagueIdTo, String[] parameters)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueIdFrom: source user registration (its pending will be transfered to the target user).</li> <li>colleagueIdTo: target user registration (it will receive pending from source user).</li> <li>parameters: pending array that will be transfered to the target user.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 19: OutstandingService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <p> <span style="color: rgb(0, 0, 0);"><br /></span> </p> <p> <span style="color: rgb(0, 0, 0);">Use example</span> </p> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/OutstandingServiceClient.java?version=2&modificationDate=1426272593907&api=v2">OutstandingServiceClient.java</a> class, it exemplifies the use of the main methods of the OutstandingService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMReportService">ECMReportService</h1> <p> Webservice responsible for performing operations related to reports in Fluig. It can be used to create, change, delete and search reports, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.18">Methods</h4> <span id='content_20' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createSimpleReport</p></td> <td class="confluenceTd"><p>Creates a report in a simplified manner in Fluig.</p> <p> </p> <p>Method:</p> <p>createSimpleReport(String username, String password, int companyId, int parentDocId, String reportDescription, Attachment[] attachments)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>parentDocId: parent folder code.</li> <li>reportDescription: report description.</li> <li>attachments: report attachments.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getActiveReport</p></td> <td class="confluenceTd"><p>Returns an active report in Fluig.</p> <p> </p> <p>Method:</p> <p>getActiveReport(int companyId, String username, String password, String documentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>username: user login.</li> <li>password: user password.</li> <li>documentId: document code.</li> </ul> <p> </p> <p>Return: DocumentDto.</p></td> </tr> <tr> <td class="confluenceTd"><p>getAttachmentsList</p></td> <td class="confluenceTd"><p>Returns a list of report attachments in Fluig.</p> <p> </p> <p>Method:</p> <p>getAttachmentsList(String username, String password, int companyId, String documentId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>documentId: document code.</li> </ul> <p> </p> <p>Return: String[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getReportContent</p></td> <td class="confluenceTd"><p>Returns the physical file of a report.</p> <p> </p> <p>Method:</p> <p>getReportContent(String username, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String fileName)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>nrDocumentId: document number.</li> <li>colleagueId: user registration.</li> <li>documentoVersao: document version.</li> <li>fileName: file name.</li> </ul> <p> </p> <p>Return: byte[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getRepots</p></td> <td class="confluenceTd"><p>Returns the available reports.</p> <p> </p> <p>Method:</p> <p>getRepots(String username, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: DocumentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>updateSimpleReport</p></td> <td class="confluenceTd"><p>Updates a report in a simplified manner in Fluig.</p> <p> </p> <p>Method:</p> <p>createSimpleReport(String username, String password, int companyId, int docId, String reportDescription, Attachment[] attachments, String versionOption)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>docId: parent folder code.</li> <li>reportDescription: report description.</li> <li>attachments: report attachments.</li> <li>versionOption: informs if you want to update the report version.</li> </ul> <p> </p> <p>Return: WebServiceMessage[].</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 20: ReportService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.16">Use example</h4> <p> Download the <a class="unresolved" href="#">ReportServiceClient.java</a> class, it exemplifies the use of the main methods of the ReportService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMSearchDocumentService">ECMSearchDocumentService</h1> <p>Webservice responsible for performing operations related to searches in Fluig. It can be used to search for documents using simple and advanced search.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.19">Methods</h4> <span id='content_21' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>advancedSearchDocuments</p></td> <td class="confluenceTd"><p>Uses advanced search.</p> <p> </p> <p>Method:</p> <p>advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, boolean  findAllDocumentTypes, boolean  findFolders, boolean  findDocuments, boolean  findCardIndex, boolean  findCards, boolean  findExternalDocument, int  documentParentId, Date  startDate, Date  finalDate)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>content: search content.</li> <li>findAllDocumentTypes: indicates if all document types should be searched.</li> <li>findFolders: indicates if folders should be searched.</li> <li>findDocuments: indicates if documents should be searched.</li> <li>findCardIndex: indicates if card index should be searched.</li> <li>findCards: indicates if card index should be searched.</li> <li>findExternalDocument: indicates if external documents should be searched.</li> <li>documentParentId: parent document number.</li> <li>startDate: start date.</li> <li>finalDate: final date.</li> </ul> <p> </p> <p>Return: SearchResultDto[].</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">advancedSearchDocumentsWithMetadata</td> <td colspan="1" class="confluenceTd"><p>Uses advanced search through metadata options and customized fields.</p> <p> </p> <p>Method:</p> <p>advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, SearchFields[] metadata, SearchFields[] customfields, boolean  findAllDocumentTypes, boolean  findFolders, boolean  findDocuments, boolean  findCardIndex, boolean  findCards, boolean  findExternalDocument, int  documentParentId, Date  startDate, Date  finalDate)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>content: search content.</li> <li>metadata: information for search from metadata.</li> <li>customfields: information for search from custom fields.</li> <li>findAllDocumentTypes: indicates if all document types should be searched.</li> <li>findFolders: indicates if folders should be searched.</li> <li>findDocuments: indicates if documents should be searched.</li> <li>findCardIndex: indicates if card index should be searched.</li> <li>findCards: indicates if card index should be searched.</li> <li>findExternalDocument: indicates if external documents should be searched.</li> <li>documentParentId: parent document number.</li> <li>startDate: start date.</li> <li>finalDate: final date.</li> </ul> <p> </p> <p>Return: SearchResultDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>searchDocuments</p></td> <td class="confluenceTd"><p>Uses simple search.</p> <p> </p> <p>Method:</p> <p>searchDocuments(String user, String password, int companyId, String colleagueId, String content)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>content: search content.</li> </ul> <p> </p> <p>Return: SearchResultDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>searchFavoritesDocuments</p></td> <td class="confluenceTd"><p>Searches favorite documents.</p> <p> </p> <p>Method:</p> <p>searchFavoritesDocuments(String user, String Password, int companyId, String colleagueId, String content)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>contente: content to be searched</li> </ul> <p> </p> <p>Return: SearchResultDto[]</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 21: SearchDocumentService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.17">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/SearchDocumentServiceClient.java?version=2&modificationDate=1426272594411&api=v2">SearchDocumentServiceClient.java</a> class, it exemplifies the use of the main methods of the SearchDocumentService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMSignalService">ECMSignalService</h1> <p>Webservice responsible for interacting with signals created in Fluig. It can be used to create, remove, send signals or query existing signals.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.20">Methods</h4> <span id='content_22' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createSignal</p></td> <td class="confluenceTd"><p>Creates a signal in Fluig.</p> <p> </p> <p>Method:</p> <p>createSignal(String login, String password, int companyId, String description)</p> <p> </p> <p>Parameters:</p> <ul> <li>login: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>description: signal description.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd"><p>deleteSignal</p></td> <td colspan="1" class="confluenceTd"><p>Remove a signal created in Fluig.</p> <p> </p> <p>Method:</p> <p>deleteSignal(String login, String password, int companyId, int signalId)</p> <p> </p> <p>Parameters:</p> <ul> <li>login: login of the user that will be generated by token.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>signalId: signal code.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd"><p>fireSignal</p></td> <td colspan="1" class="confluenceTd"><p>Sends/Triggers existing signals.</p> <p> </p> <p>Method:</p> <p> fireSignal (String login, <span>String password,</span> int companyId, int signalId) </p> <p> </p> <p>Parameters:</p> <ul> <li>login: login of the user that will be generated by token.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>signalId: signal code.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getSignals</p></td> <td class="confluenceTd"><p>Returns the existing signals in Fluig.</p> <p> </p> <p>Method:</p> <p> getSignals(<span>String login, String password, int companyId</span>) </p> <p> </p> <p>Parameter:</p> <ul> <li>login: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: Signal[].</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 22: SignalService method.</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.18">Use example</h4> <p> Download the <a href="attachments/73084007/161480877.java">SignalServiceClient.java</a> class, it exemplifies the use of the main methods of the SignalService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMTokenService">ECMTokenService</h1> <p>Webservice responsible for interacting with the Fluig token. It can be used to search and validate the existing tokens.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.21">Methods</h4> <span id='content_23' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>getToken</p></td> <td class="confluenceTd"><p>Returns the security token.</p> <p> </p> <p>Method:</p> <p>getToken(String login, String password)</p> <p> </p> <p>Parameters:</p> <ul> <li>login: user login.</li> <li>password: user password.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd"><p>getTokenByLogin</p></td> <td colspan="1" class="confluenceTd"><p>Returns a security token for the requested login.</p> <p> </p> <p>Method:</p> <p>getTokenByLogin(int companyId, String colleagueId, String password, String login)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>colleagueId: user registration.</li> <li>password: user password.</li> <li>login: login of the user that will be generated by token.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd"><p>getTokenEmail</p></td> <td colspan="1" class="confluenceTd"><p>Returns a security token for the requested email.</p> <p> </p> <p>Method:</p> <p>getTokenEmail(int companyId, String email, String password)</p> <p> </p> <p>Parameters:</p> <ul> <li>companyId: company code.</li> <li>email: user email.</li> <li>password: user password.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>validateToken</p></td> <td class="confluenceTd"><p>Validates the security token and returns the user login.</p> <p> </p> <p>Method:</p> <p>validateToken(String token)</p> <p> </p> <p>Parameter:</p> <ul> <li>token: user token.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 23: TokenService methods.</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.19">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/TokenServiceClient.java?version=2&modificationDate=1426272594760&api=v2">TokenServiceClient.java</a> class, it exemplifies the use of the main methods of the TokenService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMWorkflowEngineService">ECMWorkflowEngineService</h1> <p>Webservice responsible for performing operations related to workflow in Fluig. It can be used to handle requests, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.22">Methods</h4> <span id='content_24' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>calculateDeadLineHours</p></td> <td class="confluenceTd"><p align="left">Calculates the deadline from a date based on the working hours and holidays registered in the product passing the deadline in hours.</p> <p align="left"> </p> <p align="left">Method:</p> <p align="left">calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)</p> <p align="left"> </p> <p align="left">Parameters:</p> <ul> <li>username - Integration user</li> <li>password - Integration Password</li> <li>companyId - Company code</li> <li>userId - User registration</li> <li>data - date (String type in the "yyyy-MM-dd" format).</li> <li>segundos - Number of seconds after midnight</li> <li>prazo - Deadline that will be applied in hours (int variable).</li> <li>periodId - Working Hours Code</li> </ul> <p> </p> <p>Return: DeadLineDto object that contains variables with date and time.</p></td> </tr> <tr> <td class="confluenceTd"><p>calculateDeadLineTime</p></td> <td class="confluenceTd"><p align="left">Calculates the deadline from a date based on the working hours and holidays registered in the product passing the deadline in minutes.</p> <p align="left"> </p> <p align="left">Method:</p> <p align="left">calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)</p> <p align="left"> </p> <p align="left">Parameters:</p> <ul> <li>username - Integration user</li> <li>password - Integration Password</li> <li>companyId - Company code</li> <li>userId - User registration</li> <li>data - date (String type in the "yyyy-MM-dd" format).</li> <li>segundos - Number of seconds after midnight</li> <li>prazo - Deadline that will be applied in minutes (int variable).</li> <li>periodId - Working Hours Code</li> </ul> <p> </p> <p>Return: DeadLineDto object that contains variables with date and time.</p></td> </tr> <tr> <td class="confluenceTd"><p>cancelInstance</p></td> <td class="confluenceTd"><p>Cancels a request.</p> <p> </p> <p>Method:</p> <p>cancelInstance(String user, String password, int companyId, int processInstanceId, String userId, String cancelText)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>userId: user registration.</li> <li>cancelText: cancellation comments.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>cancelInstanceByReplacement</p></td> <td class="confluenceTd"><p>Cancels a request using the substitute user.</p> <p> </p> <p>Method:</p> <p>cancelInstanceByReplacement(String user, String password, int companyId, int processInstanceId, String userId, String cancelText, String replacementId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>userId: user registration.</li> <li>cancelText: cancellation comments.</li> <li>replacementId: substitute user registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">createWorkFlowProcessVersion</td> <td colspan="1" class="confluenceTd"><p>Creates a new version of the workflow process.</p> <p> </p> <p>Method:</p> <p>createWorkFlowProcessVersion(String user, String password, int companyId, int processId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: request number.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>exportProcess</p></td> <td class="confluenceTd"><p align="left">Returns the selected process in a String.</p> <p align="left"> </p> <p align="left">Method:</p> <p align="left"> <em>exportProcess</em> (String username, String password, int companyId, String processId) </p> <p align="left"> </p> <p align="left">Parameters:</p> <ul> <li>username - Integration user</li> <li>password - Integration Password</li> <li>companyId - Company code</li> <li>processId - Process code<br /> <br /></li> </ul> <p align="left">Return: String that contains the process definition.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">exportProcessInZipFormat</td> <td colspan="1" class="confluenceTd"><p align="left">Returns the selected process in the zip format.</p> <p align="left"> </p> <p align="left">Method:</p> <p align="left">exportProcessInZipFormat(String username, String password, int companyId, String processId)</p> <p align="left"> </p> <p align="left">Parameters:</p> <ul> <li>username - Integration user</li> <li>password - Integration Password</li> <li>companyId - Company code</li> <li>processId - Process code<br /> <br /></li> </ul> <p align="left">Return: byte[] that contains the process definition.</p></td> </tr> <tr> <td class="confluenceTd"><p>getActualThread</p></td> <td class="confluenceTd"><p>Returns the thread sequence of a request.</p> <p> </p> <p>Method:</p> <p>getActualThread(String user, String password, int companyId, int processInstanceId, int stateSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> <li>stateSequence: state sequence.</li> </ul> <p> </p> <p>Return: int.</p></td> </tr> <tr> <td class="confluenceTd"><p>getAllActiveStates</p></td> <td class="confluenceTd"><p>Returns the activity number where the request is.</p> <p> </p> <p>Method:</p> <p>getAllActiveStates(String user, String password, int companyId, String userId, int processInstanceId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> <li>processInstanceId: request number.</li> </ul> <p> </p> <p>Return: Integer[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAllProcessAvailableToExport</p></td> <td class="confluenceTd"><p align="left">Returns a list of available processes to be exported.</p> <p align="left"> </p> <p align="left">Method:</p> <p align="left">getAllProcessAvailableToExport (String username, String password, int companyId)</p> <p align="left"> </p> <p align="left">Parameters:</p> <ul> <li>username - Integration user</li> <li>password - Integration Password</li> <li>companyId - Company code</li> </ul> <p align="left"> </p> <p align="left">Return: ProcessDefinitionDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAllProcessAvailableToImport</p></td> <td class="confluenceTd"><p align="left">Returns a list of available processes to be imported.</p> <p align="left"> </p> <p align="left">Method:</p> <p align="left">getAllProcessAvailableToImport (String username, String password, int companyId)</p> <p align="left"> </p> <p align="left">Parameters:</p> <ul> <li>username - Integration user</li> <li>password - Integration Password</li> <li>companyId - Company code</li> </ul> <p align="left"> </p> <p align="left">Return: ProcessDefinitionDto[]</p></td> </tr> <tr> <td class="confluenceTd"><p>getAttachments</p></td> <td class="confluenceTd"><p>Returns a request attachments.</p> <p> </p> <p>Method:</p> <p>getAttachments(String user, String password, int companyId, String userId, int processInstanceId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> <li>processInstanceId: request number.</li> </ul> <p> </p> <p>Return: ProcessAttachmentDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableProcess</p></td> <td class="confluenceTd"><p>Returns the processes the user can start in a request.</p> <p> </p> <p>Method:</p> <p>getAvailableProcess(String username, String password, int companyId, String userId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> </ul> <p> </p> <p>Return: ProcessDefinitionVersionDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableProcessOnDemand</p></td> <td class="confluenceTd"><p>Returns the processes the user can start in a request, paged.</p> <p> </p> <p>Method:</p> <p>getAvailableProcessOnDemand(String username, String password, int companyId, String userId, int limit, int lastRowId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> <li>limit: number of records to be returned.</li> <li>lastRowId: last line returned.</li> </ul> <p> </p> <p>Return: ProcessDefinitionVersionDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableStates</p></td> <td class="confluenceTd"><p>Returns the number of the next activity of a request.</p> <p> </p> <p>Method:</p> <p>getAvailableStates(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>processInstanceId: request number.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> </ul> <p> </p> <p>Return: Integer[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableStatesDetail</p></td> <td class="confluenceTd"><p>Returns details on the activities available for selection.</p> <p> </p> <p>Method:</p> <p>getAvailableStatesDetail(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>processInstanceId: request number.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> </ul> <p> </p> <p>Return: ProcessStateDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableUsers</p></td> <td class="confluenceTd"><p>Returns users who can run the current task of a request.</p> <p> </p> <p>Method:</p> <p>getAvailableUsers(String username, String password, int companyId, int processInstanceId, int state, int threadSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>state: activity number.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> </ul> <p> </p> <p>Return: String[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableUsersOnDemand</p></td> <td class="confluenceTd"><p>Returns users who can run the current task of a request, paged and with search.</p> <p> </p> <p>Method:</p> <p>getAvailableUsersOnDemand(String username, String password, int companyId, int processInstanceId, int state, int threadSequence, int limit, int initialUser, String userSearch)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>state: activity number.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> <li>limit: number of records to be returned.</li> <li>initialUser: last returned line.</li> <li>userSearch: text to be searched.</li> </ul> <p> </p> <p>Return: AvailableUsersDto.</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableUsersStart</p></td> <td class="confluenceTd"><p>Returns the users available in opening a request.</p> <p> </p> <p>Method:</p> <p>getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>state: activity number.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> </ul> <p> </p> <p>Return: String[].</p></td> </tr> <tr> <td class="confluenceTd"><p>getAvailableUsersStartOnDemand</p></td> <td class="confluenceTd"><p>Returns the users available in opening a request, paged and with search.</p> <p> </p> <p>Method:</p> <p>getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence, int limit, int initialUser, String userSearch)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>state: activity number.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> <li>limit: number of records to be returned.</li> <li>initialUser: last returned line.</li> <li>userSearch: text to be searched.</li> </ul> <p> </p> <p>Return: AvailableUsersDto.</p></td> </tr> <tr> <td class="confluenceTd"><p>getCardValue</p></td> <td class="confluenceTd"><p>Returns the value of a form field.</p> <p> </p> <p>Method:</p> <p>getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>userId: user registration.</li> <li>cardFieldName: form field name.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getHistories</p></td> <td class="confluenceTd"><p align="left">Returns list of histories of a process.</p> <p align="left"> </p> <p align="left">Method:</p> <p align="left">getHistories (String username, String password, int companyId)</p> <p align="left"> </p> <p align="left">Parameters:</p> <ul> <li>username - Integration user</li> <li>password - Integration Password</li> <li>companyId - Company code</li> <li>userId - User registration</li> <li>processInstanceId - workflow request number</li> </ul> <p align="left"> </p> <p align="left">Return: ProcessHistoryDto[].</p> <p align="left"> </p></td> </tr> <tr> <td class="confluenceTd"><p>getInstanceCardData</p></td> <td class="confluenceTd"><p>Returns a request form field values.</p> <p> </p> <p>Method:</p> <p>getInstanceCardData(String user, String password, int companyId, String userId, int processInstanceId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> <li>processInstanceId: request number.</li> </ul> <p> </p> <p>Return: String[][].</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">getProcessFormId</td> <td colspan="1" class="confluenceTd"><p>Returns form code linked to the process.</p> <p> </p> <p>Method:</p> <p>getProcessFormId(String user, String password, int companyId, String userId, int processId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> <li>processId: request number.</li> </ul> <p> </p> <p>Return: int.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">getWorkFlowProcessVersion</td> <td colspan="1" class="confluenceTd"><p>Returns the version of a process.</p> <p> </p> <p>Method:</p> <p>getWorkFlowProcessVersion(String user, String password, int companyId, int processId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: request number.</li> </ul> <p> </p> <p>Return: int.</p></td> </tr> <tr> <td class="confluenceTd"><p>importProcess</p></td> <td class="confluenceTd"><p>Imports workflow processes.</p> <p> </p> <p>Method:</p> <p>importProcess(String user, String password, int companyId, String processId, Attachment file, boolean newProcess, boolean overWrite, String colleagueId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>file: file to be imported.</li> <li>newProcess: indicates if a process should be created or the existing one updated.</li> <li>overWrite: indicates if the existing process activity and flows should be overwritten.</li> <li>colleagueId: user registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">importProcessWithCard</td> <td colspan="1" class="confluenceTd"><p>Imports workflow and form processes.</p> <p> </p> <p>Method:</p> <p>importProcessWithCard(String user, String password, int companyId, String processId, Attachment[] processAttachs, boolean newProcess, boolean overWrite, String colleagueId, int parentDocId, String docDescription, String cardDescription, String datasetName, Attachment[] cardAttachs, CardEventDto[] customEvents, boolean update)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>processAttachs: process attachments.</li> <li>newProcess: indicates if a process should be created or the existing one updated.</li> <li>overWrite: indicates if the existing process activity and flows should be overwritten.</li> <li>colleagueId: user registration.</li> <li>parentDocId: form number.</li> <li>docDescription: description.</li> <li>cardDescription: name.</li> <li>datasetName: dataset name.</li> <li>cardAttachs: attached file.</li> <li>customEvents: events.</li> <li>update: if true, informs that it will be an update.<br /> <br /></li> </ul> <p>Return: String.</p></td> </tr> <tr> <td colspan="1" class="confluenceTd">releaseProcess</td> <td colspan="1" class="confluenceTd"><p>Releases workflow processes.</p> <p> </p> <p>Method:</p> <p>releaseProcess(String user, String password, int companyId, String processId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.<br /> <br /></li> </ul> <div>Return: String.</div></td> </tr> <tr> <td class="confluenceTd"><p>saveAndSendTask</p></td> <td class="confluenceTd"><p>Moves the request to the next activity.</p> <p> </p> <p>Method:</p> <p>saveAndSendTask(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>choosedState: activity number.</li> <li>colleagueIds: user that will receive the task.</li> <li>comments: comments.</li> <li>userId: user registration that will run the task.</li> <li>completeTask: indicates if the task must be completed (true) or only saved (false)</li> <li>attachments: request attachments.</li> <li>cardData: form data.</li> <li>appointment: task appointment.</li> <li>managerMode: indicates if the user is running the task as a process manager.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> </ul> <p> </p> <p>Return: String[][].</p></td> </tr> <tr> <td class="confluenceTd"><p>saveAndSendTaskByReplacement</p></td> <td class="confluenceTd"><p>Moves the request to the next activity using a substitute user.</p> <p> </p> <p>Method:</p> <p>saveAndSendTaskByReplacement (String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence, String replacementId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>choosedState: activity number.</li> <li>colleagueIds: user that will receive the task.</li> <li>comments: comments.</li> <li>userId: user registration that will run the task.</li> <li>completeTask: indicates if the task must be completed (true) or only saved (false)</li> <li>attachments: request attachments.</li> <li>cardData: form data.</li> <li>appointment: task appointment.</li> <li>managerMode: indicates if the user is running the task as a process manager.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> <li>replacementId: substitute user registration.</li> </ul> <p> </p> <p>Return: String[][].</p></td> </tr> <tr> <td class="confluenceTd"><p>saveAndSendTaskClassic</p></td> <td class="confluenceTd"><p>Moves the request to the next activity and returns an object array with key and value.</p> <p> </p> <p>Method:</p> <p>saveAndSendTaskClassic(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>choosedState: activity number.</li> <li>colleagueIds: user that will receive the task.</li> <li>comments: comments.</li> <li>userId: user registration that will run the task.</li> <li>completeTask: indicates if the task must be completed (true) or only saved (false)</li> <li>attachments: request attachments.</li> <li>cardData: form data.</li> <li>appointment: task appointment.</li> <li>managerMode: indicates if the user is running the task as a process manager.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> </ul> <p> </p> <p>Return: KeyValueDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>searchProcess</p></td> <td class="confluenceTd"><p align="left">Searches processes available for initialization.</p> <p align="left"> </p> <p align="left">Method:</p> <p align="left">searchProcess(String user, String Password, int companyId, String colleagueId, String content, boolean favorite)</p> <p align="left"> </p> <p align="left">Parameters</p> <p align="left"> </p> <ul> <li>user - Integration User</li> <li>password - Integration Password</li> <li>companyId - Company code</li> <li>colleagueId - User registration</li> <li>content - name of the process to be searched</li> <li>favorite – search of the list of favorite processes or of the default listing.</li> </ul> <p align="left"> </p> <p align="left">Return: ProcessDefinitionVersionDto[]</p> <p align="left"> </p></td> </tr> <tr> <td class="confluenceTd"><p>setAutomaticDecisionClassic</p></td> <td class="confluenceTd"><p>Selects user(s) and forwards automatic activity.</p> <p> </p> <p>Method:</p> <p>setAutomaticDecisionClassic(String user, String password, int companyId, int processInstanceId, int iTaskAutom, int iTask, int condition, String[] colleagueIds, String comments, String userId, boolean managerMode, int threadSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>iTaskAutom: automatic activity number.</li> <li>iTask: current activity number.</li> <li>condition: automatic activity condition number.</li> <li>colleagueIds: user that will receive the task.</li> <li>comments: comments.</li> <li>userId: user registration that will run the task.</li> <li>managerMode: indicates if the user is running the task as a process manager.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> </ul> <p> </p> <p>Return: KeyValueDto[].</p></td> </tr> <tr> <td class="confluenceTd"><p>setDueDate</p></td> <td class="confluenceTd"><p>Changes the task deadline.</p> <p> </p> <p>Method:</p> <p>setDueDate(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String newDueDate, int timeInSeconds)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>userId: user registration. When it is For a Group or For a Role, it should be passed as follows:<br />Role: "Pool:Role:CodigoDoPapel";<br />Group: "Pool:Group:CodigoDoGrupo". </li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> <li>newDueDate: new task deadline. Example: "2014-08-20".</li> <li>timeInSeconds: amount of seconds after midnight. Example: "32000".</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>setTasksComments</p></td> <td class="confluenceTd"><p>Changes the task comments.</p> <p> </p> <p>Method:</p> <p>setTasksComments(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String comments)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: request number.</li> <li>userId: user registration.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> <li>comments: comments.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>simpleStartProcess</p></td> <td class="confluenceTd"><p>Starts a simple request:</p> <p> </p> <p>Method:</p> <p>simpleStartProcess(String user, String password, int companyId, String processId, String comments, ProcessAttachmentDto[] attachments, String cardData[][])</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>comments: comments.</li> <li>attachments: request attachments.</li> <li>cardData: form data.</li> </ul> <p> </p> <p>Return: String[].</p></td> </tr> <tr> <td class="confluenceTd"><p>startProcess</p></td> <td class="confluenceTd"><p>Starts a request.</p> <p> </p> <p>Method:</p> <p>startProcess(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>choosedState: activity number.</li> <li>colleagueIds: user that will receive the task.</li> <li>comments: comments.</li> <li>userId: user registration that will start the request.</li> <li>completeTask: indicates if the task must be completed (true) or only saved (false)</li> <li>attachments: request attachments.</li> <li>cardData: form data.</li> <li>appointment: task appointment.</li> <li>managerMode: indicates whether the user is starting the request as a process manager.</li> </ul> <p> </p> <p>Return: String[][].</p></td> </tr> <tr> <td class="confluenceTd"><p>startProcessClassic</p></td> <td class="confluenceTd"><p>Starts a request and returns an object array with key and value.</p> <p> </p> <p>Method:</p> <p>startProcessClassic(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processId: process code.</li> <li>choosedState: activity number.</li> <li>colleagueIds: user that will receive the task.</li> <li>comments: comments.</li> <li>userId: user registration that will start the request.</li> <li>completeTask: indicates if the task must be completed (true) or only saved (false)</li> <li>attachments: request attachments.</li> <li>cardData: form data.</li> <li>appointment: task appointment.</li> <li>managerMode: indicates whether the user is starting the request as a process manager.</li> </ul> <p> </p> <p>Return: String[][].</p></td> </tr> <tr> <td class="confluenceTd"><p>takeProcessTask</p></td> <td class="confluenceTd"><p>Assumes a task.</p> <p> </p> <p>Method:</p> <p>takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> <li>processInstanceId: request number.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>takeProcessTaskByReplacement</p></td> <td class="confluenceTd"><p>Assumes a task using a substitute user.</p> <p> </p> <p>Method:</p> <p>takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence, String replacementId)</p> <p> </p> <p>Parameters:</p> <ul> <li>user: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>userId: user registration.</li> <li>processInstanceId: request number.</li> <li>threadSequence: Indicates if there is any parallel activity in the process. If it does not exist, the value is 0 (zero), if it exists, this value can be from 1 to infinite, depending on the amount of parallel activities that exist in the process.</li> <li>replacementId: substitute user registration.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>updateWorkflowAttachment</p></td> <td class="confluenceTd"><p>Updates a document of type 7.</p> <p>Returns a string containing the success description or operation failure.</p> <p>Method:</p> <p>updateWorkflowAttachment(String username, String password, int companyId, int processInstanceId, String usuario, DocumentDto[] docdtos, Attachment[] attach)</p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>processInstanceId: workflow request number.</li> <li>usuario: user responsible for editing document.</li> <li>docDtos: document or documents that will be posted.</li> <li>attachs: file(s) attached to post.</li> </ul></td> </tr> </tbody> </table> </div> <p> </p> <p> <strong>Chart 24: WorkflowEngineService methods</strong> </p> <p> <strong><br /></strong> </p></span> <h4 id="UtilizaçãodeWebservices-Exemplodeutilização.20">Use example</h4> <p> Download the <a class="unresolved" href="#http://tdn.totvs.com/download/attachments/185741437/WorkflowEngineServiceClient.java?version=2&modificationDate=1426272594962&api=v2">WorkflowEngineServiceClient.java</a> class, it exemplifies the use of the main methods of the WorkflowEngineService class. </p> <p> </p> <h1 id="UtilizaçãodeWebservices-ECMWorkflowRoleService">ECMWorkflowRoleService</h1> <p>Webservice responsible for performing operations related to roles in Fluig. It can be used to create, change, delete and search roles, among other features.</p> <p> </p> <h4 id="UtilizaçãodeWebservices-Métodos.23">Methods</h4> <span id='content_25' class='cloak'><div class="table-wrap"> <table class="confluenceTable"> <tbody> <tr> <td class="confluenceTd"><p>createWorkflowRole</p></td> <td class="confluenceTd"><p>Creates a role in Fluig.</p> <p> </p> <p>Method:</p> <p>createWorkflowRole(String username, String password, int companyId, workflowRoleDto role)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>role: role that will be created.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>deleteWorkflowRole</p></td> <td class="confluenceTd"><p>Deletes a role from Fluig.</p> <p> </p> <p>Method:</p> <p>deleteWorkflowRole(String username, String password, int companyId, String roleId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>roleId: code of the role to be deleted.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> <tr> <td class="confluenceTd"><p>getWorkflowRole</p></td> <td class="confluenceTd"><p>Returns a role registered in Fluig.</p> <p> </p> <p>Method:</p> <p>getWorkflowRole(String username, String password, int companyId, String roleId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>roleId: role code.</li> </ul> <p> </p> <p>Return: WorkflowRoleDto.</p> <p> </p> <p>Return Attributes:</p> <ul> <li>companyId</li> <li>roleDescription</li> <li>roleId</li> </ul></td> </tr> <tr> <td class="confluenceTd"><p>getWorkflowRoles</p></td> <td class="confluenceTd"><p>Returns all the roles registered in Fluig.</p> <p> </p> <p>Method:</p> <p>getWorkflowRoles(String username, String password, int companyId)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> </ul> <p> </p> <p>Return: WorkflowRoleDto[].</p> <p> </p> <p>Return Attributes:</p> <ul> <li>companyId</li> <li>roleDescription</li> <li>roleId</li> </ul></td> </tr> <tr> <td colspan="1" class="confluenceTd"><p>updateWorkflowRole</p></td> <td colspan="1" class="confluenceTd"><p>Updates a role in Fluig.</p> <p> </p> <p>Method:</p> <p>updateWorkflowRole(String username, String password, int companyId, workflowRoleDto role)</p> <p> </p> <p>Parameters:</p> <ul> <li>username: user login.</li> <li>password: user password.</li> <li>companyId: company code.</li> <li>role: role that will be created.</li> </ul> <p> </p> <p>Return: String.</p></td> </tr> </tbody> </table> </div> <p> <strong>Chart 25: WorkflowRoleService methods</strong> </p> <p> <strong><br /></strong> </p></span> </div> |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas