1. ZenTao API development guides
1.1 Configuration and FAQ
1.2 Examples of the calling SDK
1.3. Department interface
1.3.1 Get the department list
1.3.2 Batch create departments
1.4. User interface
1.4.1 Get patameters of adding users
1.4.2 Add a single user
1.4.3 Get the user list
1.5. Product interface
1.5.1 Get the product list
1.5.2 Optional information for adding a single product
1.5.3 Create a single product
1.6. Project interface
1.6.1 Get the project list
1.6.2 Optional information for adding a single project
1.6.3 Create a single project
1.7. Task interface
1.7.1 Get the task list
1.7.2 Optional information for adding a single task
1.7.3 Create a single task
1.7.4 Optional information for finishing a single task
1.7.5 Finish a single task
1.8. Bug interface
1.8.1 Get the bug list
1.8.2 Optional information for reporting a single bug
1.8.3 Report a single bug
1.8.4 Optional information for resolving a single bug
1.8.5 Resolve a single bug
2. ZenTao API documents (V1.0)
2.1. Token
2.1.1 Get Token
2.2. Department
2.2.1 Get the department list
2.2.2 Get department details
2.3. User
2.3.1 Access to my profile
2.3.2 Get the user list
2.3.3 Get user information
2.3.4 Edit user information
2.3.5 Delete users
2.3.6 Create users
2.4. Program
2.4.1 Get the program list
2.4.2 Edit programs
2.4.3 Access to program details
2.4.4 Delete programs
2.4.5 Create programs
2.5. Product
2.5.1 Get the product list
2.5.2 Create products
2.5.3 Get product details
2.5.4 Edit products
2.5.5 Delete products
2.6. Product plan
2.6.1 Get the list of product plans
2.6.2 Create plans
2.6.3 Get plan details
2.6.4 Edit plans
2.6.5 Delete plans
2.6.6 Link the stories to the product plan
2.6.7 Cancel the link between the product plans and stories
2.6.8 Link the bugs to the product plan
2.6.9 Cancel the link between the product plan and bugs
2.7. Release
2.7.1 Get the release list of product
2.7.2 Get the release list of project
2.8. Story
2.8.1 Get product story list
2.8.2 Get project story list
2.8.3 Get execution story list
2.8.4 Create story
2.8.5 Get story details
2.8.6 Change story
2.8.7 Change some other fileds of story
2.8.8 Delete story
2.9. Project
2.9.1 Get project list
2.9.2 Create project
2.9.3 Get project details
2.9.4 Modify project
2.9.5 Delete project
2.10. Build
2.10.1 Get the build list of project
2.10.2 Get the build list of execution
2.10.3 Create build
2.10.4 Get build details
2.10.5 Modify build
2.10.6 Delete build
2.11. Execution
2.11.1 Get the execution list of project
2.11.2 Create execution
2.11.3 Check the details of execution
2.11.4 Modify execution
2.11.5 Delete execution
2.12. Task
2.12.1 Get the task list of execution
2.12.2 Create task
2.12.3 Get task details
2.12.4 Modify task
2.12.5 Delete task
2.12.6 Start task
2.12.7 Suspend task
2.12.8 Continue task
2.12.9 Finish task
2.13. Bug
2.13.1 Get the bug list of product
2.13.2 Create bug
2.13.3 Get bug details
2.13.4 Modify bug
2.13.5 Delete bug
2.14. Use case
2.14.1 Get use case list of product
2.14.2 Create use case
2.14.3 Get use case details
2.14.4 Modify test case
2.14.5 Delete test case
2.14.6 Run test case
2.15. Test request
2.15.1 Get test request list
2.15.2 Get the test request of project
2.15.3 Get the details of test reuqest
2.16. Feedback
2.16.1 Create feedback
2.16.2 Assign feedback
2.16.3 Close feedback
2.16.4 Delete feedback
2.16.5 Modify feedback
2.16.6 Get feedback details
2.16.7 Get feedback list
3. Customized development
3.1 Secondary development mechanism
3.2 The directory structure of ZenTao
3.3 Find your target file to be modified
3.4 The database structure of ZenTao
3.5 Public module - common
3.6 How to register on menu
3.7 How to register on permission
3.8 Example: how to modify the prompt
3.9 Example: priority field setting when creating bugs
3.10 The online extension editor
3.11 Secondary development editor and translation function restrictions instructions
3.12 ZenTao project management software packaging specification (V1.1)

Get the project list

2022-12-21 10:24:41
Kelsea
63
Last edited by Yujia Li on 2022-12-21 14:19:24
Share links
Summary : Request this method to get the list of products according to the status of the products.
Method Description Request this method to get the list of products according to the status of the products.
Example
public function getProjectList()
{
    include_once('../vendor/zentao/zentao.php');
    $zentao      = new \zentao();
    $params      = array('status' => 'doing');    // request parameter
    $extraFields = array('title', 'projects', 'projectStats', 'teamMembers', 'users');    // customize fields
    $result      = $zentao->getProjectList($params, $extraFields);
    return $result;
}
Request GET
Method getProjectList
Parameter
Name Type Required Description
status
string Optional Project status【all|undone|wait|doing|suspended|closed】
Result
success error
{
    "status": 1,
    "msg": "success",
    "result": {
         //the navbar of ZenTao
        "title": "All Projects",
        // a list of project names
        "projects": {
            "1": "ZenTao PHP-SDK Dev",
            "2": "Taobao Dev",
            "3": "Tmall Dev"
        },
        // a list of project details
        "projectStats": [
            {
                "id": "1",// project ID
                "isCat": "0",
                "catID": "0",
                "type": "sprint",// project type【sprint|waterfall|ops】
                "parent": "0",
                "name": "ZenTao PHP-SDK",// project name
                "code": "002",// project code
                "begin": "2019-11-11",// start date
                "end": "2019-11-23",// end date
                "days": "10",// available work days
                "status": "doing",// project status【all|undone|wait|doing|suspended|closed】
                "subStatus": "",
                "statge": "1",
                "pri": "1",
                "desc": "ZenTao PHP-SDK Dev is used to manage projects via PHPer more efficiently",// project description
                "openedBy": "admin",// the one who creates the project
                "openedDate": "2019-11-11 15:24:14",// create time
                "openedVersion": "11.6.4",// ZenTao version number
                "closedBy": "",// the one who closed the project
                "closedDate": "0000-00-00 00:00:00",// close time
                "canceledBy": "",// the one who closed the project
                "canceledDate": "0000-00-00 00:00:00",// cancel time
                "PO": "zhangsan",// PO
                "PM": "niuqi",// PM
                "QD": "admin",// QA Manager
                "RD": "lisi",// Release Manager
                "team": "ZenTao Dev",// team name
                "acl": "open",// access control【open|private|custom】
                "whitelist": "",// whitelist
                "order": "5",// the order of the project in the list
                "deleted": "0",
                "burns": [// burndown data
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    "28"
                ],
                "hours": {
                    "totalEstimate": 28,// estimated hour
                    "totalConsumed": 21,// cost hour
                    "totalLeft": 28,// left hour
                    "progress": 42.9,// progress percentage
                    "totalReal": 49
                }
            } ],
        // the list of team members
        "teamMembers": {
            "admin": {
                "id": "9",
                "root": "2",
                "type": "project",
                "account": "admin",
                "role": "",
                "limited": "no",
                "join": "2019-11-20",
                "days": "8",
                "hours": "7.0",
                "estimate": "0.00",
                "consumed": "0.00",
                "left": "0.00",
                "order": "0",
                "totalHours": "56.0",
                "realname": "admin"
            },
            "niuqi": {
                "id": "11",
                "root": "2",
                "type": "project",
                "account": "niuqi",
                "role": "Other",
                "limited": "no",
                "join": "2019-11-20",
                "days": "8",
                "hours": "7.0",
                "estimate": "0.00",
                "consumed": "0.00",
                "left": "0.00",
                "order": "0",
                "totalHours": "56.0",
                "realname": "Niu Qi"
            },
            "wangwu": {
                "id": "12",
                "root": "2",
                "type": "project",
                "account": "wangwu",
                "role": "Dev",
                "limited": "no",
                "join": "2019-11-20",
                "days": "8",
                "hours": "7.0",
                "estimate": "0.00",
                "consumed": "0.00",
                "left": "0.00",
                "order": "0",
                "totalHours": "56.0",
                "realname": "Wang Wu"
            },
            "zhapliu": {
                "id": "10",
                "root": "2",
                "type": "project",
                "account": "zhapliu",
                "role": "QA",
                "limited": "no",
                "join": "2019-11-20",
                "days": "8",
                "hours": "7.0",
                "estimate": "0.00",
                "consumed": "0.00",
                "left": "0.00",
                "order": "0",
                "totalHours": "56.0",
                "realname": "Zhao Liu"
            }
        },
        // the user list data
        "users": {
            "_empty_": "",
            "admin": "admin",
            "lisi": "Li Si",
            "niuqi": "Niu Qi",
            "wangwu": "Wang Wu",
            "zhangsan": "Zhang San",
            "zhapliu": "Zhao Liu",
            "closed": "Closed"
        }
    }
}
{
    "status": 0,
    "msg": "error",
    "result": []
}

Write a Comment
Comment will be posted after it is reviewed.