获取工作项工作流信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /organization/{organizationId}/workitems/{workitemId}/getWorkflowInfo
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| organizationId | string | 是 | 企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https: //devops.aliyun.com/organization/【OrganizationId】 | 5ebbc0228123212b59xxxxx |
| configurationId | string | 否 | 对应工作项类型的工作流配置 id，该值可以从页面接口请求：https: //devops.aliyun.com/projex/api/workitem/workitemType/setting/space/getSpaceWorkitemTypeScope?spaceType=Project&spaceIdentifier=c595d0c3df4c743ac811......&workitemTypeIdentifier=ba102e46bc6a8483...... 中获取。对应的字段值在 result-> configurations-> 中 configType 为 Workflow 的 identifier。 | 711d33c738b9171c45fa...... |
| workitemId | string | 否 | 工作项 id，同 workitemIdentifier 字段，工作项唯一标识 | fd0xxxxx00d355b05df60xxxx |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
"errorCode": "Openapi.RequestError",
"errorMessage": "error",
"success": true,
"workflow": {
"identifier": "e8bxxxxxxxxxxxxxxxx23",
"name": "名称",
"description": "工作流的描述",
"ownerSpaceIdentifier": "e8b26xxxxx6e76aa20xxxxx23",
"ownerSpaceType": "null",
"defaultStatusIdentifier": "100005",
"statusOrder": "null",
"resourceType": "Project",
"source": "system",
"gmtCreate": 1640850318000,
"gmtModified": 1640850318000,
"creator": "19xx7043xxxxxxx914",
"modifier": "19xx7043xxxxxxx914",
"workflowActions": [
{
"id": 16274887,
"name": "xxx",
"workflowIdentifier": "fd0xxxxxd00d355b05dxxxx26",
"workflowStatusIdentifier": "100005",
"nextWorkflowStatusIdentifier": "100011"
}
],
"statuses": [
{
"identifier": "156603",
"name": "待处理",
"workflowStageName": "确认阶段",
"workflowStageIdentifier": "1",
"source": "system",
"gmtCreate": 1613805843000,
"gmtModified": 1613805843000,
"creator": "19xx7043xxxxxxx914",
"modifier": "19xx7043xxxxxxx914",
"description": "xxx",
"resourceType": "Workitem"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Openapi.RequestError | request error | OpenAPI请求数据错误 |
| 403 | Operate.NoPermission | NoPermission | 没有权限 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-10-28 | OpenAPI 错误码发生变更 | 查看变更详情 |