9.4.1　サービス一覧の取得

機能

JP1/AOに登録されているサービスの一覧を取得します。

実行権限

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

APIのバージョン

リクエスト形式

GET http://host:port/Automation/version/objects/Services

APIの実行ユーザーが権限を持つ，すべてのサービスを対象として一覧を取得します。

ステータスコード

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

ステータスコード	メッセージ	説明
200	OK	成功しました。
400	Bad Request	クエリパラメータが不正です。
401	Unauthorized	ログイン権限がありません。
412	Precondition failed	サーバが利用できません。
500	Server-side error	サーバ処理エラーが発生しました。

レスポンスのスキーマ

レスポンスボディーには，リクエストで指定したクエリパラメータの条件に合致したデータが返却されます。レスポンスボディーのスキーマを次に示します。

{
  "data" : [ {"サービス機能のリソース（Services）のメンバー" : 値 ... }, ... ],
  "count" : クエリパラメータの条件に合致したデータの個数（0〜n）
}

使用例

すべてのサービスを対象として，サービス一覧を取得する場合の使用例を示します。

リクエストヘッダー:
GET /Automation/v1/objects/Services HTTP/1.1
Host:10.196.184.238:22015
Accept:application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 11:36:42 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO ed355b6e59f72c675dca1498e951439e8aa0d8_V0300
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

レスポンスボディー:
{
  "data" : [ {
    "instanceID" : 2015,
    "name" : "testService1",
    "description" : "description",
    "tags" : "",
    "serviceTemplateName" : "testService",
    "createTime" : "2014-07-14T01:16:11.000-0700",
    "modifyTime" : "2014-07-14T04:36:30.000-0700",
    "serviceState" : "release",
    "serviceGroupName" : "Default Service Group",
    "serviceGroupID" : 3
  }, {
    "instanceID" : 2020,
    "name" : "testService2",
    "description" : "description",
    "tags" : "",
    "serviceTemplateName" : "testService",
    "createTime" : "2014-07-14T01:16:39.000-0700",
    "modifyTime" : "2014-07-14T04:36:33.000-0700",
    "serviceState" : "release",
    "serviceGroupName" : "Default Service Group",
    "serviceTemplateID" : 2008,
    "serviceGroupID" : 3
  } ],
  "count" : 2
}

関連トピック

9.2.14　リソースのメンバー

ページの先頭へ

9.4.1 サービス一覧の取得

9.4.1　サービス一覧の取得