迭代 API_API_云效项目协作 Projects

创建迭代

API:

CreateDevopsProjectSprint

请求参数


参数	类型	是否必须	说明
OrgId	string	是	企业Id
projectId	string	是	项目 ID
name	string	是	迭代名
description	string	否	迭代描述
executorId	string	是	迭代指派人
startDate	string	否	迭代开始时间 "2020-07-16T02:44:22.539Z"
dueDate	string	否	迭代结束时间 "2020-07-16T02:44:22.539Z"

{
    "Successful": true,
    "ErrorCode": null,
    "ErrorMsg": null,
    "Object": {
        "Created": "2020-07-16T02:44:22.539Z",
        "DueDate": "2020-07-24T00:00:00.000Z",
        "Description": "ceshi,sssss",
        "PlanToDo": {
            "StoryPoints": 0,
            "WorkTimes": 0,
            "Tasks": 0
        },
        "Accomplished": null,
        "IsDeleted": false,
        "Executor": null,
        "Name": "ceshi132",
        "CreatorId": "5e9ee108424a50d98c7c8906",
        "Id": "5f0fbf0648b5480049734184",
        "updated": "2020-07-16T02:44:22.539Z",
        "StartDate": null,
        "Status": "future",
        "ProjectId": "5f0ec62cccd91500486764ba"
    },
    RequestId": null
}

返回参数说明：

参数	说明
└ CreatorId	创建人 ID
└SprintId	迭代 ID
└ ProjectId	所属项目 ID
└ExecutorId	迭代执行人 ID
└Name	迭代名
└Description	迭代描述
└StartDate	迭代开始时间
└ DueDate	迭代结束时间
└Created	创建时间
└Updated	更新时间
└ Status	迭代状态

示例代码：

         String endPoint = "api-devops.cn-hangzhou.aliyuncs.com";
         DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地域ID
            "<ak>",      
            "<sk>");    
        IAcsClient client = new DefaultAcsClient(profile);
        String endPoint = "api-devops.cn-hangzhou.aliyuncs.com";
        CreateDevopsProjectSprintRequest createProjectSprintRequest =new CreateDevopsProjectSprintRequest();
        createProjectSprintRequest.setOrgId(orgId);
        createProjectSprintRequest.setProjectId(projectId);
        createProjectSprintRequest.setName("xftest迭代"+dateString);
        createProjectSprintRequest.setDescription("新增迭代描述"+dateString);
        //用户id
        createProjectSprintRequest.setExecutorId(userId);
        //开始时间
        createProjectSprintRequest.setStartDate("2020-08-16T02:44:22.539Z");
        //结束时间
        createProjectSprintRequest.setDueDate("2020-08-30T02:44:22.539Z");
        createProjectSprintRequest.setSysEndpoint(endPoint);
        CreateDevopsProjectSprintResponse acsResponse = client.getAcsResponse(createProjectSprintRequest);

查看迭代

API:

GetDevopsProjectSprintInfo

请求参数:


参数	类型	是否必须	说明
OrgId	string	是	企业Id。
sprintId	string	是	迭代 ID

{
    "successful": true,
    "errorCode": null,
    "errorMsg": null,
    "object": 
        {
            "accomplished": null,
            "isDeleted": false,
            "created": "2020-07-16T02:44:22.539Z",
            "dueDate": "2020-07-24T00:00:00.000Z",
            "name": "ceshi132",
            "_creatorId": "5e9ee108424a50d98c7c8906",
            "_id": "5f0fbf0648b5480049734184",
            "updated": "2020-07-16T02:44:22.539Z",
            "startDate": null,
            "status": "future",
            "planToDo": {
                "storyPoints": 0,
                "workTimes": 0,
                "tasks": 0
            },
            "_projectId": "5f0ec62cccd91500486764ba"
        },
    "requestId": null,
    "httpStatusCode": 200
}

返回参数说明：

参数	说明
└ CreatorId	创建人 ID
└SprintId	迭代 ID
└ ProjectId	所属项目 ID
└ExecutorId	迭代执行人 ID
└Name	迭代名
└Description	迭代描述
└StartDate	迭代开始时间
└ DueDate	迭代结束时间
└Created	创建时间
└Updated	更新时间
└ Status	迭代状态

示例代码：

         String endPoint = "api-devops.cn-hangzhou.aliyuncs.com";
         DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地域ID
            "<ak>",      
            "<sk>");    
        IAcsClient client = new DefaultAcsClient(profile);
        String endPoint = "api-devops.cn-hangzhou.aliyuncs.com";
        GetDevopsProjectSprintInfoRequest getProjectSprintRequest =new GetDevopsProjectSprintInfoRequest();
        getProjectSprintRequest.setOrgId(orgId);
        getProjectSprintRequest.setSprintId(sprintId);
        getProjectSprintRequest.setSysEndpoint(endPoint);
        GetDevopsProjectSprintInfoResponse acsResponse = client.getAcsResponse(getProjectSprintRequest);

修改迭代

API:

UpdateDevopsProjectSprint

请求参数


参数	类型	是否必须	说明
OrgId	string	是	企业Id操作人的用户 ID，该用户需要具备创建迭代的权限。
ProjectId	string	是	项目 ID
Name	string	是	迭代名
Description	string	否	迭代描述
ExecutorId	string	是	迭代指派人
StartDate	string	否	迭代开始时间 "2020-07-16T02:44:22.539Z"
DueDate	string	否	迭代结束时间 "2020-07-16T02:44:22.539Z"
SprintId	string	是	迭代id

{
    "Successful": true,
    "ErrorCode": null,
    "ErrorMsg": null,
    "Object": true,
    RequestId": null
}

示例代码：

         String endPoint = "api-devops.cn-hangzhou.aliyuncs.com";
         DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地域ID
            "<ak>",      
            "<sk>");    
        IAcsClient client = new DefaultAcsClient(profile);
        String endPoint = "api-devops.cn-hangzhou.aliyuncs.com";
        UpdateDevopsProjectSprintRequest updateProjectSprintRequest=new UpdateDevopsProjectSprintRequest();
       updateProjectSprintRequest.setOrgId(orgId);
        updateProjectSprintRequest.setSprintId(sprintId1);
        updateProjectSprintRequest.setProjectId(projectId);
        updateProjectSprintRequest.setName("更新迭代88888");
        updateProjectSprintRequest.setExecutorId(userId3);
        updateProjectSprintRequest.setDescription("更新描述88888");
        updateProjectSprintRequest.setStartDate("2020-08-11T02:44:22.539Z");
        updateProjectSprintRequest.setDueDate("2020-08-20T02:44:22.539Z");
        updateProjectSprintRequest.setSysEndpoint(endPoint);
        UpdateDevopsProjectSprintResponse acsResponse= client.getAcsResponse(updateProjectSprintRequest);

查看项目下迭代

API:

ListProjectSprints

请求参数:


参数	类型	是否必须	说明
OrgId	string	是	企业Id。
projectId	string	是	项目 ID

{
    "Successful": true,
    "ErrorCode": null,
    "ErrorMsg": null,
    "Object": [
        {
            "Accomplished": null,
            "IsDeleted": false,
            "Created": "2020-07-16T02:44:22.539Z",
            "DueDate": "2020-07-24T00:00:00.000Z",
            "Name": "ceshi132",
            "CreatorId": "5e9ee108424a50d98c7c8906",
            "Id": "5f0fbf0648b5480049734184",
            "Updated": "2020-07-16T02:44:22.539Z",
            "StartDate": null,
            "Status": "future",
            "PlanToDo": {
                "StoryPoints": 0,
                "WorkTimes": 0,
                "Tasks": 0
            },
            "ProjectId": "5f0ec62cccd91500486764ba"
        }
    ],
    "RequestId": null
}

返回参数说明：

参数	说明
└ CreatorId	创建人 ID
└SprintId	迭代 ID
└ ProjectId	所属项目 ID
└ExecutorId	迭代执行人 ID
└Name	迭代名
└Description	迭代描述
└StartDate	迭代开始时间
└ DueDate	迭代结束时间
└Created	创建时间
└Updated	更新时间
└ Status	迭代状态

示例代码：

         String endPoint = "api-devops.cn-hangzhou.aliyuncs.com";
         DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // 地域ID
            "<ak>",      
            "<sk>");    
        IAcsClient client = new DefaultAcsClient(profile);
        String endPoint = "api-devops.cn-hangzhou.aliyuncs.com";
        ListDevopsProjectSprintsRequest listProjectSprintsRequest=new ListDevopsProjectSprintsRequest();
        listProjectSprintsRequest.setOrgId(orgId);
        listProjectSprintsRequest.setProjectId(projectId);
        listProjectSprintsRequest.setSysEndpoint(endPoint);
        ListDevopsProjectSprintsResponse acsResponse = client.getAcsResponse(listProjectSprintsRequest);