Breadcrumbs

REST API

このドキュメントでは、製品独自の操作をプログラム的に行うための synapseRT NextGen の一般利用可能な REST API の一覧を示します。

テスト計画へのテスト ケースの追加

POST /rest/synapse/latest/public/testPlan/{testPlanIssueKey}/addMembers

リクエスト

 例

{
	"testCaseKeys":["ABC-1","ABC-2","ABC-3"]
}
応答

Status 200 テスト ケースがテスト計画に正常に追加された場合に返されます。

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404 提示された testPlanIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト計画へのテスト サイクルの追加

POST /rest/synapse/latest/public/testPlan/{testPlanIssueKey}/addCycle

リクエスト

例

{
	"name":"Sample Cycle",
	"environment":"Firefox",
	"build":"8.1"
}
応答

Status 200 テスト サイクルがテスト計画に正常に追加された場合に返されます。

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404 提示された testPlanIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト サイクル ステータスの更新

PUT /rest/synapse/latest/public/testPlan/{testPlanIssueKey}/cycle/{cycleName}/wf/{action}

リクエスト

有効な操作は以下のとおりです

  • Start

  • Complete

  • Abort

  • Resume

応答

Status 200 テスト サイクル ステータスが正常に更新された場合に返されます。

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404 提示された testPlanIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト実行の更新

POST /rest/synapse/latest/public/testPlan/{testPlanIssueKey}/cycle/{cycleName}/updateTestRun

リクエスト

例

{
	"testcaseKey":"ABC-4",
	"result":"Passed",
	"comment":"Updated through REST"
}
応答

Status 200 テスト実行が正常に更新された場合に返されます。

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404  提示された testPlanIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト実行へのバグのリンク

POST /rest/synapse/latest/public/testPlan/{testPlanIssueKey}/cycle/{cycleName}/linkBugToTestRun

リクエスト

例

{
	"testcaseKey":"ABC-5",
	"bugs":["ABC-6","ABC-7"]
}
応答

Status 200 バグがテスト実行に正常にリンクされた場合に返されます。

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404 提示された testPlanIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト計画でのテスト サイクルの取得

GET /rest/synapse/latest/public/testPlan/{testPlanIssueKey}/cycles

応答

Status 200 テスト サイクルが正常に取得された場合に返されます。

例

[
    {
        "ID": 1,
        "name": "Cycle 1",
        "status": "Completed",
        "draft": false,
        "deleteable": false,
        "cycleStartedDate": "2016-04-11T12:44:15.105+0530",
        "cycleCompletedDate": "2016-04-29T15:48:01.806+0530"
    },
    {
        "ID": 2,
        "name": "Cycle 2",
        "status": "Aborted",
        "draft": false,
        "deleteable": false,
        "cycleStartedDate": "2016-04-15T15:53:53.854+0530",
        "cycleCompletedDate": "2016-04-29T15:48:17.640+0530"
    },
    {
        "ID": 3,
        "name": "Cycle 3",
        "status": "Active",
        "draft": false,
        "deleteable": false,
        "cycleStartedDate": "2016-04-15T15:54:03.909+0530"
    },
    {
        "ID": 4,
        "name": "Cycle 4",
        "status": "Draft",
        "draft": true,
        "deleteable": true
    }
]

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404 提示された testPlanIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト サイクルでのテスト実行の取得

GET /rest/synapse/latest/public/testPlan/{testPlanIssueKey}/cycle/{cycleName}/testRuns

応答

Status 200 テスト実行が正常に取得された場合に返されます。

例

[
	{
		"ID": 1,
		"summary": "Case 1",
		"status": "Failed",
		"testCaseKey": "TP-3",
		"executedBy": "admin",
		"attachments":
		[
			{
				"ID": 2,
				"fileName": "atlassian-jira (1).log",
				"mimeType": "application/octet-stream"
			}
		],
		"bugs":
		[
			{
				"id": 10100,
				"key": "TP-6",
				"summary": "bug"
			}
		],
		"executionTimeStamp": "2016-04-29T19:15:57.105+0530"
	},
	{
		"ID": 2,
		"summary": "Case 2",
		"status": "Not Tested",
		"testCaseKey": "TP-4",
		"executedBy": "admin",
		"bugs":
		[
			{
				"id": 10100,
				"key": "TP-6",
				"summary": "bug"
			},
			{
				"id": 10300,
				"key": "TP-9",
				"summary": "test 1"
			},
			{
				"id": 10301,
				"key": "TP-10",
				"summary": "bug-2"
			}
		],
		"executionTimeStamp": "2016-04-29T11:06:30.011+0530"
	}
]

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404  提示された testPlanIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト ケースへのテスト ステップの追加

POST /rest/synapse/latest/public/testCase/{testCaseIssueKey}/addSteps

リクエスト

例

[
	{
		"step":"Login with valid username and password",
		"expectedResult":"Successful Login"
	},
	{
		"step":"Check if Dashboard is loaded",
		"expectedResult":"Default Dashboard successfully loaded"
	}
]
応答

Status 200 テスト ステップがテスト ケースに正常に追加された場合に返されます。

例

[
	{
		"ID":1,
		"tcId":10001,
		"step":"Login with valid username and password",
		"expectedResult":"Successful Login",
		"sequenceNumber":1
		
	},
	{
		"ID":2,
		"tcId":10001,
		"step":"Check if Dashboard is loaded",
		"expectedResult":"Default Dashboard successfully loaded",
		"sequenceNumber":2
	}
]

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404  提示された testCaseIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト ケースのテスト ステップの取得

GET /rest/synapse/latest/public/testCase/{testCaseIssueKey}/steps

応答

Status 200 テスト ステップがテスト ケースから正常に取得された場合に返されます。

例 

[
	{
		"ID":1,
		"tcId":10001,
		"step":"Login with valid username and password",
		"expectedResult":"Successful Login",
		"sequenceNumber":1
		
	},
	{
		"ID":2,
		"tcId":10001,
		"step":"Check if Dashboard is loaded",
		"expectedResult":"Default Dashboard successfully loaded",
		"sequenceNumber":2
	}
]

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404  提示された testCaseIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

要件へのテスト ケースのリンク

POST /rest/synapse/latest/public/requirement/{requirementIssueKey}/linkTestCase

リクエスト

例

{
	"testCaseKeys":["ABC-10","ABC-11"]
}
応答

Status 200 テスト ケースが要件に正常にリンクされている場合に返されます。

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404  提示された requirementIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

要件への子要件の追加

POST /rest/synapse/latest/public/requirement/{requirementIssueKey}/addChildren

リクエスト

例

{
	"requirementKeys":["ABC-12","ABC-13"]
}
応答

Status 200 子要件が要件に正常にリンクされている場合に返されます。

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404  提示された requirementIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。

テスト計画でのテスト ケースの取得

GET /rest/synapse/latest/public/testPlan/{testplanIssueKey}/members

応答

Status 200 テスト ケースがテスト計画から正常に取得された場合に返されます。

例

[
  {
    "ID": 1138,
    "tcId": 15414,
    "tpId": 15416,
    "testCaseKey": "SPC-1",
    "testCaseSummary": "Verify if the user name is correct"
  },
  {
    "ID": 1140,
    "tcId": 15415,
    "tpId": 15416,
    "testCaseKey": "SPC-2",
    "testCaseSummary": "Verify if the age name is correct"
  }
]

Status 403 ユーザーが操作を行う権限がないか有効なライセンスがない場合に返されます。

Status 404  提示された testPaseIssueKey が見つからない場合に返されます。

Status 500 入力データで検証エラーがある場合や不明な内部サーバー エラーがある場合に返されます。