Hitachi

JP1 Version 11 JP1/Automatic Operation コマンド・API リファレンス 


2.2.14 リソースのメンバー

JP1/AOが提供する機能をリソースとして分類します。レスポンスボディーで,リソースの情報をメンバーとして取得できます。返却されるリソースのメンバー名,データ型,説明およびHQL::filterとHQL::sortByに適応するかどうかを,機能ごとの表に示します。

年月日の指定方法について特に断り書きがない場合は,「表2‒20 年月日,時刻,タイムゾーンの形式」を参照して指定してください。

表2‒22 「サービステンプレート一覧の取得」で取得できるメンバー(リソース(ServiceTemplate))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

keyName

string

サービステンプレートID

○

displayName

string

サービステンプレートの表示名

○

iconURL

URLstring

サービステンプレートに設定されているアイコン画像のURL

×

vendorID

string

ベンダーID

○

version

string

サービステンプレートのバージョン

○

vendorName

string

ベンダー名

○

tags

string

サービステンプレートに付与されたタグの一覧

×

createTime

ISO8601String

サービステンプレートが作成された年月日,時刻,タイムゾーン

○

modifyTime

ISO8601String

サービステンプレートの更新年月日,時刻,タイムゾーン

○

description

string

サービステンプレートの説明

○

releaseState

enum

サービステンプレートのリリース状態

  • debug:デバッグ

  • release:リリース

○

latest

boolean

サービステンプレートが最新バージョンかどうか

  • true:最新バージョン

  • false:最新バージョンではない

○

imageURL

URLString

サービス概要の画像のURL

×

supportedScheduleType

enum csv

サービステンプレートに適用できるスケジュールの種別

  • immediate:即時実行

  • schedule:指定日時実行

  • recurrence:定期実行

○

needVUP

boolean

古いバージョンのサービステンプレートを使っているサービスがあるかどうか

  • true:ある

  • false:ない

○

componentOutdated

boolean

サービステンプレートに古いバージョンのコンポーネントが含まれているかどうか

  • true:含まれている

  • false:含まれていない

○

usedServices

integer

サービステンプレートを使用しているサービスの数

×

usedTemplates

integer

サービス部品として使用しているサービステンプレートの数

×

disableFeatures

string

サービステンプレートに対する無効な操作

○

supportedActionType※

string

タスクに対して実行できる操作

  • forciblyStop:強制停止

  • retry:リトライ

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

注※

supportedActionTypeが存在しない場合は,すべての操作が許可されます。

表2‒23 「サービス一覧の取得」で取得できるメンバー(リソース(Services))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

name

string

サービス名

○

description

string

サービスの説明

○

tags

string

タグの情報がタグ単位で「,」区切りで表示される

×

serviceTemplateName

string

サービスの元になるサービステンプレートの名称

○

createTime

ISO8601String

サービスの作成年月日,時刻,タイムゾーン

○

modifyTime

ISO8601String

サービス情報の更新年月日,時刻,タイムゾーン

○

serviceState

enum

サービスの種類

  • debug:デバッグ

  • test:テスト

  • release:リリース

  • maintenance:メンテナンス

  • disabled:無効

○

serviceGroupName

string

サービスが属するサービスグループの名称

○ ※

iconURL

URLString

サービステンプレートに設定されているアイコン画像のURL

×

vendorName

string

サービスの基になるサービステンプレートのベンダー名

○

version

string

サービスの基になるサービステンプレートのバージョン

○

lastSubmitTime

ISO8601String

ユーザーが最後にサービスを実行した年月日,時刻,タイムゾーン

○

favorite

boolean

サービスをお気に入りに登録しているかどうか

  • true:登録している

  • false:登録していない

○

failedCount

integer

サービスから生成されたタスクが失敗した回数

○

completedCount

integer

サービスから生成されたタスクが正常終了した回数

○

lastFailedTime

ISO8601String

サービスから生成されたタスクが最後に失敗した年月日,時刻,タイムゾーン

○

resetTime

ISO8601String

サービスのカウンターがリセットされた年月日,時刻,タイムゾーン

○

executedCount

integer

サービスから生成されたタスクの実行回数

○

latest

boolean

サービスが利用しているサービステンプレートが最新バージョンかどうか

  • true:最新バージョン

  • false:最新バージョンではない

○

imageURL

URLString

サービス概要の画像のURL

×

supportedScheduleType

enum csv

サービスのスケジュール種別

  • immediate:即時実行

  • schedule:指定日時実行

  • recurrence:定期実行

○

submitCount

integer

サービスを実行した回数

○

serviceTemplateID

long

サービスの基になるサービステンプレートのID

○

serviceGroupID

long

サービスグループのID

○

supportedActionType

string

タスクに対して実行できる操作

  • forciblyStop:強制停止

  • retry:リトライ

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

注※

「All Resources」を指定した場合は,「DefaultServiceGroup」を指定したとみなされます。

表2‒24 「スケジュール一覧の取得」で取得できるメンバー(リソース(Schedules))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

name

string

サービスの実行時に指定したタスク名

○

submitter

string

実行ユーザー名

○

status

enum

定期実行のスケジュールの状態

  • complete:定期実行が完了したスケジュール。実行されない状態である。

  • running:定期実行中のスケジュール。定期的に実行される状態である。

○

scheduleType

enum

スケジュールの種別

  • immediate:即時実行

  • schedule:指定日時実行

  • recurrence:定期実行

○

createTime

ISO8601String

サービスを実行して,スケジュールが作成された年月日,時刻,タイムゾーン

○

modifyTime

ISO8601String

タスク情報の更新年月日,時刻,タイムゾーン

○

description

string

タスクの説明

○

scheduledStartTime

ISO8601String

指定日時実行タスクの開始予定年月日,時刻,タイムゾーン

○ ※

recurrenceInterval

enum

定期実行周期

  • daily:毎日

  • weekly:毎週

  • monthly:毎月

○

recurrenceMinutes

integer

定期実行周期が毎日の場合に,サービスを実行する間隔(分)

  • 60

  • 120

  • 180

  • 240

  • 360

  • 480

  • 720

  • 1440

×

recurrenceDayOfWeek

string

定期実行周期が毎週の場合に,サービスを実行する曜日(1:日曜~7:土曜)

×

recurrenceDayOfMonth

string

定期実行周期が毎月の場合に,サービスを実行する日(1~31日)

×

recurrenceLastDayOfMonth

boolean

月の最終日に実行するかどうか

  • true:実行する

  • false:実行しない

○

recurrenceStartDate

string

定期実行タスクの実行開始日(yyyy-mm-dd)

○

recurrenceTime

string

定期実行タスクの実行時刻(hh:mm:ss)

○

serviceState

enum

サービスの種類

  • debug:デバッグ

  • test:テスト

  • release:リリース

  • maintenance:メンテナンス

○

serviceID

long

スケジュールの生成元となるサービスのID

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

注※

HQL::sortByは適応しません。

表2‒25 「タスク一覧の取得」で取得できるメンバー(リソース(Tasks))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

name

string

タスク名

○

status

enum

タスクの状態

  • failed:失敗

  • completed:正常終了

  • canceled:キャンセル

  • inProgressTerminating:停止中

  • inProgressWithError:異常検出

  • waitingForInput:応答待ち中

  • inProgress:実行中

  • suspended:保留中

  • waiting:待機中

  • longRunning:長期実行中

○

startTime

ISO8601String

タスクの開始年月日,時刻,タイムゾーン

○

completionTime

ISO8601String

タスクの終了年月日,時刻,タイムゾーン

○

scheduledStartTime

ISO8601String

指定日時実行タスクの開始予定年月日,時刻,タイムゾーン

○

submitter

string

実行ユーザー名

○

submitTime

ISO8601String

サービス実行によってタスクが生成された年月日,時刻,タイムゾーン

○

modifyTime

ISO8601String

タスク情報の更新年月日,時刻,タイムゾーン

○

serviceState

enum

タスクの種類

  • debug:デバッグ

  • test:テスト

  • release:リリース

  • maintenance:メンテナンス

  • buildDebug:デバッガから実行

○

scheduleType

enum

スケジュールの種別

  • immediate:即時実行

  • schedule:指定日時実行

  • recurrence:定期実行

○

description

string

タスクの説明

○

serviceName

string

タスクの生成元のサービス名

○

tags

string

タスクに付与されたタグの一覧

○

recurrenceInterval

enum

定期実行タスクの実行間隔

  • daily:毎日

  • weekly:毎週

  • monthly:毎月

○

recurrenceTime

string

定期実行タスクの実行時刻(hh:mm:ss)

○

recurrenceStartDate

ISO8601String

定期実行タスクの実行開始年月日(yyyy-mm-dd)

○

serviceGroupName

string

タスクの生成元のサービスが所属するサービスグループの名称

○

toDo

boolean

タスクにTODOが設定されているかどうか

  • true:設定されている

  • true:設定されていない

○

notes

string

タスクに記述したノート

○

stepStartTime

long

タスクに含まれるステップが最初に実行された年月日,時刻,タイムゾーン

○

serviceTemplateID

long

タスクが基づくサービステンプレートのID

○

scheduleID

long

タスクが基づくスケジュールのID

○

serviceGroupID

long

タスクの生成元のサービスが所属するサービスグループのID

○

serviceID

long

タスクの生成元となるサービスのID

○

supportedActionType

string

タスクに対して実行できる操作

  • forciblyStop:強制停止

  • retry:リトライ

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒26 「応答待ち中のタスクに応答」で取得できるメンバー(リソース(ResponseInput))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

instanceID

string

インスタンスID

×

dialogText

string

[応答入力]画面に表示される文字列

×

labelButton0

string

選択肢0

×

labelButton1

string

選択肢1

×

labelButton2

string

選択肢2

×

labelButton3

string

選択肢3

×

labelButton4

string

選択肢4

×

labelButton5

string

選択肢5

×

labelButton6

string

選択肢6

×

labelButton7

string

選択肢7

×

labelButton8

string

選択肢8

×

labelButton9

string

選択肢9

×

screenURL

string

[応答入力]画面を表示するURL

×

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

×:適応しません。

表2‒27 「ステップ一覧の取得」で取得できるメンバー(リソース(FlowSteps))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

string

インスタンスID

×

name

string

ステップ名

×

startTime

string

ステップの開始年月日と時刻(yyyy-MM-dd hh:mm:ss)

×

completionTime

string

ステップの終了年月日と時刻(yyyy-MM-dd hh:mm:ss)

×

jobStatus

enum

ステップの状態

  • noplan:未計画

  • warning:警告

  • waiting:待機中

  • holding:保留中

  • break:中断中

  • break_after:中断中(実行後)

  • running:実行中

  • waiting_for_response:応答待ち中

  • abnormal_continue:異常検出

  • complete:正常終了

  • error:失敗

  • abnormal:警告終了

  • un_exec:未実行終了

  • bypass:分岐未実行

  • terminate:停止

  • waiting_for_foreach:繰り返し実行待ち

×

comment

string

ステップのコメント

×

stepStatus

enum

ステップの状態(JP1/AO)

  • normal:正常

  • warning:警告

  • waiting:待機中

  • holding:保留中

  • break:中断中

  • break_after:中断中(実行後)

  • running:実行中

  • waiting_for_response:応答待ち中

  • abnormal_continue:異常検出

  • complete:正常終了

  • error:失敗

  • abnormal:警告終了

  • un_exec:未実行終了

  • bypass:分岐未実行

  • terminate:停止

  • waiting_for_foreach:繰り返し実行待ち

×

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

×:適応しません。

表2‒28 「タスクログの取得」で取得できるメンバー(リソース(Tasklogs))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

×

text

string

タスクログの本文

×

totalSize

long

タスクログの総ファイルサイズ(単位:バイト)

×

readSize

long

取得したタスクログのサイズ(単位:バイト)

×

lineCount

long

取得したタスクログの行数

×

offset

long

取得時に指定したオフセット(単位:バイト)

×

reverse

boolean

タスクログをオフセットから逆方向に取得したか

  • true:逆方向に取得した

  • false:正方向に取得した

×

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

×:適応しません。

表2‒29 「履歴一覧の取得」で取得できるメンバー(リソース(TaskHistory))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

name

string

タスク名

○

submitter

string

実行ユーザー名

○

serviceName

string

タスクの生成元のサービス名

○

tags

string

タグの情報(CSV形式)

×

scheduleType

enum

スケジュールの種別

  • immediate:即時実行

  • schedule:指定日時実行

  • recurrence:定期実行

○

scheduledStartTime

ISO8601String

指定日時実行タスクの開始年月日,時刻,タイムゾーン

○

startTime

ISO8601String

タスクの開始年月日,時刻,タイムゾーン

○

completionTime

ISO8601String

タスクの実行完了年月日,時刻,タイムゾーン

○

stepStartTime

ISO8601String

長期実行中のタスクの開始年月日,時刻,タイムゾーン

○

recurrenceInterval

enum

定期実行タスクの実行間隔

  • daily:毎日

  • weekly:毎週

  • monthly:毎月

○

recurrenceMinutes

integer

定期実行周期が毎日の場合に,サービスを実行する間隔(分)

  • 60

  • 120

  • 180

  • 240

  • 360

  • 480

  • 720

  • 1440

×

recurrenceDayOfWeek

string

定期実行周期が毎週の場合に,サービスを実行する曜日(1:日曜~7:土曜)

×

recurrenceDayOfMonth

string

定期実行周期が毎月の場合に,サービスを実行する日(1~31日)

×

recurrenceLastDayOfMonth

boolean

月の最終日に実行するかどうか

  • true:実行する

  • false:実行しない

○

recurrenceTime

string

定期実行タスクの実行時刻(hh:mm:ss)

○

archiveTime

ISO8601String

タスクがアーカイブされた年月日,時刻,タイムゾーン

○

taskID

long

タスクID

○

submitTime

ISO8601String

タスクが実行された年月日,時刻,タイムゾーン

○

recurrenceStartDate

ISO8601String

定期実行タスクの実行開始日(yyyy-mm-dd)

○

status

enum

タスクの状態

  • failed:失敗

  • completed:正常終了

  • canceled:キャンセル

  • inProgressTerminating:停止中

  • inProgressWithError:異常検出

  • waitingForInput:応答待ち中

  • inProgress:実行中

  • suspended:保留中

  • waiting:待機中

  • longRunning:長期実行中

○

description

string

タスクの説明

○

serviceState

enum

サービスのリリース状態

  • debug:デバッグ

  • test:テスト

  • release:リリース

  • maintenance:メンテナンス

○

toDo

boolean

タスクにTODOが設定されているかどうか

  • true:設定されている

  • false:設定されていない

○

notes

string

タスクに記述したノート

○

serviceGroupName

string

履歴の生成元のサービスが所属するサービスグループ名

○

serviceGroupID

long

履歴の生成元のサービスが所属するサービスグループID

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒30 「プロパティ定義一覧の取得」で取得できるメンバー(リソース(PropertyDefinitions))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

keyName

string

プロパティキー名

○

displayName

string

プロパティの表示名

×

defaultValue

string

プロパティのデフォルト値

○

type

enum

プロパティのデータ型

  • boolean

  • integer

  • string

  • double

  • timestamp(date)

  • password

  • list

  • file

○

visibility

enum

プロパティの可視性

  • config

  • exec

○

scope

enum

プロパティの有効範囲

  • share:サービス共有プロパティ

  • local:そのサービスだけに有効なプロパティ

○

description

string

プロパティの説明

×

mode

enum

プロパティの入出力種別

  • in:入力プロパティ

  • out:出力プロパティ

○

required

boolean

実行時にプロパティが指定必須かどうか

  • true:指定必須

  • false:省略できる

○

maxLength

integer

プロパティに入力できる文字列の最大長

○

minLength

integer

プロパティに入力できる文字列の最小長

○

minValue

string

プロパティに入力できる数値の最小値

○

maxValue

string

プロパティに入力できる数値の最大値

○

pattern

string

stringまたはpasswordのプロパティに指定できる文字列の正規表現パターン

○

valueList

string

プロパティのデータ型がlistの場合に,プロパティ値の候補を「,」区切りで表現したもの

○

propertyGroupName

string

プロパティグループ名

○

validationScript

string

プロパティのバリデーション処理をJavaScriptで記述したもの

○

readOnly

boolean

プロパティ値の変更を抑止するかどうか

  • true:抑止する

  • false:抑止しない

○

hidden

boolean

プロパティの画面表示を抑止するかどうか

  • true:抑止する

  • false:抑止しない

○

reference

boolean

プロパティ値が,ほかのプロパティ値を参照しているかどうか

  • true:参照している

  • false:参照していない

○

serviceTemplateID

long

サービステンプレートのID

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒31 「プロパティ定義およびプロパティ値一覧の取得」で取得できるメンバー(リソース(PropertyInformation))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

keyName

string

プロパティのキー名

○

displayName

string

プロパティの表示名

×

defaultValue

string

プロパティのデフォルト値

○

value

string

プロパティの現在の値

○

type

enum

プロパティのデータ型

  • boolean

  • integer

  • string

  • double

  • timestamp

  • password

  • list

  • file

○

visibility

enum

プロパティの可視性

  • config:[サービス設定]画面の入力項目として表示される

  • exec:[サービス設定]画面および[サービス実行]画面の入力項目として表示される

○

scope

enum

プロパティの有効範囲

  • share:サービス共有プロパティ

  • local:そのサービスだけに有効なプロパティ

○

description

string

プロパティの説明

×

mode

enum

プロパティの入出力種別

  • in:入力プロパティ

  • out:出力プロパティ

○

required

boolean

実行時にプロパティが指定必須かどうか

  • true:指定必須

  • false:省略できる

○

maxLength

integer

プロパティに入力できる文字列の最大長

○

minLength

integer

プロパティに入力できる文字列の最小長

○

minValue

string

プロパティに入力できる数値の最小値

○

maxValue

string

プロパティに入力できる数値の最大値

○

pattern

string

string またはpassword のプロパティに指定できる文字列の正規表現パターン

○

valueList

string

プロパティのデータ型がlist の場合に,プロパティ値の候補を「,」区切りで表現したもの

○

propertyGroupName

string

プロパティグループ名

○

validationScript

string

プロパティのバリデーション処理をJavaScriptで記述したもの

×

readOnly

boolean

プロパティ値の変更を抑止するかどうか

  • true:抑止する

  • false:抑止しない

○

hidden

boolean

プロパティの画面表示および変更を抑止するかどうか

  • true:抑止する

  • false:抑止しない

○

reference

boolean

プロパティ値が,ほかのプロパティ値を参照しているかどうか

  • true:参照している

  • false:参照していない

×

serviceTemplateID

long

リソースのサービステンプレートID

○

serviceID

long

リソースのサービスID

○

taskID

long

リソースのタスクID

○

scheduleID

long

リソースのスケジュールID

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒32 「プロパティ値一覧の取得」で取得できるメンバー(リソース(PropertyValues))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

type

enum

プロパティのデータ型

  • boolean

  • integer

  • string

  • double

  • timestamp(date)

  • password

  • list

  • file

○

keyName

string

プロパティキー名

○

value

string

プロパティの値

○

serviceID

long

リソースのサービスID

○

scheduleID

long

リソースのスケジュールID

○

taskID

long

リソースのタスクID

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒33 「プロパティグループ一覧の取得」で取得できるメンバー(リソース(PropertyGroup))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

keyName

string

プロパティグループのID

○

displayName

string

プロパティグループの表示名

×

description

string

プロパティグループの説明

×

ordinal

integer

プロパティグループの表示順序

×

validationScript

string

プロパティグループ内のプロパティ間のバリデーション処理をJavaScriptで記述したもの

×

display

enum

プロパティグループを表示するかどうか

  • submit:[サービス実行]画面に表示

  • config:[サービス編集]画面に表示

  • taskDetail:[タスク詳細]画面に表示

×

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒34 「サービスグループ一覧の取得」で取得できるメンバー(リソース(ServiceGroup))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

objectID

string

リソース「Resource Group」のインスタンスID

○

name

string

サービスグループの名称

○

description

string

サービスグループの説明

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒35 「タググループ一覧の取得」で取得できるメンバー(リソース(TagGroup))

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

name

string

タググループの名称

○

tag

string

所属するタグのリスト(CSV形式)

×

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒36 「タグ一覧の取得」で取得できるメンバー(リソース(Tag))(detailクエリパラメータを指定しない場合)

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

name

string

タグの名称

○

tagGroupID

long

タグが所属するタググループのID

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒37 「タグ一覧の取得」で取得できるメンバー(リソース(Tag))(detailクエリパラメータを指定する場合)

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

data

Object

リソースの一覧

×

instanceID

long

インスタンスID

○

name

string

タグの名称

○

usedTemplates

integer

タグが使われているリリースサービステンプレートおよび開発サービステンプレートの数

○

usedServices

integer

タグが使われているサービスの数

○

usedTasks

integer

タグが使われているタスクの数

○

usedHistories

integer

タグが使われている履歴の数

○

usedPlugins

integer

タグが使われているリリース部品の数

○

usedDevelopPlugins

integer

タグが使われている開発部品の数

○

usedDevelopTemplates

integer

タグが使われている開発サービステンプレートの数

○

tagGroupID

long

タグが所属するタググループのID

○

pagination

Object

リソースをページ単位で分割する場合の情報

×

page

integer

リクエストで指定したpage(ページ番号)

×

pageSize

integer

リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数)

×

numPages

integer

page(ページ番号)の総数

×

totalCount

integer

返却されるリソースの総数

×

count

integer

クエリパラメータの条件に合致したデータの個数(0~n)

×

(凡例)

○:適応します。 ×:適応しません。

表2‒38 情報管理機能のリソース(UserInfo)のメンバー

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

userName

string

ユーザー名

×

accessPermission

string

ユーザーに与えられたアクセス権限

×

fullName

string

ユーザーのフルネーム

×

description

string

ユーザーの説明

×

email

string

ユーザーのメールアドレス

×

resourceGroup

ResourceGroup

ユーザーに与えられた,リソース「Resource Group」別のアクセス権限

×

(凡例)

×:適応しません。

表2‒39 情報管理機能のリソース(ResourceGroup)のメンバー

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

instanceID

string

インスタンスID

×

name

string

リソース「Resource Group」の名称

×

description

string

リソース「Resource Group」の説明

×

accessPermission

string[]

ユーザーに与えられた,リソース「Resource Group」別のアクセス権限

×

(凡例)

×:適応しません。

表2‒40 情報管理機能のリソース(VersionInfo)のメンバー

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

productName

string

製品名(JP1/Automatic Operation)

×

productVersion

string

製品のバージョン

×

apiVersionl

string

APIのバージョン

×

(凡例)

×:適応しません。

表2‒41 情報管理機能のリソース(Information)のメンバー

メンバー名

データ型

説明

HQL::filterまたはHQL::sortByの適応

message

string

メッセージ

×

messageID

string

メッセージID

×

(凡例)

×:適応しません。