API: マイルストーン

get_milestone

既存のマイルストーンを返します。

GET index.php?/api/v2/get_milestone/:milestone_id

レスポンスの内容

典型的なレスポンスについては、下記を参照してください。

{
    "completed_on": 1389968184,
    "description": "...",
    "due_on": 1391968184,
    "id": 1,
    "is_completed": true,
    "name": "Release 1.5",
    "project_id": 1,
    "refs": "RF-1, RF-2",
    "url": "http://<server>/testrail/index.php?/milestones/view/1"
}

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

レスポンス コード

get_milestones

プロジェクトのマイルストーンのリストを返します。

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

リクエスト フィルター

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

レスポンスの内容

レスポンスにはマイルストーンの配列が含まれます。リスト内の各マイルストーンの形式は、get_milestone と同じです。

[
    {
        "id": 1,
        "name": "Release 1.5", ..
    },
    {
        "id": 2,
        "name": "Release 1.6", ..
    },
    ..
]

新しいレスポンスの内容

レスポンスにはマイルストーンの配列が含まれます。各マイルストーンのフォーマットは get_milestone と同じです。

{
    "offset": 0,
    "limit": 250,
    "size": 5,
    "_links": {
        "next": null,
        "prev": null,
    },
    "milestones": [
        {
            "id": 1,
            "name": "Release 1.5", ..
        },
        {
            "id": 2,
            "name": "Release 1.6", ..
        },
      ..
    ]
}

レスポンス コード

add_milestone

新規マイルストーンを作成します。

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

リクエスト フィールド

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

リクエストの例

期限を指定した新しい空のマイルストーンを作成する方法を示す例については下記を参照してください。

{
    "name": "Release 2.0",
    "due_on": 1394596385
}

レスポンスの内容

成功した場合、このメソッドは get_milestone と同じレスポンス形式を使用して新しいマイルストーンを返します。

レスポンス コード

update_milestone

既存のマイルストーンを更新します (部分的な更新がサポートされています。つまり、特定のフィールドのみを送信して更新できます)。

POST index.php?/api/v2/update_milestone/:milestone_id

リクエスト フィールド

add_milestone でサポートされている POST フィールドに加えて、このメソッドは以下もサポートしています。

リクエストの例

マイルストーンを完了としてマークする方法を示す例については下記を参照してください。

{
    "is_completed": true
}

レスポンスの内容

成功した場合、このメソッドは get_milestone と同じレスポンス形式を使用して更新されたマイルストーンを返します。

レスポンス コード

delete_milestone

既存のマイルストーンを削除します。

POST index.php?/api/v2/delete_milestone/:milestone_id

レスポンス コード