プロジェクト

プロジェクトに関する情報を取得したり、プロジェクトを作成または変更するには、次の API メソッドを使用します。 

get_project

既存のプロジェクトを返します。

GET index.php?/api/v2/get_project/{project_id}

{
    "id": 1,
    "announcement": "Welcome to project X",
    "completed_on": 1389968184,
    "default_role_id": 3,
    "default_role": "Tester",
    "is_completed": false,
    "name": "Project X",
    "show_announcement": true,
    "suite_mode": 1,
    "url": "https://instance.testrail.io/index.php?/projects/overview/1",
    "users": [
        {
            "id": 3,
            "global_role_id": null,
            "global_role": null,
            "project_role_id": null,
            "project_role": null
        }
    ],
    "groups": []
}

GET index.php?/api/v2/get_projects

# All active projects
GET index.php?/api/v2/get_projects&is_completed=0

レスポンスの内容

レスポンスにはプロジェクトの配列が含まれます。リスト内の各プロジェクトの形式は、get_project と同じです。

{
    "offset": 0,
    "limit": 250,
    "size": 2,
    "_links": {
        "next": null,
        "prev": null,
    },
    "projects": [
        { "id": 1, "name": "DataHub", .. },
        { "id": 2, "name": "Writer", .. }
    ]
}

レスポンスコード

POST index.php?/api/v2/add_project

リクエストボディ

POST リクエスト ボディ メッセージで以下のフィルターを適用できます。

リクエストの例

新しい空のプロジェクトを作成する方法を示す例については下記を参照してください。

{
    "name": "Project X",
    "announcement": "Welcome to project X",
    "show_announcement": true
}

レスポンスの内容

成功した場合、このメソッドは get_project と同じレスポンス形式を使用して新しいプロジェクトを返します。

レスポンスコード

update_project

POST index.php?/api/v2/update_project/{project_id}

リクエストの例

プロジェクトを完了としてマークする方法を示す例については下記を参照してください。

{
    "announcement": "Happy Holidays Everyone!"
}

レスポンスの内容

{
    "name": "Project X",
    "announcement": "Welcome to project X",
    "show_announcement": true,
    "default_role_id": 3,
    "is_completed": false,
    "users": [
        {
            "user_id": 4,
            "role_id": null
        }
    ]
    "groups": []
}

レスポンスには次のフィールドが含まれています。

レスポンスには次の GROUPS フィールドが含まれています。

レスポンスには次の USERS フィールドが含まれています。

レスポンス コード

POST index.php?/api/v2/delete_project/{project_id}

パラメーター

レスポンス コード