Qiaoqi

https://qiqiao.do1.com.cn/help/
Admin
A low-code/no-code aPaaS platform for building collaborative business applications on the WeChat...
Tokens:378,419
Snippets:3,688
Trust Score:9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get initial process instance list

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

Retrieves a paginated list of process instances that have been initiated by a given user. This function helps in tracking processes that a user has started.

```javascript
(function(){
   //用户id
   var userId = $.context.getCurrentUserId();
   //当前页
   var page = 1;
   //每页记录数
   var pageSize = 10;
   //获取初始流程实例列表
   var initiateProcessInstanceList = $.process.getInitiateProcessInstanceList(userId, page, pageSize);
   //返回流程实例列表
   return initiateProcessInstanceList;
})()
```

--------------------------------

### Query Process Definition Response Example

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0/OpenAPI/%E6%B5%81%E7%A8%8BOpenAPI.html

This is an example of the JSON response when querying a process definition.

```json
{
  "msg": "执行成功",
  "code": 0,
  "data":  {
        "applicationName": "",
        "processDefinitionId": "123123123123123",
        "processIcon": "",
        "processModelId": "123123123123123123123",
        "processName": "OpenApi启动流程完成任务",
        "processTasks": [
            {
                "conditionAdjustable": false,
                "id": "obj_0yegawo",
                "nodeDesc": "",
                "nodeName": "人工任务2",
                "routeConditionConfig": "",
                "timeoutHandler": "",
                "timeoutReminder": ""
            },
            {
                "conditionAdjustable": false,
                "id": "obj_02",
                "nodeDesc": "",
                "nodeName": "人工任务1",
                "routeConditionConfig": "",
                "timeoutHandler": "",
                "timeoutReminder": ""
            }
        ],
        "processTitle": "",
        "relatedFormId": "111111111111112222",
        "subProcessModelIds": [""],
        "version": "V1"
    }
}
```

--------------------------------

### Get Form Instance Data by DocId

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E7%A7%AF%E6%9C%A8%E5%BC%8F%E9%A1%B5%E9%9D%A2%EF%BC%88%E6%97%A7%EF%BC%89/%E6%95%B0%E6%8D%AE%E6%BA%90.html

Example of a successful response when retrieving a specific form instance's data.

```json
{
    "msg": "执行成功",
    "traceId": "d465a61e432ea5d5f382c36b5b1c4791",
    "code": 0,
    "data": {
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "author": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "authorName": "郑涛",
        "createDate": 1674877960000,
        "formDefinitionId": "63c797222a25c179a1d5bffe",
        "id": "7256926311293173762",
        "lastModifierName": "郑涛",
        "lastModifyDate": 1674883876000,
        "prettyValue": {},
        "variables": {
            "多行文本1": "3339",
            "单行文本2": "33399999",
            "单行文本1": "3339"
        },
        "version": 6
    }
}
```

--------------------------------

### Request Example

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0/%E6%B5%81%E7%A8%8B%E6%8E%A8%E9%80%81%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.html

Example of a POST request to the batchUpdateReceiptTodo endpoint, including headers and body.

```json
POST 
https://第三方域名/batchUpdateReceiptTodo?timestamp=1498586609

Headers:{
  "Content-type":"application/json",
  "X-Auth0-DeliverId":"31a2ae17-2661-4234-8d79-f62f3175fd75",
}
Body:{
  "eventType":"PROCESS_UPDATE_TODO",
  "applicationId":"应用Id",
  "eventBusinessId":"",
  "data": "zvmPTQAcEmxGbMoOLPjpoCPk/Oh096ZaORQ8o2iu8Cg="
}
```

--------------------------------

### Start process

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

Initiates a new process instance based on a process model key, a user ID, and associated document data. This is the primary function for starting new workflows.

```javascript
(function(){
   //流程模型key
   var processModelKey = "key";
   //用户id
   var userId = $.context.getCurrentUserId();
   //文档对象
   var document = $.context.getCurrentDocument();
   //获取流程实例对象
   var processInstance = $.process.startProcessInstance(processModelKey, userId, document);
   //返回流程实例对象
   return processInstance;
})()
```

--------------------------------

### Get Task Object by ID

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

Example of how to retrieve a task object using its ID.

```javascript
(function(){
   //任务id
   var taskId = "63e5cde3aebb4fafaa7026098eb5a810";
   //获取任务对象
   var task = $.process.getTaskById(taskId);
   //返回任务对象
   return task;
})()
```

--------------------------------

### Get User Information by Application and Role ID (Paginated)

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

Example of how to retrieve a paginated list of users bound to a specific application and role.

```javascript
(function(){
    //获取部门id
    var appId = "64c761a7fb7f4847992466ee76efc195";
    //获取角色id
    var roleId = "64c761a7fb7f4847992466ee76efc998";
    //返回用户信息集合（包含分页信息）
    return $.role.getUsersByAppIdAndRoleId(appId, roleId, 10, 1);
})()
```

--------------------------------

### Add Form

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E7%A7%AF%E6%9C%A8%E5%BC%8F%E9%A1%B5%E9%9D%A2%EF%BC%88%E6%97%A7%EF%BC%89/%E6%95%B0%E6%8D%AE%E6%BA%90.html

Example of adding a new form instance with specified variables.

```json
{
    "variables": {
        "单行文本1": "9999",
        "多行文本1": "9999",
        "单行文本2": "9999"
    },
    "id": ""
}
```

--------------------------------

### 1.20 Get a list of resigned personnel within a specified time range

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

This function retrieves a list of users who have resigned within a specified start and end time.

```javascript
(function(){
    var startTime = $.date.getCurrentDate();
    var endTime = $.date.getCurrentDate();
    return $.contact.listResignUsersByTimeRange(startTime, endTime);
})()
```

--------------------------------

### Log Warn Example

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

Logs a warning message with provided parameters.

```javascript
(function(){
    //Log string
    var logger = "{}
{}
={}";
    //Replacement objects
    var add1 = 1;
    var add2 = 2;
    var result = 3;
    //Get warning log content
    var warnInfo = $.log.warn(logger, add1, add2, result);
    //Return
    return warnInfo;
   })()
```

--------------------------------

### 返回参数示例 (发起流程)

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0/OpenAPI/%E6%B5%81%E7%A8%8BOpenAPI.html

Example of a successful response when initiating a process.

```json
{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": [
         {
            "activityDefinitionId": "obj_03jb1ay",
            "activityName": "并行内嵌\n默认排它2",
            "activityType": "userTask"
        },
        {
            "activityDefinitionId": "obj_0x962gb",
            "activityName": "并行4",
            "activityType": "userTask"
        }
}

```

--------------------------------

### 根据用户组id获取指定用户组

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

This code snippet shows how to get a user group object by its ID using the `getUserGroupById` function. It includes an example of how to retrieve the user group object for a given ID.

```javascript
(function(){
    //获取用户组id
    var id = "2f465563371549a2be1f22ad0e1dd47a";
    //获取指定用户组id下的用户组对象
    var userGroup = $.contact.getUserGroupById(id);
    //返回用户对象集合
    return userGroup;
})()
```

--------------------------------

### Warning Logging

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E8%84%9A%E6%9C%AC/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

Example of logging a warning using $.log.warn.

```javascript
(function(){
    //日志字符串
    var logger = "{}+{}={}";
    //替换对象
    var add1 = 1;
    var add2 = 2;
    var result = 3;
    //获取警告日志内容
    var warnInfo = $.log.warn(logger, add1, add2, result);
    //返回
    return warnInfo;
   })()
```

--------------------------------

### Error Example

Source: https://qiqiao.do1.com.cn/help/user_manual/%E4%BD%8E%E7%A0%81%E5%BC%95%E6%93%8E/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%9C%A8%E7%BA%BF%E8%B0%83%E8%AF%95.html

An example of a division by zero error.

```unknown
1 / 0
```

--------------------------------

### Add Form Response

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E7%A7%AF%E6%9C%A8%E5%BC%8F%E9%A1%B5%E9%9D%A2%EF%BC%88%E6%97%A7%EF%BC%89/%E6%95%B0%E6%8D%AE%E6%BA%90.html

Example response after successfully adding a form.

```json
{
    "msg": "执行成功",
    "traceId": "ee64b30718fdd32e90c21994ffd54882",
    "code": 0,
    "data": {
        "processInstanceId": null,
        "processDefinitionId": null,
        "processCurrentApprovers": null,
        "variables": {
            "多行文本1": "999901",
            "__isDeleted": false,
            "单行文本2": "999901",
            "单行文本1": "999901"
        },
        "processStatus": null,
        "processState": null,
        "author": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "lastModifier": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "lastModifierName": "郑涛",
        "version": 1,
        "authorName": "郑涛",
        "dataStaticUrl": null,
        "formDefinitionId": null,
        "id": "7256846012584607744",
        "applicationId": null,
        "lastModifyDate": 1674875616561,
        "taskId": null,
        "createDate": 1674875616561
    }
}
```

--------------------------------

### Update to Read (已阅) Example

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0/%E6%B5%81%E7%A8%8B%E6%8E%A8%E9%80%81%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.html

Example of updating a to-read item to read status.

```json
[{
  "updateList":[
    {
      "receiptDTO":{
        "workId":"work1234"
      },
      "orgId":"b17efb43-292e-4cc9-ac5d-0b46bce059c4",
      "updateReadUserIds":[
        "204dcac59b288a1731b81e6e8ac6822e"
      ],
      "updateReceipt":true
    }
  ],
  "orgId":"b17efb43-292e-4cc9-ac5d-0b46bce059c4"
}]
```

--------------------------------

### Log Debug Example

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E5%87%BD%E6%95%B0%E5%BA%93.html

Logs a debug message with provided parameters.

```javascript
(function(){
    //Log string
    var logger = "{}
{}
={}";
    //Replacement objects
    var add1 = 1;
    var add2 = 2;
    var result = 3;
    //Get debug log content
    var debugInfo = $.log.debug(logger, add1, add2, result);
   //Return debug content
    return debugInfo;
   })()
```

--------------------------------

### Update to Processed (已办) Example

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0/%E6%B5%81%E7%A8%8B%E6%8E%A8%E9%80%81%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.html

Example of updating a to-do item to processed status.

```json
[{
    "updateList":[
        {
            "receiptDTO":{
                "workId":"work123"
            },
            "orgId":"b17efb43-292e-4cc9-ac5d-0b46bce059c4",
            "updateWaitUserIds":[
                "204dcac59b288a1731b81e6e8ac6822e"
            ],
            "updateReceipt":true
        }
    ],
    "orgId":"b17efb43-292e-4cc9-ac5d-0b46bce059c4"
}]
```

--------------------------------

### 批量发起流程

Source: https://qiqiao.do1.com.cn/help/develop_manual/%E4%BD%8E%E4%BB%A3%E7%A0%81%E8%84%9A%E6%9C%AC/%E5%9C%BA%E6%99%AF%E6%A1%88%E4%BE%8B.html

Initiates a process instance in batch by selecting list data and starting a workflow approval. The initiator is set to the 'creator' field in the form data.

```javascript
(function(){
  //流程模型key
  var processModelKey = "5f111ec52cf6be0001fbe5e7";
  //用户id
  var userId = $.context.getCurrentUserId();
  //文档对象
  var document =$.context.getCurrentDocument();
  //获取流程实例对象
  var processInstance = $.process.startProcessInstance(processModelKey, userId, document);
  //返回流程实例对象
  return processInstance;
})()

```
Tokens:
Raw