9.2.14 Members of resources

Functions provided by JP1/AO are categorized into resources. In the response body, you can acquire resource information as members. The tables below describe (for each functionality) the member names, data types, and descriptions of the returned resources, and whether HQL::filter or HQL::sortBy is applied to the members.

Note that, in JP1/AO 10-50, although unsupported members might be returned, only the members described in the tables below are supported.

For details about how to specify the year, month, and date, see Table 9‒16: Format of year-month-date, time, and time zone, unless otherwise described.

Table 9‒18: Members that can be acquired by Acquisition of a list of services (Resource (Services))
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
data	Object	List of resources	N
instanceID	long	Instance ID	Y
name	string	Service name	Y
description	string	Description of the service	Y
tags	string	Category information is displayed, with categories separated by commas (`,`)	N
serviceTemplateName	string	Name of the service template that is used as the base of a service	Y
createTime	ISO8601String	Year, month, date, time, and time zone at which the service was added	Y
modifyTime	ISO8601String	Year, month, date, time, and time zone at which the service information was updated	Y
serviceState	enum	Service type debug: Debug release: Release	Y
serviceGroupName	string	Name of the resource group the service belongs to	Y
pagination	Object	Information used when a resource is divided into pages	N
page	integer	The page specified in the request (page number)	N
pageSize	integer	The page size specified in the request (maximum number of objects included in a page)	N
numPages	integer	Total number of pages (page number)	N
totalCount	integer	Total number of returned resources	N
count	integer	The number of data items that match the conditions specified by query parameters (0 to n)	N

Legend:: Y: Applied. N: Not applied.

Table 9‒19: Members that can be aquired by Acquisition of a list of schedules (Resource (Schedules))
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
data	Object	List of resources	N
instanceID	long	Instance ID	Y
name	string	Task name specified when the service is executed	Y
submitter	string	Execution user name	Y
status	enum	Status of periodically executed schedules complete: Indicates that periodic execution has been completed for the schedule. Periodic execution will not be performed. running: Indicates that periodic execution is running for the schedule. Periodic execution will be performed.	Y
scheduleType	enum	Schedule type immediate: Executed immediately schedule: Executed at the specified date and time. recurrence: Executed periodically.	Y
createTime	ISO8601String	Year, month, date, time, and time zone at which the schedule was created by service execution	Y
modifyTime	ISO8601String	Year, month, date, time, and time zone at which task information was updated	Y
description	string	Description of the task	Y
scheduledStartTime	ISO8601String	Year, month, date, time, and time zone at which scheduled task is planed to start	Y^#
recurrenceInterval	enum	Periodic execution cycle daily: Daily weekly: Weekly monthly: Monthly	Y
recurrenceDayOfWeek	string	Day of week the service is to be executed when the periodic execution cycle is set to Weekly (1: Sun to 7: Sat)	N
recurrenceDayOfMonth	string	Day of month the service is to be executed when the periodic execution cycle is set to Monthly (1st to 31st)	N
recurrenceLastDayOfMonth	boolean	Whether to execute on the final day of month true: Execute false: Not execute	Y
recurrenceStartDate	string	Date the periodic execution task starts execution (yyyy-mm-dd)	Y
recurrenceTime	string	Time the periodic execution task is executed (hh:mm:ss)	Y
serviceState	enum	Service type debug: Debug release: Release	Y
serviceID	long	ID of the service that is the generation source of the schedule	Y
pagination	Object	Information when the resource is divided into pages	N
page	integer	The page number specified in the request (page number)	N
pageSize	integer	The page size specified in the request (maximum number of objects that can be included in a page)	N
numPages	integer	Total number of pages (page number)	N
totalCount	integer	Total number of returned resources	N
count	integer	Number of data items that match the conditions specified by query parameters (0 to n)	N

Legend:: Y: Applied. N: Not applied.

#: HQL::sortBy is not applied.

Table 9‒20: Members that can be acquired by Acquisition of a list of tasks (Resource (Tasks))
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
data	Object	List of resources	N
instanceID	long	Instance ID	Y
name	string	Task name	Y
status	enum	Status of the task failed: Failed completed: Completed canceled: Canceled inProgressTerminating: Being stopped inProgressWithError: Abnormality detected waitingForInput: Waiting for response inProgress: In progress suspended: Suspended waiting: Waiting	Y
startTime	ISO8601String	Start year, month, date, time, and time zone of the task	Y
endTime	ISO8601String	End year, month, date, time, and time zone of the task	Y
scheduledStartTime	ISO8601String	Year, month, date, time, and time zone at which the scheduled task is planned to be started	Y
submitter	string	Execution user name	Y
submitTime	ISO8601String	Year, month, date, time, and time zone at which the task was created by service execution	Y
modifyTime	ISO8601String	Year, month, date, time, and time zone at which the task information was updated	Y
serviceState	enum	Task type debug: Debug release: Release	Y
scheduleID	long	Definition ID of the schedule that is set for the task	Y
serviceID	long	ID of the service that is the generation source of the task	Y
pagination	Object	Information when the resource is divided into pages	N
page	integer	The age specified in the request (page number)	N
pageSize	integer	The page size specified in the request (maximum number of objects that can be included in a page)	N
numPages	integer	Total number of pages (page number)	N
totalCount	integer	Total number of returned resources	N
count	integer	Number of data items that match the conditions specified by query parameters (0 to n)	N

Legend:: Y: Applied. N: Not applied.

Table 9‒21: Members that can be acquired by Acquisition of a list of steps (Resource (FlowSteps))
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
data	Object	List of resources	N
name	string	Step name	N
startTime	string	Start year, month, date, and time of the step (yyyy-MM-dd hh:mm:ss)	N
endTime	string	End year, month, date, and time of the step (yyyy-MM-dd hh:mm:ss)	N
jobStatus	enum	Status of the step (task processing engine) noplan: Not scheduled unexec: Not executed but ended bypass: Bypassed and not executed shutdown: Blocked termwait: Waiting for the previous step to end execwait: Waiting to execute queuing: Queuing holding: Being held running: Running abnormal: Ended abnormally kill: Killed fail: Failed to start job_unknown: Unknown end status (UNKNOWN has been changed to JOB_UNKNOWN.) warning: Ended with warning normal: Ended normally normalfalse: Normal end - False monitorintrpt: Interrupted monitoring	N
comment	string	Comment for the step	N
stepStatus	enum	Status of the step (JP1/AO) normal: Normal warning: Warning waiting: Waiting holding: Being held break: Interrupted break_after: Interrupted (After Execution) running: Running waiting_for_response: Waiting for response abnormal_continue: Abnormality detected complete: Completed error: Failed abnormal: Ended with a warning un_exec: Not executed but ended bypass: Bypassed and not executed terminate: Terminated waiting_for_foreach: Waiting to repeat	N
pagination	Object	Information when a resource is divided into pages	N
page	integer	The page specified in the request (page number)	N
pageSize	integer	The page size specified in the request (maximum number of objects that can be included in a page)	N
numPages	integer	Total number of pages (page number)	N
totalCount	integer	Total number of returned resources	N
count	integer	Number of data items that match the conditions specified by query parameters (0 to n)	N

Legend:: N: Not applied.

Table 9‒22: Members that can be acquired by Acquisition of task logs (Resource (Tasklogs))
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
data	Object	List of resources	N
instanceID	long	Instance ID	N
text	string	Body of the task log	N
totalSize	long	Total file size of the task logs (unit: byte)	N
readSize	long	Size of the acquired task log (unit: byte)	N
lineCount	long	Number of lines in the acquired task log	N
offset	long	Offset specified when the task log is acquired (unit: byte)	N
reverse	boolean	Whether the task log was acquired in the opposite direction from the offset true: The task log was acquired in the opposite direction from the offset. false: The task log was acquired in the normal direction from the offset.	N
pagination	Object	Information when a resource is divided into pages	N
page	integer	page specified in the request (page number)	N
pageSize	integer	pageSize specified in the request (maximum number of objects that can be included in a page)	N
numPages	integer	Total number of pages (page number)	N
totalCount	integer	Total number of returned resources	N
count	integer	Number of data items that match the conditions specified by query parameters (0 to n)	N

Legend:: N: Not applied.

Table 9‒23: Members that can be acquired by Acquisition of a list of property definitions (Resource (PropertyDefinitions))
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
data	Object	List of resources	N
instanceID	long	Instance ID	Y
keyName	string	Property key name	Y
displayName	string	Display name of the property	N
defaultValue	string	Default value of the property	Y
type	enum	Data type of the property boolean integer string double timestamp(date) password list	Y
visibility	enum	Visibility of the property config exec	Y
scope	enum	Valid range of the property share: Service share property local: Property that is valid only for the service	Y
description	string	Description of the property	N
mode	enum	Input/output type of the property in: Input property out: Output property	Y
required	boolean	Whether to specify a property at execution true: Specification required false: Can be omitted	Y
maxLength	int	Maximum length of the character string that can be input as a property	Y
minLength	int	Minimum length of the character string that can be input as a property	Y
minValue	string	Minimum value that can be input as a property	Y
maxValue	string	Maximum value that can be input as a property	Y
pattern	string	Regular expression pattern of a character string that can be specified for a string or password property	Y
valueList	string	Candidate property values that are separated by commas (`,`) when the data type of the property is list	Y
propertyGroupName	string	Property group name	Y
pagination	Object	Information when the resource is divided into pages	N
page	integer	page specified in the request (page number)	N
pageSize	integer	pageSize specified in the request (maximum number of objects that can be included in a page)	N
numPages	integer	Total number of pages (page number)	N
totalCount	integer	Total number of returned resources	N
count	integer	Number of data items that match the conditions specified by query parameters (0 to n)	N

Legend:: Y: Applied. N: Not applied.

Table 9‒24: Members that can be acquired by Acquisition of a list of property values (Resource (PropertyValues))
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
data	Object	List of resources	N
instanceID	long	Instance ID	Y
type	enum	Data type of the property boolean integer string double timestamp(date) password list	Y
keyName	string	Property key name	Y
value	string	Property value	Y
serviceID	long	Service ID of the resource	Y
scheduleID	long	Schedule ID of the resource	Y
taskID	long	Task ID of the resource	Y
pagination	Object	Information when the resource is divided into pages	N
page	integer	page specified in the request (page number)	N
pageSize	integer	pageSize specified in the request (maximum number of objects that can be included in a page)	N
numPages	integer	Total number of pages (page number)	N
totalCount	integer	Total number of returned resources	N
count	integer	Number of data items that match the conditions specified by query parameters (0 to n)	N

Legend:: Y: Applied. N: Not applied.

Table 9‒25: Members of a resource for information management functionality (UserInfo)
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
userName	string	User name	N
accessPermission	string	Access permissions granted to the user	N
resourceGroup	ResourceGroup	Access permissions granted to the user for each resource group	N

Legend:: N: Not applied.

Table 9‒26: Members of a resource for information management functionality (VersionInfo)
Member name	Data type	Description	Whether HQL::filter or HQL::sortBy is applied
productName	string	Product name (JP1/Automatic Operation)	N
productVersion	string	Product version	N
apiVersionl	string	API version	N

Legend:: N: Not applied.

To Page Top