API: プロジェクト

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

get_project

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

GET index.php?/api/v2/get_project/:project_id

レスポンスの内容

典型的なレスポンスについては、次のサンプルを参照してください。

{
    "announcement": "..",
    "completed_on": null,
    "id": 1,
    "is_completed": false,
    "name": "Datahub",
    "show_announcement": true,
    "url": "http://<server>/testrail/index.php?/projects/overview/1"
}

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

レスポンス コード

get_projects

利用可能なプロジェクトのリストを返します。

GET index.php?/api/v2/get_projects

リクエスト フィルター

以下のフィルターを適用できます。

レスポンスの内容

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

[
    { "id": 1, "name": "DataHub", .. },
    { "id": 2, "name": "Writer", .. },
    ..
]

新しいレスポンスの内容

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

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

レスポンス コード

add_project

新規プロジェクトを作成します (管理者権限が必要です)。

POST index.php?/api/v2/add_project

リクエスト フィールド

以下の POST フィールドがサポートされています。

リクエストの例

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

{
    "name": "This is a new project",
    "announcement": "This is the description for the project",
    "show_announcement": true
}

レスポンスの内容

レスポンス コード

update_project

既存のプロジェクトを更新します (管理者権限が必要です。部分的な更新がサポートされています。つまり、特定のフィールドのみを送信して更新できます)。

POST index.php?/api/v2/update_project/:project_id

リクエスト フィールド

以下の POST フィールドがサポートされています。

リクエストの例

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

{
    "is_completed": true
}

レスポンスの内容

レスポンス コード

delete_project

既存のプロジェクトを削除します (管理者権限が必要です)。

POST index.php?/api/v2/delete_project/:project_id

レスポンス コード