JiraプラグインAPIのテスト管理

ALM Octane– Jiraプラグインバージョン1.0.8.2以降のテスト管理を使用している場合は、Jiraオンプレミス環境で次のAPIリソースを使用できます。

ログイン

ALM Octaneテスト管理JiraプラグインREST APIを使用するには、認証を受ける必要があります。そのためには、基本認証またはセッションCookieを使用できます。

基本認証:

リクエストごとにヘッダーを追加します。

Authorization:  Basic <username: password >

注: <username: password >はbase64でエンコードする必要があります

Cookie認証:

次のURLを使用してCookieを取得し、ユーザー名とパスワードをJSONに指定します。

POST <JIRA_BASE_URL>/rest/auth/1/session 
{ 
	"username" : "<username>",
	"password" : "<password>"
}

以降のリクエストでは、提供されたCookieを使用してください。

トップに戻る

プロキシ設定

プロキシ設定を追加します。

PUT <JIRA_BASE_URL>/rest/octane-admin/1.0/proxy

{

"host": "<PROXY_HOST>",

"port": "<PROXY_PORT>",

"username": "…",

"password": "…",

"nonProxyHost": "…"

}

nonProxyHostは、プロキシを使用しないホストのリストを「|」で区切って表します。キャラクター。ワイルドカード「*」を使用できます。

プロキシ設定が正常に追加された場合、ステータス200 (OK) が返されます。

プロキシ設定を取得します。

GET <JIRA_BASE_URL>/rest/octane-admin/1.0/proxy

次の形式で、プロキシ構成設定を含むJSONを返します。

{

"host": "…",

"port": "…",

"username": "…",

"password": "…",

"nonProxyHost": "…"

}

トップに戻る

スペース構成

テストスペース接続: 

POST <JIRA_BASE_URL>/rest/octane-admin/1.0/spaces/test-connection

データとして、接続をテストするスペース構成を含むJSONを提供する必要があります。

すでに定義されているスペース接続の接続をテストできます。この場合、JSONでスペース構成IDを指定するか、新しい場所への接続をテストする必要があります。

たとえば、すでに定義されているスペース構成への接続をテストします。

{

"id": "<spaceConfigurationId>",

"location": "http://localhost:9090/dev/ui/?p=1001/1002",

"clientId": "<username>",

"clientSecret": "<password>"

}

スペース構成を作成する前に接続をテストする場合は、IDなしで要求を送信できます。

{

"location": "http://localhost:9090/dev/ui/?p=1001/1002",

"clientId": "<username>",

"clientSecret": "<password>"

}

要求は、指定された場所が資格情報<username>および<password>でアクセス可能かどうかを確認し、スペース構成名と場所の一意性も検証します。

接続を確立できなかった場合、または検証に失敗した場合は、ステータス409 (競合) がエラーメッセージとともに返されます。

接続に成功すると、ステータス200 (OK) が返されます。

新しいスペース構成を追加します。

POST <JIRA_BASE_URL>/rest/octane-admin/1.0/spaces

データとして、構成の名前、ALM OctaneサーバーのベースURL、およびログインに使用されるクライアントIDとクライアントシークレットを含むJSONを提供する必要があります。例:

{

"name": "local",

"location": "http://localhost:8080/dev/ui/?p=1001/1002",

"clientId": "<username>",

"clientSecret": "<password>"

}

場所は、ALM OctaneアプリケーションのURLを表します。

例: http://myServer.myCompany.com:8081/ui/?p=1001

注:  

  • サーバーベースURLと共有スペースIDは場所に必須です。共有スペースIDの後に続くものはすべて無視されます。
  • 同じ名前または場所で2つのスペース構成を持つことはできません。

接続を検証するには、REST呼び出しを使用して接続をテストします (上記を参照)。

スペース構成を取得します。

GET <JIRA_BASE_URL>/rest/octane-admin/1.0/spaces

定義されたすべてのスペースの構成をJSON形式で返します。

スペース構成の更新: 

PUT <JIRA_BASE_URL>/rest/octane-admin/1.0/spaces/{space_configuration_id}

以下の例のように、更新されたスペース構成JSONを提供します。

{

"name": "local",

"location": "http://localhost:9090/dev/ui/?p=1001/1002",

"clientId": "<username>",

"clientSecret": "<password>"

}

更新されたスペース構成をJSON形式で返します。

スペース構成の削除: 

DELETE <JIRA_BASE_URL>/rest/octane-admin/1.0/spaces/{space_configuration_id}

成功した場合はステータス200 (OK) を返し、スペース構成IDが存在しない場合は404 (見つかりません) を返します。

トップに戻る

ワークスペース設定

すべてのワークスペース構成を取得する

GET <JIRA_BASE_URL>/rest/octane-admin/1.0/workspaces

定義されたすべてのワークスペース構成を含むJSON配列を返します。

ワークスペース構成を取得する

GET <JIRA_BASE_URL>/rest/octane-admin/1.0/workspaces/{workspaceConfigurationId}

指定された{workspaceConfigurationId}のワークスペース構成を含むJSONを返します。

ワークスペース構成を追加する

POST <JIRA_BASE_URL>/rest/octane-admin/1.0/workspaces

JSON本体の例:

{

"spaceConfigId": "<space_configuration_id>",

"workspaceId": "1002",

"workspaceName": "default_workspace",

"octaneUdf": "jira_udf",

"jiraIssueTypes": ["Bug", "Epic","Story"],

"jiraProjects": [“<JIRA_PROJECT_KEY>"]

}

提供されたデータは検証されます。ワークスペースはアクティブで、指定されたスペースの一部であり、まだ使用されていない必要があります。各Jiraプロジェクトは、1つのALM Octaneワークスペースに対してのみ選択できます。

リクエストが成功した場合、ステータス200 (OK) が、すべてのフィールドを含む構成JSONとともに返されます。

応答本文の例:

{

"id": "<workspace_configuration_id>",

"spaceConfigId": "<space_configuration_id>",

"spaceConfigName": "local",

"workspaceId": "1002",

"workspaceName": "default_workspace",

"octaneUdf": "jira_udf",

"octaneEntityTypes": [ "User Story", "Defect", "Feature"],

"jiraIssueTypes": ["Epic","Bug","Story"],

"jiraProjects": [“<JIRA_PROJECT_KEY>"]

}

octaneEntityTypesリストは、指定されたワークスペースで指定されたUDFを持つALM Octaneからサポートされているエンティティタイプでオートコンプリートされます。エンティティが見つからない場合は、エラーメッセージが返され、リクエストのステータスは409 (CONFLICT) になります。

ワークスペース構成を更新する

PUT <JIRA_BASE_URL>/rest/octane-admin/1.0/workspaces/{workspaceConfigurationId}

以下の例のように、更新されたJSONを提供します。

{

"workspaceId":"1002",

"workspaceName":"default_workspace",

"spaceConfigId":"78b8c1b9-353b-4f6d-bbae-937280386f10",

"spaceConfigName":"local_rest",

"octaneUdf":"jira_udf",

"jiraIssueTypes":["Bug","Epic","Task"],

"jiraProjects":["“<JIRA_PROJECT_KEY>"]

}

リクエストが成功した場合、ステータス200 (OK) が、すべてのフィールドを含む更新された構成JSONとともに返されます。更新要求により、octaneEntityTypesリストが更新されることに注意してください。

ワークスペース構成を削除します。

DELETE <JIRA_BASE_URL>/rest/octane-admin/1.0/workspaces/{workspaceConfigurationId}

成功した場合、ステータス200 (OK) を返します。

トップに戻る

その他の役立つリソース

サポートされるALM Octaneタイプを取得する

次のリクエストは、サポートされているALM Octaneエンティティタイプ名のリストを提供し、指定されたスペースとワークスペースのクエリパラメーターで提供されるudfを含みます。

GET <JIRA_BASE_URL>/rest/octane-admin/1.0/workspaces/supported-octane-types?space-config-id={spaceConfigurationId}&workspace-id={workspaceId}&udf-name={udf_name}

応答の例: ["Defect", "Feature", "User Story"]

Jiraの可能なユーザー定義フィールドを取得する

次のリクエストは、クエリパラメーターで指定されたスペースとワークスペースの「jira」という単語を含むALM Octaneユーザー定義フィールドの名前を返します。

GET <JIRA_BASE_URL>/rest/octane-admin/1.0/workspaces/possible-jira-fields?space-config-id={spaceConfigurationId}&workspace-id={workspaceId}

応答の例: ["jira_udf"]

トップに戻る

参照情報: