Skip to main content

Workflow

danger

ONES API 已废弃。请使用Open API。

通用说明

工作流步骤​

transition

参数名值类型允许空值取值范围说明
uuidstringFlen=8transition uuid
project_uuidstringFlen=16项目 uuid
issue_type_uuidstringFlen=8任务类型 uuid
start_status_uuidstringFlen=8起始任务状态 uuid
end_status_uuidstringFlen=8结束任务状态 uuid
namestringTlen<64名称
triggerobjectT触发器，详见下方 trigger 说明
conditionobjectT验证条件，详见下方 condition 说明
post_functionobjectT后置动作，详见下方 post_function 说明
fieldsarrayT步骤属性，详见下方 fields 说明
positionint64T权限位置

触发器和验证条件​

trigger & condition

{
  "trigger": {
    "should": [
      {
        "commit_created": {
          "repo": "https://github.com/BangWork/ones-ai-web"
        }
      },
      {
        "branch_created": {
          "repo": "https://github.com/BangWork/ones-ai-web"
        }
      }
    ]
  },
  "condition": {
    "must": [
      {
        "in_user_domains": {
          "user_domains": [
            {
              "user_domain_type": "group",
              "user_domain_param": "876gdkut"
            }
          ]
        }
      }
    ]
  }
}

布尔运算符​

布尔运算符里面可以嵌套其它运算符或者条件。 另外，trigger 和 condition 内必须且只能有一个根布尔运算符，嵌套的表达式不能超过 5 层

运算符能否嵌套说明
mustTand 运算，当数组内的所有条件都满足时为 true
shouldTor 运算，当数组内任意一个条件满足时为 true
must_notTand-not 运算，当数组内任意一个条件满足时为 false

condition 可以使用的条件​

  1. 操作者是否在用户域中（in_user_domains）
参数名值类型允许空值取值范围说明
user_domainsarrayF用户域列表
 user_domain_typestringF用户域类型
 user_domain_paramstringF用户域参数

后置动作​

post_function

{
  "post_function": [
    {
      "update_field_value": {
        "field_uuid": "field013",
        "value": 1503975977
      }
    },
    {
      "update_field_value": {
        "field_uuid": "XQqBAfPj",
        "value": "A6bURA4T"
      }
    },
    {
      "update_field_value": {
        "field_uuid": "field004",
        "variable": "self"
      }
    },
    {
      "run_script": {
        "uuid": "script01",
        "name": "脚本1",
        "params": [
          {
            "uuid": "field001",
            "name": "回调url",
            "type": "string",
            "value": "ones.com"
          },
          {
            "uuid": "field002",
            "name": "成功状态",
            "type": "status",
            "value": "A6bURA4T"
          },
          {
            "uuid": "field003",
            "name": "失败状态",
            "type": "status",
            "value": "saxURA4T"
          }
        ]
      }
    }
  ]
}

后置动作列表​

  1. 修改任务属性（update_field_value）
参数名值类型允许空值说明
field_uuidstringF属性 uuid
typeintT属性 field_uuid 的类型
valueint,stringT属性值
value_typeintT值类型（普通：0，任务类型属性：1, 迭代属性：2, 项目属性：3, testcase 属性: 4), 目前只有 【任务类型属性】
*variablestringT变量名，可以将属性值设为某个变量，比如操作者自己。本期暂不支持

value_type 默认值为 0

当大于 0 时，value 为特殊的 uuid，他可能是从其他地方读取的数据

  1. value_type 为 0 时，value 保持原有逻辑

  2. value_type 为 1,2,3,4 时，则 value 的值则是存在其他地方的属性 uuid 的值

  3. 执行脚本（run_script）

参数名值类型允许空值说明
uuidstringF脚本 uuid
paramsobjectF参数

步骤属性​

fields

参数名值类型允许空值说明
field_uuidstringF属性 uuid
default_valueint,stringT默认值，如不需要默认值，则传 null
requiredboolF是否必填
{
  "fields": [
    {
      "field_uuid": "field004",
      "default_value": null, // 非文本属性其余一律传null
      "required": false
    },
    {
      "field_uuid": "field016",
      "default_value": "", // 文本属性无默认值可以传 ""
      "required": false
    }
  ]
}

步骤属性可以使用任务属性 uuid 作为 field_uuid，但不包含以下属性

属性 id说明
field001任务描述
field003任务创建者
field005任务状态
field006所属项目
field007任务类型
field008任务关注者
field009创建时间
field010更新时间
field014父任务 UUID
field015任务 ID
field017状态类型
field019已登记工时
field020剩余工时

除任务属性外，还有额外的三个特殊属性

属性 idcan_set_requiredcan_deletecan_set_default_value说明
tf-commentTFT评论
tf-manhourTTF工时
tf-resourceTTF文件

API 说明

1. 获取团队工作流列表​

列出当前团队所有工作流状态

URL​

https://your-host-name/project/api/project/team/:teamUUID/transitions

HTTP Method​

GET

调用权限​

无

传值方式​

URL

参数列表​

无

返回参数列表​

参数名值类型允许空值取值范围说明
transitionsarrayFtransition 列表，参考顶端的 transition 模型
server_update_stampint64Ftransition 类型的数据更新时间

请求体示例​

curl -X GET \
  https://your-host-name/project/api/project/team/3pDzCwAe/transitions \
  -H 'Content-Type: application/json' \
  -H 'Ones-Auth-Token: CUVZQSUJwRLfcVGSQoHEzI14LumPflYxJasP8MZHOLLgcjV5Rlnxy3YOjRN4z75w' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache' \
  -d '{"task_status":{"name":"update_task_status","category":"to_do"}}'

返回体示例​

{
  "transitions": [
    {
      "uuid": "ERTwiy99",
      "project_uuid": "DU6krHBNJEEeoG8M",
      "issue_type_uuid": "BivBjw7n",
      "start_status_uuid": "51ufBBFm",
      "end_status_uuid": "PLPLfNYH",
      "name": "重新激活",
      "position": 0,
      "trigger": null,
      "condition": null,
      "post_function": [],
      "fields": [
        {
          "field_uuid": "tf-comment",
          "default_value": "",
          "required": false,
          "type": -1,
          "can_set_required": true,
          "can_delete": false,
          "can_set_default_value": true
        }
      ]
    }
    //
  ],
  "server_update_stamp": 1566187581207696
}

2. 获取工作项对应工作流状态​

查询对应工作项的工作流状态

URL​

https://your-host-name/project/api/project/team/:teamUUID/task/:taskUUID/transitions

HTTP Method​

GET

调用权限​

无

传值方式​

URL

参数列表​

无

返回参数列表​

参数名值类型允许空值取值范围说明
transitionsarrayFtransition 列表
 uuidstringFtransition uuid
 namestringF名称
 start_status_uuidstringFlen=8起始任务状态 uuid
 end_status_uuidstringFlen=8结束任务状态 uuid
 match_conditionboolF是否符合 condition

3. 修改工作流​

修改一个 transition

URL​

https://your-host-name/project/api/project/team/:teamUUID/project/:projectUUID/issue_type/:issueTypeUUID/transition/:transitionUUID/update

HTTP Method​

POST

调用权限​

manage_project

传值方式​

JSON

参数列表​

参数名值类型允许空值取值范围说明
transitionobjectF参考顶端的 transition 模型，但不需要提供 project_uuid 和 issue_type_uuid
  post_functionobjectF参考顶端的 transition 模型，但不需要提供 project_uuid 和 issue_type_uuid

返回参数列表​

参数名值类型允许空值取值范围说明
transitionobjectF参考顶端的 transition 模型
server_update_stampint64Ftransition 类型的数据更新时间

请求体示例​

curl -X POST \
 https://your-host-name//project/api/project/team/14ZuYn5s/project/8m8X18wvKho6YOVv/issue_type/SRMtFidW/transition/EqucrZNi/update \
  -H 'Content-Type: application/json' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache' \
  -d '{
    "transition": {
        "post_function": [
            {
                "run_script": {
                    "uuid": "add_manhour",
                    "name": "自动提交剩余工时脚本",
                    "params": []
                }
            }
        ]
    }
}'

返回体示例​

{
  "transition": {
    "uuid": "EqucrZNi",
    "project_uuid": "8m8X18wvKho6YOVv",
    "issue_type_uuid": "SRMtFidW",
    "start_status_uuid": "EycE51RF",
    "end_status_uuid": "USDYT4D3",
    "name": "回归通过",
    "position": 4,
    "trigger": null,
    "condition": null,
    "post_function": [
      {
        "run_script": {
          "name": "自动提交剩余工时脚本",
          "params": [],
          "uuid": "add_manhour"
        }
      }
    ],
    "fields": [
      {
        "field_uuid": "tf-comment",
        "default_value": "",
        "type": null,
        "required": false
      }
    ]
  },
  "server_update_stamp": 1576725042685040
}

4. 对任务执行工作流​

对任务执行工作流，即修改工作项状态。如果 transition 内包含 post_function， 则当 post_function 异步执行完毕后会发送一条刷新推送，格式详见消息文档

URL​

https://your-host-name/project/api/project/team/:teamUUID/task/:taskUUID/new_transit

调用权限​

transit_tasks

HTTP Method​

POST

传值方式​

JSON

参数列表​

参数名值类型允许空值取值范围说明
transition_uuidstringF需要执行的 transition 的 uuid

请求体示例​

curl -X POST \
  https://your-host-name/project/api/project/team/3pDzCwAe/task/DU6krHBNNKSnnHNj/new_transit \
  -H 'Content-Type: application/json' \
  -H 'Ones-Auth-Token: CUVZQSUJwRLfcVGSQoHEzI14LumPflYxJasP8MZHOLLgcjV5Rlnxy3YOjRN4z75w' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache' \
  -d '{"transition_uuid":"7rPd2Qyi"}'

返回体示例​

{
  "code": 200,
  "errcode": "OK",
  "type": "OK"
}
Last updated on