O2OA API

Module

Actions

本文档说明如何在后台脚本中使用Actions调用平台的RESTful服务。
通过访问以下地址来查询服务列表:http://server/x_program_center/jest/list.html (v7.2之前版本需要加端口20030)

Syntax

//获取Actions
this.Actions

Methods

load(root) → {Object}

平台预置了Actions对象用于调用平台提供的服务,您可以使用this.Actions.load来获取这些方法。由于是运行在服务器端,服务都是同步调用。

Syntax

var actions = this.Actions.load( root );
//获取流程平台服务对象。
var processAction = this.Actions.load("x_processplatform_assemble_surface");

通过this.Actions.load(root)方法得到action对象,就可以访问此服务下的方法了。
访问方法的规则如下:

 var requestString = this.Actions.load( root )[actionName][methodName]( arguements );

 requestString : 服务返回的响应数据,字符串格式,可以通过 requestObjest = JSON.parse(requestString);解析成对象

 root : 平台服务根名称,如果 x_processplatform_assemble_surface

 actionName : 服务下的Action分类名称,如 TaskAction

 methodName : Action分类下的方法名称,如 get

 arguements : 需调用的RESTful服务的相关参数。这些参数需要按照先后顺序传入。根据实际情况可以省略某些参数。参数序列分别是:

     uri的参数, data(Post, Put方法), success, failure, async。

     uri参数:如果有uri有多个参数,需要按先后顺序传入。

     data参数:要提交到后台的数据。POST 和 PUT 方法需要传入,GET方法和DELETE方法省略。

     success参数:服务执行成功时的回调方法,形如 function(json){
         json为后台服务传回的数据
     }。

     failure 参数:服务执行失败时的回调方法,形如 function(xhr){
         xhr XmlHttpRequest对象,服务器请求失败时有值
      }
     此参数可以省略,如果省略,系统会自动弹出错误信息。

处理返回的数据有两种方式,二选一即可:
1、该方法返回的结果是响应的 json对象。
2、通过success方法作为第一个参数来处理结果。

 //success:arguements中的第一个function对象
 function(json){
   //json为后台服务传回的数据
 }

Parameters

  • root String

    平台RESTful服务根,具体服务列表参见:http://server/x_program_center/jest/list.html。(v7.2之前版本需要加端口20030) 如:

    
    "x_processplatform_assemble_surface" //流程平台相关服务根
    

Returns

  • Object

    返回action对象,用于后续服务调用

Examples

样例1: 根据x_processplatform_assemble_surface服务获取当前用户的待办列表:
可以通过对应服务的查询页面,http://server/x_processplatform_assemble_surface/jest/index.html (v7.2之前版本需要加端口20020)
可以看到以下界面: 我们可以找到TaskAction的V2ListPaging服务是列式当前用户待办的服务。
该服务有以下信息:
1、actionName是:TaskAction
2、methodName是:V2ListPaging
3、有两个url参数,分别是 page(分页), size(每页数量)
4、有一系列的body参数
5、该服务方法类型是POST
根据这些信息我们可以组织出下面的方法:

const processAction = this.Actions.load("x_processplatform_assemble_surface"); //获取action
const method = processAction.TaskAction.V2ListPaging; //获取列式方法
//执行方法1
method(
 1,  //uri 第1个参数,如果无uri参数,可以省略
 20, //uri 第2个参数,如果无uri参数,可以省略,如果还有其他uri参数,可以用逗号, 分隔
 {   //body 参数,对POST和PUT请求,该参数必须传,可以为空对象
     processList : [xxx] //具体参数
 },
 function(json){ //正确调用的回调
      //json.data得到服务返回数据
 },
 function(responseJSON){ //可选,错误信息, json格式
     print( JSON.stringify(responseJSON) )
 }
);

//执行方法2
const responsJSON = method( 1, 20, {processList : [xxx]} );

出错信息responseJSON的格式

{
      "type": "error", //类型为错误
      "message": "标识为:343434 的 Task 对象不存在.", //提示文本
      "date": "2020-12-29 17:02:13", //出错时间
      "prompt": "com.x.base.core.project.exception.ExceptionEntityNotExist" //后台错误类
}

样例2: 已知流程实例的workid,在脚本中获取数据,修改后进行保存。

//查询服务列表找到获取data数据服务为DataAction的getWithWork方法
//查询服务列表找到更新data数据服务为DataAction的updateWithWork方法

const workid = "cce8bc22-225a-4f85-8132-7374d546886e";
const json = this.Actions.load("x_processplatform_assemble_surface").DataAction.getWithWork( //平台封装好的方法
     workid, //uri的参数
);
const data = json.data;

data.subject = "新标题"; //修改数据
const result = this.Actions.load("x_processplatform_assemble_surface").DataAction.updateWithWork(
     workid, //uri的参数
     data, //保存的数据
);

Source

results matching

    No results matching ''