@mapgis/webclient-common/documention/WorkFlowServer.html

mapgis ES6 format for igserver

<header id="page-title" class="page-title">
    
        <span class="page-title-main">类名</span>
        <span class="page-title-sub">WorkFlowServer</span>
    
</header>





<section>

<article>
    <div class="container-overview">
    
        
            <div class='vertical-section'>
                <div class="members">
                    <div class="member">
                        


    
    <h4 class="name" id="WorkFlowServer">
        <a class="href-link" href="#WorkFlowServer">#</a>
        
        <span class="code-name" id="WorkFlowServer" style="font-size:30px">
            
                new WorkFlowServer<span class="signature">(options)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>工作流服务,基地址http://{ip}:{port}/igs/rest/services/workflow/{serviceName}/WorkflowServer</p>
    </div>
    









    <h4>参数</h4>
    
<div class="table-container">
    <table class="params table">
        <thead>
        <tr>
            
            <th>名称</th>
            

            <th>类型</th>

            

            <th class="last">描述</th>
        </tr>
        </thead>

        <tbody>
        

            
<tr class="deep-level-0">
  
      <td class="name" id="options"><code>options</code></td>
  

  <td class="type">
  
      
<span class="param-type">Object</span>



  
  </td>

  

  <td class="description last"><p>构造参数</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="url"><code>url</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  

  <td class="description last"><p>服务基地址，必传</p></td>
</tr>


  



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><p><a href="tutorial-工作流.html"><h4>不同工作流参数配置</h4></a></p></li>
        </ul>
    </dd>
    

    

    
</dl>























    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>// 以下以“根据参照系名称进行投影转换”工作流举例,其他工作流用法请参考前文中“不同工作流参数配置”
const workflow = WorkFlowServer.createWorkFlow({
  url: "http://localhost:8089/igs/rest/services/workflow/600235/WorkflowServer",
   clsName: "gdbp://MapGISLocalPlus/test/sfcls/湖泊",
   desClsName: `gdbp://MapGISLocalPlus/test/sfcls/湖泊${Math.random()}`,
  crsName: "高斯大地坐标系_西安80_36带3_北",
  });</code></pre>
    



                    </div>
                </div>
            </div>
        
    
    </div>
    
    
        <h3 class="subsection-title">继承关系</h3>

        


    <ul>
        <li><a link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer" BaseServer.html>BaseServer</a></li>
    </ul>


    

    

    

    

    

    

    
        <div class='vertical-section'>
            <h3 id='member'>成员变量</h3>
            <h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量概述</h4>
            <div class="table-container">
                <table class="params table">
                    <thead>
                    <tr>
                        <th>名称</th>
                        <th>类型</th>
                        <th>描述</th>
                    </tr>
                    </thead>
                    <tbody>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#clientId">clientId</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Boolean</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>客户端id</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#enableGlobeFetch">enableGlobeFetch</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Boolean</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>是否使用确据唯一的fetch对象，默认为true，当设为false时，会使用自己私有的fetch对象，所有的请求设置不会影响全局</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#headers">headers</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>请求头参数</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#requestInterceptor">requestInterceptor</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">function</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>请求发送拦截器</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#requestTimeout">requestTimeout</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>请求超时时间，默认45000ms，即45s</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#responseInterceptor">responseInterceptor</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">function</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>请求响应拦截器</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#tokenAttachType">tokenAttachType</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a link="TokenAttachType.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TokenAttachType" global.html#TokenAttachType>TokenAttachType</a></span>



                                    </code>
                                </td>
                                <td class="name"><code><p>指定token附加到何处</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#tokenKey">tokenKey</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>token名</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#tokenValue">tokenValue</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>token值</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#url">url</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>服务基地址</p></code></td>
                            </tr>
                        
                    </tbody>
                </table>
            </div>
            <h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量详情</h4>
            <div class="members">
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">Boolean</span>



    </span>

<h4 class="name" id="clientId">
    <a class="href-link" href="#clientId">#</a>
    
    <span class="code-name">
        clientId
    </span>
    
</h4>




<div class="description">
    <p>客户端id</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="clientId" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#clientId" BaseServer.html#clientId>BaseServer#clientId</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">Boolean</span>



    </span>

<h4 class="name" id="enableGlobeFetch">
    <a class="href-link" href="#enableGlobeFetch">#</a>
    
    <span class="code-name">
        enableGlobeFetch
    </span>
    
</h4>




<div class="description">
    <p>是否使用确据唯一的fetch对象，默认为true，当设为false时，会使用自己私有的fetch对象，所有的请求设置不会影响全局</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="enableGlobeFetch" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#enableGlobeFetch" BaseServer.html#enableGlobeFetch>BaseServer#enableGlobeFetch</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置请求基地址
// ES5引入方式
const { BaseServer } = Zondy.Service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //请求基地址
  url: '你的URL',
  //使用私有的fetch对象
  enableGlobeFetch: false,
  //此时设置token等属性，不会影响全局的fetch对象
  tokenValue: '你的token'
});
//继续使用全局fetch
BaseServer.enableGlobeFetch = true;</code></pre>
    


</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">String</span>



    </span>

<h4 class="name" id="headers">
    <a class="href-link" href="#headers">#</a>
    
    <span class="code-name">
        headers
    </span>
    
</h4>




<div class="description">
    <p>请求头参数</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="headers" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#headers" BaseServer.html#headers>BaseServer#headers</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置请求头参数
// ES5引入方式
const { BaseServer } = Zondy.Service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //请求头
  headers: {
     //设置Content-Type为multipart/form-data
    'Content-Type': 'multipart/form-data',
     //设置token
    'token': '你的token'
  }
});
//动态修改
BaseServer.headers.token = '新token';</code></pre>
    


</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">function</span>



    </span>

<h4 class="name" id="requestInterceptor">
    <a class="href-link" href="#requestInterceptor">#</a>
    
    <span class="code-name">
        requestInterceptor
    </span>
    
</h4>




<div class="description">
    <p>请求发送拦截器</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="requestInterceptor" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#requestInterceptor" BaseServer.html#requestInterceptor>BaseServer#requestInterceptor</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置拦截器，任何一个继承自BaseServer的对象都可以设置，全局唯一
// ES5引入方式
const { BaseServer,RequestInterceptor } = Zondy.Service
// ES6引入方式
import { BaseServer,RequestInterceptor } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //设置请求发送拦截器
  requestInterceptor: new RequestInterceptor({
    //请求发送前进行统一处理
    before: function(config) {
      //执行你的业务逻辑
      //注意必须显示返回config对象，如果返回为空，则不发送请求
      return config;
    },
    //请求发送失败时进行统一处理
    failure: function(error) {
      //执行你的业务逻辑
    }
  })
});
//动态修改
BaseServer.requestInterceptor.before = function() {};</code></pre>
    


</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">String</span>



    </span>

<h4 class="name" id="requestTimeout">
    <a class="href-link" href="#requestTimeout">#</a>
    
    <span class="code-name">
        requestTimeout
    </span>
    
</h4>




<div class="description">
    <p>请求超时时间，默认45000ms，即45s</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="requestTimeout" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#requestTimeout" BaseServer.html#requestTimeout>BaseServer#requestTimeout</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置超时时间
//初始化AddressServer服务对象
// ES5引入方式
const { BaseServer } = Zondy.Service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //超时时间
  requestTimeout: 2000
});
//动态修改
BaseServer.requestTimeout = 3000;</code></pre>
    


</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">function</span>



    </span>

<h4 class="name" id="responseInterceptor">
    <a class="href-link" href="#responseInterceptor">#</a>
    
    <span class="code-name">
        responseInterceptor
    </span>
    
</h4>




<div class="description">
    <p>请求响应拦截器</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="responseInterceptor" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#responseInterceptor" BaseServer.html#responseInterceptor>BaseServer#responseInterceptor</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置拦截器，任何一个继承自BaseServer的对象都可以设置，全局唯一
// ES5引入方式
const { BaseServer,ResponseInterceptor } = Zondy.Service
// ES6引入方式
import { BaseServer,ResponseInterceptor } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //设置请求响应拦截器
  responseInterceptor: new ResponseInterceptor({
    //执行请求响应，接口调用成功时会执行的回调
    success: function(result) {
      //执行你的业务逻辑
      //注意必须显示返回result对象，如果返回为空，则不执行请求响应成功回调
      return result;
    },
    //请求响应成功，接口调用失败时会执行的函数
    failure: function(result) {
      //执行你的业务逻辑
      //注意必须显示返回result对象，如果返回为空，则不执行回调韩式
      return result;
    }
  })
});
//动态修改
BaseServer.responseInterceptor.success = function() {};</code></pre>
    


</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type"><a link="TokenAttachType.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="TokenAttachType" global.html#TokenAttachType>TokenAttachType</a></span>



    </span>

<h4 class="name" id="tokenAttachType">
    <a class="href-link" href="#tokenAttachType">#</a>
    
    <span class="code-name">
        tokenAttachType
    </span>
    
</h4>




<div class="description">
    <p>指定token附加到何处</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="tokenAttachType" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#tokenAttachType" BaseServer.html#tokenAttachType>BaseServer#tokenAttachType</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置token值
// ES5引入方式
const { BaseServer } = Zondy.Service
const { TokenAttachType } = Zondy.Enum
// ES6引入方式
import { BaseServer,TokenAttachType } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //token名
  tokenValue: '你的token值',
  //token值
  tokenValue: '你的token值',
  //指定token附加到url后面
  tokenAttachType: TokenAttachType.url
});
//动态修改
BaseServer.tokenAttachType = TokenAttachType.header;</code></pre>
    


</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">String</span>



    </span>

<h4 class="name" id="tokenKey">
    <a class="href-link" href="#tokenKey">#</a>
    
    <span class="code-name">
        tokenKey
    </span>
    
</h4>




<div class="description">
    <p>token名</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="tokenKey" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#tokenKey" BaseServer.html#tokenKey>BaseServer#tokenKey</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置token名
// ES5引入方式
const { BaseServer } = Zondy.Service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //token名
  tokenKey: '你的tokenKey'
});
//动态修改
BaseServer.tokenKey = '新tokenKey';</code></pre>
    


</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">String</span>



    </span>

<h4 class="name" id="tokenValue">
    <a class="href-link" href="#tokenValue">#</a>
    
    <span class="code-name">
        tokenValue
    </span>
    
</h4>




<div class="description">
    <p>token值</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="tokenValue" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#tokenValue" BaseServer.html#tokenValue>BaseServer#tokenValue</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置token值
// ES5引入方式
const { BaseServer } = Zondy.Service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //token值
  tokenValue: '你的token值'
});
//动态修改
BaseServer.tokenValue = '新token值';</code></pre>
    


</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">String</span>



    </span>

<h4 class="name" id="url">
    <a class="href-link" href="#url">#</a>
    
    <span class="code-name">
        url
    </span>
    
</h4>




<div class="description">
    <p>服务基地址</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="url" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#url" BaseServer.html#url>BaseServer#url</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>//设置请求基地址
// ES5引入方式
const { BaseServer } = Zondy.Service
// ES6引入方式
import { BaseServer } from "@mapgis/webclient-common"
let BaseServer = new BaseServer({
  //请求基地址
  url: '你的URL'
});
//动态修改
BaseServer.url = '新URL';</code></pre>
    


</div>
            
            </div>
        </div>
    

    
        <div class='vertical-section'>
            <h3 id='function'>方法</h3>
            <h4 style="margin-top: 20px;margin-bottom: 20px;">方法概述</h4>
            <div class="members">
            <div class="table-container">
                <table class="params table">
                    <thead>
                    <tr>
                        <th>名称</th>
                        <th>返回值类型</th>
                        <th>描述</th>
                    </tr>
                    </thead>
                    <tbody>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#createWorkFlow">createWorkFlow</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type"><a link="WorkFlowServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WorkFlowServer" WorkFlowServer.html>WorkFlowServer</a></span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>根据工作流id创建工作流</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#execute">execute</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">Promise.&lt;Object></span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>同步执行工作流，返回执行结果</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#queryServerInfo">queryServerInfo</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                    </code>
                                </td>
                                <td class="name"><code><p>获取服务信息，IGS2.0新增服务</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#queryTaskResult">queryTaskResult</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">Promise.&lt;String></span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>查询工作流执行结果</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#queryTaskStatus">queryTaskStatus</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">Promise.&lt;String></span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>查询工作流执行状态</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#submit">submit</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">Promise.&lt;String></span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>异步执行工作流，返回执行任务id</p></code></td>
                            </tr>
                        
                    </tbody>
                </table>
            </div>
            <h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4>
            
                <div class="member">


    
    <h4 class="name" id=".createWorkFlow">
        <a class="href-link" href="#.createWorkFlow">#</a>
        
            
                <span class='tag'>static</span>
            
        
        <span class="code-name" id="createWorkFlow" style="font-size:30px">
            
                createWorkFlow<span class="signature">(工作流参数)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>根据工作流id创建工作流</p>
    </div>
    









    <h4>参数</h4>
    
<div class="table-container">
    <table class="params table">
        <thead>
        <tr>
            
            <th>名称</th>
            

            <th>类型</th>

            

            <th class="last">描述</th>
        </tr>
        </thead>

        <tbody>
        

            
<tr class="deep-level-0">
  
      <td class="name" id="工作流参数"><code>工作流参数</code></td>
  

  <td class="type">
  
      
<span class="param-type">Object</span>



  
  </td>

  

  <td class="description last"></td>
</tr>



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="column is-2"><label>返回值</label></div>
        <div class="column is-10">
            
                    

<div class="columns">
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type"><a link="WorkFlowServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WorkFlowServer" WorkFlowServer.html>WorkFlowServer</a></span>



    </div>
    
</div>

                
        </div>
    </div>






    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>const workflow = WorkFlowServer.createWorkFlow({
  url: "http://localhost:8089/igs/rest/services/workflow/600235/WorkflowServer",
   clsName: "gdbp://MapGISLocalPlus/test/sfcls/湖泊",
   desClsName: `gdbp://MapGISLocalPlus/test/sfcls/湖泊${Math.random()}`,
  crsName: "高斯大地坐标系_西安80_36带3_北",
  });</code></pre>
    


</div>
            
                <div class="member">


    
    <h4 class="name" id="execute">
        <a class="href-link" href="#execute">#</a>
        
        <span class="code-name" id="execute" style="font-size:30px">
            
                execute<span class="signature">(options)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>同步执行工作流，返回执行结果</p>
    </div>
    









    <h4>参数</h4>
    
<div class="table-container">
    <table class="params table">
        <thead>
        <tr>
            
            <th>名称</th>
            

            <th>类型</th>

            
            <th style="min-width: 100px;">默认值</th>
            

            <th class="last">描述</th>
        </tr>
        </thead>

        <tbody>
        

            
<tr class="deep-level-0">
  
      <td class="name" id="options"><code>options</code></td>
  

  <td class="type">
  
      
<span class="param-type">Object</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="headers"><code>headers</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>请求头参数</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="method"><code>method</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
          FetchMethod.get
      
      </td>
  

  <td class="description last"><p>请求类型</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="success"><code>success</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询成功回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="failure"><code>failure</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询失败回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="column is-2"><label>返回值</label></div>
        <div class="column is-10">
            
                    

<div class="columns">
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type">Promise.&lt;Object></span>



    </div>
    
</div>

                
        </div>
    </div>






    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>workflow.execute({
      method: Zondy.Enum.FetchMethod.get,
      success: function (res) {
        console.log("execute: ", res);
      },
    });</code></pre>
    


</div>
            
                <div class="member">


    
    <h4 class="name" id="queryServerInfo">
        <a class="href-link" href="#queryServerInfo">#</a>
        
        <span class="code-name" id="queryServerInfo" style="font-size:30px">
            
                queryServerInfo<span class="signature">(options)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>获取服务信息，IGS2.0新增服务</p>
    </div>
    









    <h4>参数</h4>
    
<div class="table-container">
    <table class="params table">
        <thead>
        <tr>
            
            <th>名称</th>
            

            <th>类型</th>

            
            <th style="min-width: 100px;">默认值</th>
            

            <th class="last">描述</th>
        </tr>
        </thead>

        <tbody>
        

            
<tr class="deep-level-0">
  
      <td class="name" id="options"><code>options</code></td>
  

  <td class="type">
  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询参数</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="success"><code>success</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
          无
      
      </td>
  

  <td class="description last"><p>查询成功回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="failure"><code>failure</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
          无
      
      </td>
  

  <td class="description last"><p>查询失败回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="queryServerInfo" link="BaseServer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseServer#queryServerInfo" BaseServer.html#queryServerInfo>BaseServer#queryServerInfo</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>























    <h5>示例</h5>
    
        <p class="code-caption"><h5>获取服务信息-回调方式</h5></p>
    
    
        <pre class="prettyprint"><code>server.queryServerInfo({
  success: function (result) {
    console.log('请求成功：', result);
  },
  failure: function (result) {
    console.log('请求失败：', result);
  }
});</code></pre>
    

        <p class="code-caption"><h5>获取服务信息-promise方式</h5></p>
    
    
        <pre class="prettyprint"><code>server.queryServerInfo({
})
.then(function (result) {
  console.log('请求成功：', result);
}).catch(function (result) {
  console.log('请求失败：', result);
});</code></pre>
    


</div>
            
                <div class="member">


    
    <h4 class="name" id="queryTaskResult">
        <a class="href-link" href="#queryTaskResult">#</a>
        
        <span class="code-name" id="queryTaskResult" style="font-size:30px">
            
                queryTaskResult<span class="signature">(options)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>查询工作流执行结果</p>
    </div>
    









    <h4>参数</h4>
    
<div class="table-container">
    <table class="params table">
        <thead>
        <tr>
            
            <th>名称</th>
            

            <th>类型</th>

            
            <th style="min-width: 100px;">默认值</th>
            

            <th class="last">描述</th>
        </tr>
        </thead>

        <tbody>
        

            
<tr class="deep-level-0">
  
      <td class="name" id="options"><code>options</code></td>
  

  <td class="type">
  
      
<span class="param-type">Object</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="taskId"><code>taskId</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>工作流任务id,必传</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="headers"><code>headers</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>请求头参数</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="method"><code>method</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
          FetchMethod.get
      
      </td>
  

  <td class="description last"><p>请求类型</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="success"><code>success</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询成功回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="failure"><code>failure</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询失败回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="column is-2"><label>返回值</label></div>
        <div class="column is-10">
            
                    

<div class="columns">
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type">Promise.&lt;String></span>



    </div>
    
</div>

                
        </div>
    </div>






    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>workflow.queryTaskResult({
      taskId: taskId,
      success: function (res) {
        console.log("success: ", res);
      },
    });</code></pre>
    


</div>
            
                <div class="member">


    
    <h4 class="name" id="queryTaskStatus">
        <a class="href-link" href="#queryTaskStatus">#</a>
        
        <span class="code-name" id="queryTaskStatus" style="font-size:30px">
            
                queryTaskStatus<span class="signature">(options)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>查询工作流执行状态</p>
    </div>
    









    <h4>参数</h4>
    
<div class="table-container">
    <table class="params table">
        <thead>
        <tr>
            
            <th>名称</th>
            

            <th>类型</th>

            
            <th style="min-width: 100px;">默认值</th>
            

            <th class="last">描述</th>
        </tr>
        </thead>

        <tbody>
        

            
<tr class="deep-level-0">
  
      <td class="name" id="options"><code>options</code></td>
  

  <td class="type">
  
      
<span class="param-type">Object</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="taskId"><code>taskId</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>工作流任务id,必传</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="headers"><code>headers</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>请求头参数</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="method"><code>method</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
          FetchMethod.get
      
      </td>
  

  <td class="description last"><p>请求类型</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="success"><code>success</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询成功回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="failure"><code>failure</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询失败回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="column is-2"><label>返回值</label></div>
        <div class="column is-10">
            
                    

<div class="columns">
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type">Promise.&lt;String></span>



    </div>
    
</div>

                
        </div>
    </div>






    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>workflow.queryTaskStatus({
      taskId: taskId,
      success: function (res) {
        console.log("success: ", res);
      },
    });</code></pre>
    


</div>
            
                <div class="member">


    
    <h4 class="name" id="submit">
        <a class="href-link" href="#submit">#</a>
        
        <span class="code-name" id="submit" style="font-size:30px">
            
                submit<span class="signature">(options)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>异步执行工作流，返回执行任务id</p>
    </div>
    









    <h4>参数</h4>
    
<div class="table-container">
    <table class="params table">
        <thead>
        <tr>
            
            <th>名称</th>
            

            <th>类型</th>

            
            <th style="min-width: 100px;">默认值</th>
            

            <th class="last">描述</th>
        </tr>
        </thead>

        <tbody>
        

            
<tr class="deep-level-0">
  
      <td class="name" id="options"><code>options</code></td>
  

  <td class="type">
  
      
<span class="param-type">Object</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="headers"><code>headers</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>请求头参数</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="method"><code>method</code></td>
  

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

  
      <td class="default">
      
          FetchMethod.get
      
      </td>
  

  <td class="description last"><p>请求类型</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="success"><code>success</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询成功回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="failure"><code>failure</code></td>
  

  <td class="type">
  
      
<span class="param-type">function</span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>查询失败回调函数，若使用Promise方式则不必填写</p></td>
</tr>


  



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="column is-2"><label>返回值</label></div>
        <div class="column is-10">
            
                    

<div class="columns">
    
    <div class='param-desc column is-7'><p>workflow.submit({
method: Zondy.Enum.FetchMethod.get,
success: function (res) {
console.log(&quot;submit: &quot;, res);
},
});</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type">Promise.&lt;String></span>



    </div>
    
</div>

                
        </div>
    </div>






</div>
            
            </div>
        </div>
    

    

    
</article>

</section>