2.5.16　サービスの詳細説明のURLを取得

機能

指定したサービスの詳細説明を表示するURLを取得します。

実行権限

Adminロール，Developロール，Modifyロール，Submitロール

APIのバージョン

リクエスト形式

GET http://host:port/Automation/version/objects/Services/id/actions/detailhelp

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	メッセージ	説明
200	OK	成功しました。
401	Unauthorized	ログイン権限がありません。
404	Not found	サービスの取得権限がありません。または，サービスがありません。
412	Precondition failed	サーバが利用できません。
500	Server-side error	サーバ処理エラーが発生しました。

レスポンスのスキーマ

リクエストに対するレスポンスボディーの構造を次に示します。

{
   "name" : "export",
   "href" : "Link-to-the-detail-help",
   "method" : "POST",
   "parameters" : []
 }

使用例

instanceID=2004のサービスの詳細説明を表示するURLを取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/Services/2004/actions/detailhelp HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Thu, 30 Jul 2015 05:08:56 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 8e609f55fd6858f17ddc4527cd6f890b79153e2_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS
Access-Control-Allow-Credentials: true
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: application/json

レスポンスボディー:

{
  "name" : "detailhelp",
  "href" : "http://10.196.184.182:22015/Automation/services/custom/000000000000560/remoteCommandExe.html",
  "method" : "GET",
  "parameters" : [ ]
}

ページの先頭へ

2.5.16 サービスの詳細説明のURLを取得

2.5.16　サービスの詳細説明のURLを取得