9.2.14 リソースのメンバー
JP1/AOが提供する機能をリソースとして分類します。レスポンスボディーで,リソースの情報をメンバーとして取得できます。返却されるリソースのメンバー名,データ型,説明およびHQL::filterとHQL::sortByに適応するかどうかを,機能ごとの表に示します。
なお,JP1/AO 10-50では,サポート対象外のメンバーが返却される場合があります。サポート対象はこの表に記載されているメンバーだけとなります。
年月日の指定方法について特に断り書きがない場合は,「表9‒16 年月日,時刻,タイムゾーンの形式」を参照して指定してください。
メンバー名 |
データ型 |
説明 |
HQL::filterまたはHQL::sortByの適応 |
---|---|---|---|
data |
Object |
リソースの一覧 |
× |
instanceID |
long |
インスタンスID |
○ |
name |
string |
サービス名 |
○ |
description |
string |
サービスの説明 |
○ |
tags |
string |
カテゴリの情報がカテゴリ単位で「,」区切りで表示される |
× |
serviceTemplateName |
string |
サービスの元になるサービステンプレートの名称 |
○ |
createTime |
ISO8601String |
サービスの追加年月日,時刻,タイムゾーン |
○ |
modifyTime |
ISO8601String |
サービス情報の更新年月日,時刻,タイムゾーン |
○ |
serviceState |
enum |
サービスの種類
|
○ |
serviceGroupName |
string |
サービスが属するリソースグループの名称 |
○ |
pagination |
Object |
リソースをページ単位で分割する場合の情報 |
× |
page |
integer |
リクエストで指定したpage(ページ番号) |
× |
pageSize |
integer |
リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数) |
× |
numPages |
integer |
page(ページ番号)の総数 |
× |
totalCount |
integer |
返却されるリソースの総数 |
× |
count |
integer |
クエリパラメータの条件に合致したデータの個数(0〜n) |
× |
- (凡例)
-
○:適応します。 ×:適応しません。
メンバー名 |
データ型 |
説明 |
HQL::filterまたはHQL::sortByの適応 |
---|---|---|---|
data |
Object |
リソースの一覧 |
× |
instanceID |
long |
インスタンスID |
○ |
name |
string |
サービスの実行時に指定したタスク名 |
○ |
submitter |
string |
実行ユーザー名 |
○ |
status |
enum |
定期実行のスケジュールの状態
|
○ |
scheduleType |
enum |
スケジュールの種別
|
○ |
createTime |
ISO8601String |
サービスを実行して,スケジュールが作成された年月日,時刻,タイムゾーン |
○ |
modifyTime |
ISO8601String |
タスク情報の更新年月日,時刻,タイムゾーン |
○ |
description |
string |
タスクの説明 |
○ |
scheduledStartTime |
ISO8601String |
指定日時実行タスクの開始予定年月日,時刻,タイムゾーン |
○ ※ |
recurrenceInterval |
enum |
定期実行周期
|
○ |
recurrenceDayOfWeek |
string |
定期実行周期が毎週の場合に,サービスを実行する曜日(1:日曜〜7:土曜) |
× |
recurrenceDayOfMonth |
string |
定期実行周期が毎月の場合に,サービスを実行する日(1〜31日) |
× |
recurrenceLastDayOfMonth |
boolean |
月の最終日に実行するかどうか
|
○ |
recurrenceStartDate |
string |
定期実行タスクの実行開始日(yyyy-mm-dd) |
○ |
recurrenceTime |
string |
定期実行タスクの実行時刻(hh:mm:ss) |
○ |
serviceState |
enum |
サービスの種類
|
○ |
serviceID |
long |
スケジュールの生成元となるサービスのID |
○ |
pagination |
Object |
リソースをページ単位で分割する場合の情報 |
× |
page |
integer |
リクエストで指定したpage(ページ番号) |
× |
pageSize |
integer |
リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数) |
× |
numPages |
integer |
page(ページ番号)の総数 |
× |
totalCount |
integer |
返却されるリソースの総数 |
× |
count |
integer |
クエリパラメータの条件に合致したデータの個数(0〜n) |
× |
- (凡例)
-
○:適応します。 ×:適応しません。
- 注※
-
HQL::sortByは適応しません。
メンバー名 |
データ型 |
説明 |
HQL::filterまたはHQL::sortByの適応 |
---|---|---|---|
data |
Object |
リソースの一覧 |
× |
instanceID |
long |
インスタンスID |
○ |
name |
string |
タスク名 |
○ |
status |
enum |
タスクの状態
|
○ |
startTime |
ISO8601String |
タスクの開始年月日,時刻,タイムゾーン |
○ |
completionTime |
ISO8601String |
タスクの終了年月日,時刻,タイムゾーン |
○ |
scheduledStartTime |
ISO8601String |
指定日時実行タスクの開始予定年月日,時刻,タイムゾーン |
○ |
submitter |
string |
実行ユーザー名 |
○ |
submitTime |
ISO8601String |
サービス実行によってタスクが生成された年月日,時刻,タイムゾーン |
○ |
modifyTime |
ISO8601String |
タスク情報の更新年月日,時刻,タイムゾーン |
○ |
serviceState |
enum |
タスクの種類
|
○ |
scheduleID |
long |
タスクに設定されているスケジュールの定義のID |
○ |
serviceID |
long |
タスクの生成元となるサービスのID |
○ |
pagination |
Object |
リソースをページ単位で分割する場合の情報 |
× |
page |
integer |
リクエストで指定したpage(ページ番号) |
× |
pageSize |
integer |
リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数) |
× |
numPages |
integer |
page(ページ番号)の総数 |
× |
totalCount |
integer |
返却されるリソースの総数 |
× |
count |
integer |
クエリパラメータの条件に合致したデータの個数(0〜n) |
× |
- (凡例)
-
○:適応します。 ×:適応しません。
メンバー名 |
データ型 |
説明 |
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 |
ステップの状態(タスク処理エンジン)
|
× |
comment |
string |
ステップのコメント |
× |
stepStatus |
enum |
ステップの状態(JP1/AO)
|
× |
pagination |
Object |
リソースをページ単位で分割する場合の情報 |
× |
page |
integer |
リクエストで指定したpage(ページ番号) |
× |
pageSize |
integer |
リクエストで指定したpageSize(ページに含まれるオブジェクトの最大数) |
× |
numPages |
integer |
page(ページ番号)の総数 |
× |
totalCount |
integer |
返却されるリソースの総数 |
× |
count |
integer |
クエリパラメータの条件に合致したデータの個数(0〜n) |
× |
- (凡例)
-
×:適応しません。
メンバー名 |
データ型 |
説明 |
HQL::filterまたはHQL::sortByの適応 |
---|---|---|---|
data |
Object |
リソースの一覧 |
× |
instanceID |
long |
インスタンスID |
× |
text |
string |
タスクログの本文 |
× |
totalSize |
long |
タスクログの総ファイルサイズ(単位:バイト) |
× |
readSize |
long |
取得したタスクログのサイズ(単位:バイト) |
× |
lineCount |
long |
取得したタスクログの行数 |
× |
offset |
long |
取得時に指定したオフセット(単位:バイト) |
× |
reverse |
boolean |
タスクログをオフセットから逆方向に取得したか
|
× |
pagination |
Object |
リソースをページ単位で分割する場合の情報 |
× |
page |
integer |
リクエストで指定したpage(ページ番号) |
× |
pageSize |
integer |
リクエストで指定したpageSize((ページに含まれるオブジェクトの最大数)) |
× |
numPages |
integer |
page(ページ番号)の総数 |
× |
totalCount |
integer |
返却されるリソースの総数 |
× |
count |
integer |
クエリパラメータの条件に合致したデータの個数(0〜n) |
× |
- (凡例)
-
×:適応しません。
メンバー名 |
データ型 |
説明 |
HQL::filterまたはHQL::sortByの適応 |
---|---|---|---|
data |
Object |
リソースの一覧 |
× |
instanceID |
long |
インスタンスID |
○ |
keyName |
string |
プロパティキー名 |
○ |
displayName |
string |
プロパティの表示名 |
× |
defaultValue |
string |
プロパティのデフォルト値 |
○ |
type |
enum |
プロパティのデータ型
|
○ |
visibility |
enum |
プロパティの可視性
|
○ |
scope |
enum |
プロパティの有効範囲
|
○ |
description |
string |
プロパティの説明 |
× |
mode |
enum |
プロパティの入出力種別
|
○ |
required |
boolean |
実行時にプロパティが指定必須かどうか
|
○ |
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) |
× |
- (凡例)
-
○:適応します。 ×:適応しません。
メンバー名 |
データ型 |
説明 |
HQL::filterまたはHQL::sortByの適応 |
---|---|---|---|
data |
Object |
リソースの一覧 |
× |
instanceID |
long |
インスタンスID |
○ |
type |
enum |
プロパティのデータ型
|
○ |
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) |
× |
- (凡例)
-
○:適応します。 ×:適応しません。
メンバー名 |
データ型 |
説明 |
HQL::filterまたはHQL::sortByの適応 |
---|---|---|---|
userName |
string |
ユーザー名 |
× |
accessPermission |
string |
ユーザーに与えられえたアクセス権限 |
× |
resourceGroup |
ResourceGroup |
ユーザーに与えられえた,リソースグループ別のアクセス権限 |
× |
- (凡例)
-
×:適応しません。
メンバー名 |
データ型 |
説明 |
HQL::filterまたはHQL::sortByの適応 |
---|---|---|---|
productName |
string |
製品名(JP1/Automatic Operation) |
× |
productVersion |
string |
製品のバージョン |
× |
apiVersionl |
string |
APIのバージョン |
× |
- (凡例)
-
×:適応しません。