Hitachi

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


9.2.14 リソースのメンバー

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

なお,JP1/AO 10-50では,サポート対象外のメンバーが返却される場合があります。サポート対象はこの表に記載されているメンバーだけとなります。

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

表9‒18 「サービス一覧の取得」で取得できるメンバー(リソース(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:デバッグ

  • release:リリース

○ 

serviceGroupName

string

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

○ 

pagination

Object

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

× 

page

integer

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

× 

pageSize

integer

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

× 

numPages

integer

page(ページ番号)の総数

× 

totalCount

integer

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

× 

count

integer

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

× 

(凡例)

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

表9‒19 「スケジュール一覧の取得」で取得できるメンバー(リソース(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:毎月

○ 

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:デバッグ

  • release:リリース

○ 

serviceID

long

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

○ 

pagination

Object

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

× 

page

integer

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

× 

pageSize

integer

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

× 

numPages

integer

page(ページ番号)の総数

× 

totalCount

integer

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

× 

count

integer

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

× 

(凡例)

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

注※

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

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

メンバー名

データ型

説明

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

data

Object

リソースの一覧

× 

instanceID

long

インスタンスID

○ 

name

string

タスク名

○ 

status

enum

タスクの状態

  • failed:失敗

  • completed:正常終了

  • canceled:キャンセル

  • inProgressTerminating:停止中

  • inProgressWithError:異常検出

  • waitingForInput:応答待ち中

  • inProgress:実行中

  • suspended:保留中

  • waiting:待機中

○ 

startTime

ISO8601String

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

○ 

completionTime

ISO8601String

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

○ 

scheduledStartTime

ISO8601String

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

○ 

submitter

string

実行ユーザー名

○ 

submitTime

ISO8601String

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

○ 

modifyTime

ISO8601String

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

○ 

serviceState

enum

タスクの種類

  • debug:デバッグ

  • release:リリース

○ 

scheduleID

long

タスクに設定されているスケジュールの定義のID

○ 

serviceID

long

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

○ 

pagination

Object

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

× 

page

integer

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

× 

pageSize

integer

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

× 

numPages

integer

page(ページ番号)の総数

× 

totalCount

integer

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

× 

count

integer

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

× 

(凡例)

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

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

メンバー名

データ型

説明

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

data

Object

リソースの一覧

× 

name

string

ステップ名

× 

startTime

string

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

× 

completionTime

string

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

× 

jobStatus

enum

ステップの状態(タスク処理エンジン)

  • noplan:未計画

  • unexec:未実行終了

  • bypass:計画未実行

  • shutdown:閉塞

  • termwait:先行終了待ち

  • execwait:実行待ち

  • queuing:キューイング

  • holding:保留中

  • running:実行中

  • abnormal:異常検出終了

  • kill:強制終了

  • fail:起動失敗

  • job_unknown:終了状態不明(UNKNOWNをJOB_UNKNOWNに変更)

  • warning:警告検出終了

  • normal:正常終了

  • normalfalse:正常終了−偽

  • monitorintrpt:監視中断

× 

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)

× 

(凡例)

×:適応しません。

表9‒22 「タスクログの取得」で取得できるメンバー(リソース(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)

× 

(凡例)

×:適応しません。

表9‒23 「プロパティ定義一覧の取得」で取得できるメンバー(リソース(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

○ 

visibility

enum

プロパティの可視性

  • config

  • exec

○ 

scope

enum

プロパティの有効範囲

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

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

○ 

description

string

プロパティの説明

× 

mode

enum

プロパティの入出力種別

  • in:入力プロパティ

  • out:出力プロパティ

○ 

required

boolean

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

  • true:指定必須

  • false:省略できる

○ 

maxLength

int

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

○ 

minLength

int

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

○ 

minValue

string

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

○ 

maxValue

string

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

○ 

pattern

string

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

○ 

valueList

string

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

○ 

propertyGroupName

string

プロパティグループ名

○ 

pagination

Object

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

× 

page

integer

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

× 

pageSize

integer

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

× 

numPages

integer

page(ページ番号)の総数

× 

totalCount

integer

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

× 

count

integer

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

× 

(凡例)

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

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

メンバー名

データ型

説明

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

data

Object

リソースの一覧

× 

instanceID

long

インスタンスID

○ 

type

enum

プロパティのデータ型

  • boolean

  • integer

  • string

  • double

  • timestamp(date)

  • password

  • list

○ 

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)

× 

(凡例)

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

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

メンバー名

データ型

説明

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

userName

string

ユーザー名

× 

accessPermission

string

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

× 

resourceGroup

ResourceGroup

ユーザーに与えられえた,リソースグループ別のアクセス権限

× 

(凡例)

×:適応しません。

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

メンバー名

データ型

説明

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

productName

string

製品名(JP1/Automatic Operation)

× 

productVersion

string

製品のバージョン

× 

apiVersionl

string

APIのバージョン

× 

(凡例)

×:適応しません。