WorkflowApi

Trait WorkflowApi 

Source
pub trait WorkflowApi {
    // Required methods
    fn update_node(
        &self,
        project_key: &str,
        work_item_type_key: &str,
        work_item_id: i64,
        node_id: &str,
        request: UpdateNodeRequest,
        auth: AuthType,
    ) -> impl Future<Output = ApiResult<Value>> + Send;
    fn operate_node(
        &self,
        project_key: &str,
        work_item_type_key: &str,
        work_item_id: i64,
        node_id: &str,
        request: OperateNodeRequest,
        auth: AuthType,
    ) -> impl Future<Output = ApiResult<Value>> + Send;
    fn change_state(
        &self,
        project_key: &str,
        work_item_type_key: &str,
        work_item_id: i64,
        request: ChangeStateRequest,
        auth: AuthType,
    ) -> impl Future<Output = ApiResult<Value>> + Send;
    fn get_workflow_wbs(
        &self,
        project_key: &str,
        work_item_type_key: &str,
        work_item_id: i64,
        expand: Option<ExPand>,
        auth: AuthType,
    ) -> impl Future<Output = ApiResult<WbsViewResponse>> + Send;
    fn get_workflow_detail(
        &self,
        project_key: &str,
        work_item_type_key: &str,
        work_item_id: i64,
        request: GetWorkflowDetailRequest,
        auth: AuthType,
    ) -> impl Future<Output = ApiResult<NodesConnections>> + Send;
}

Required Methods§

Source

fn update_node( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, node_id: &str, request: UpdateNodeRequest, auth: AuthType, ) -> impl Future<Output = ApiResult<Value>> + Send

更新工作项实例的指定节点信息

该接口用于更新一个工作项实例的指定节点信息(节点流),包括节点负责人、排期和表单信息等。

§Arguments
  • project_key - 空间id或域名
  • work_item_type_key - 工作项类型
  • work_item_id - 工作项ID
  • node_id - 目标节点ID
  • request - 更新请求参数
  • auth - 认证信息
Source

fn operate_node( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, node_id: &str, request: OperateNodeRequest, auth: AuthType, ) -> impl Future<Output = ApiResult<Value>> + Send

完成或回滚工作项实例的指定节点

该接口用于完成或者回滚一个工作项实例的指定节点(节点流),同时更新节点信息。

§Arguments
  • project_key - 空间id或域名
  • work_item_type_key - 工作项类型
  • work_item_id - 工作项ID
  • node_id - 目标节点ID
  • request - 操作请求参数
  • auth - 认证信息
Source

fn change_state( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, request: ChangeStateRequest, auth: AuthType, ) -> impl Future<Output = ApiResult<Value>> + Send

状态流转

该接口用于流转一个工作项实例到指定状态(状态流),同时更新节点信息。

§Arguments
  • project_key - 空间id或域名
  • work_item_type_key - 工作项类型
  • work_item_id - 工作项ID
  • request - 状态流转请求参数
  • auth - 认证信息
Source

fn get_workflow_wbs( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, expand: Option<ExPand>, auth: AuthType, ) -> impl Future<Output = ApiResult<WbsViewResponse>> + Send

获取工作流详情(WBS)

该接口用于获取行业专版中一个节点流工作项实例的WBS工作流信息。

§Arguments
  • project_key - 空间id或域名
  • work_item_type_key - 工作项类型
  • work_item_id - 工作项ID
  • expand - 展开参数选项
  • auth - 认证信息
Source

fn get_workflow_detail( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, request: GetWorkflowDetailRequest, auth: AuthType, ) -> impl Future<Output = ApiResult<NodesConnections>> + Send

获取工作流详情

该接口用于获取指定空间和工作项类型下的一个工作项实例的工作流信息。

§Arguments
  • project_key - 空间id或域名
  • work_item_type_key - 工作项类型
  • work_item_id - 工作项ID
  • request - 查询请求参数
  • auth - 认证信息

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§