2.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 function-based table below shows the name, data type, description, and whether HQL::filter and HQL::sortBy is applied, for each returned resource member.
For details on how to specify a year, month, and date, see Table 2‒20: Format of year-month-date, time, and time zone, unless otherwise described.
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 |
Service template ID |
Y |
displayName |
string |
Display name of the service template |
Y |
iconURL |
URLString |
URL of the icon image that is set for the service template |
N |
vendorID |
string |
Vendor ID |
Y |
version |
string |
Version of the service template |
Y |
vendorName |
string |
Vendor name |
Y |
tags |
string |
List of tags added to the service template |
N |
serviceSpecificationVersion |
string |
Version of the service template definition schema |
N |
createTime |
ISO8601String |
Year, month, date, time, and time zone at which the service template was created |
Y |
modifyTime |
ISO8601String |
Year, month, date, time, and time zone at which the service template was updated |
Y |
description |
string |
Description of the service template |
Y |
releaseState |
enum |
Release state of the service template
|
Y |
latest |
boolean |
Whether the service template is the latest version
|
Y |
imageURL |
URLString |
URL of the service overview image |
N |
supportedScheduleType |
enum csv |
Schedule type that can be applied to the service template
|
Y |
needVUP |
boolean |
Whether there is a service using a service template of an older version
|
Y |
componentOutdated |
boolean |
Whether the service template contains a component of an older version
|
Y |
usedServices |
integer |
Number of services using the service template |
N |
usedTemplates |
integer |
Number of service templates using the service template as a service component |
N |
disableFeatures |
string |
Invalid operation for the service template |
Y |
supportedActionType# |
string |
Operations that can be performed for the task:
|
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.
- #
-
If supportedActionType is not specified, all operations are permitted.
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 |
Tag information separated by commas (,) into tag units is displayed. |
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 created |
Y |
modifyTime |
ISO8601String |
Year, month, date, time, and time zone at which the service information was updated |
Y |
serviceState |
enum |
Service type
|
Y |
serviceGroupName |
string |
Name of the service group that the service belongs to |
Y# |
iconURL |
URLString |
URL of the icon image that is set for the service template |
N |
vendorName |
string |
Vendor name for the service template that is used as the base of the service |
Y |
version |
string |
Version of the service template that is used as the base of the service |
Y |
lastSubmitTime |
ISO8601String |
Year, month, date, time, and time zone at which the service was last executed by the user |
Y |
favorite |
boolean |
Whether the service is registered as a favorite
|
Y |
failedCount |
integer |
Number of times tasks that were generated from the service failed |
Y |
completedCount |
integer |
Number of times tasks that were generated from the service ended normally |
Y |
lastFailedTime |
ISO8601String |
Year, month, date, time, and time zone at which a task that was generated from the service last failed |
Y |
resetTime |
ISO8601String |
Year, month, date, time, and time zone at which the counter for the service was last reset. |
Y |
executedCount |
integer |
Number of times tasks that were generated from the service were executed |
Y |
latest |
boolean |
Whether the service template used by the service is the latest version
|
Y |
imageURL |
URLString |
URL of the service overview image |
N |
supportedScheduleType |
enum csv |
Schedule type of the service
|
Y |
submitCount |
integer |
Number of times the service was executed |
Y |
venderID |
string |
Vender ID |
N |
serviceTemplateID |
long |
ID of the service template that is used as the base of the service |
Y |
serviceGroupID |
long |
Service group ID |
Y |
supportedActionType |
string |
Operations that can be performed for the task:
|
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.
- #
-
When All Resources is specified, the service is treated as if DefaultServiceGroup is specified.
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 the schedule of the periodic execution task
|
Y |
scheduleType |
enum |
Schedule type
|
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
|
Y |
recurrenceMinutes |
integer |
Interval (minutes) of the service is to be executed when the periodic execution cycle is set to daily:
|
N |
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
|
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
|
Y |
serviceID |
long |
ID of the service that is the generation source of the schedule |
Y |
supportedActionType |
string |
Operations that can be performed for the task:
|
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.
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
|
Y |
startTime |
ISO8601String |
Start year, month, date, time, and time zone of the task |
Y |
completionTime |
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
|
Y |
scheduleType |
enum |
Schedule type
|
Y |
description |
string |
Description of the task |
Y |
serviceName |
string |
Name of the service that is the generation source of the task |
Y |
tags |
string |
List of tags that are added to the task |
Y |
recurrenceInterval |
enum |
Execution interval of the periodic execution task
|
Y |
recurrenceTime |
string |
Execution time of the periodic execution task (hh:mm:ss) |
Y |
recurrenceStartDate |
ISO8601String |
Start year, month, and date of the periodic execution task (yyyy-mm-dd) |
Y |
serviceGroupName |
string |
Name of the service group that the generation source service of the task belongs to |
Y |
toDo |
boolean |
Whether TODO is set for the task
|
Y |
notes |
string |
Notes added to the task |
Y |
stepStartTime |
long |
Year, month, date, time, and time zone at which a step included in the task was executed for the first time |
Y |
serviceTemplateID |
long |
ID of the service template that is used as the base of the task |
Y |
scheduleID |
long |
ID of the schedule that is used as the base of the task |
Y |
serviceGroupID |
long |
ID of the service group that the generation source service of the task belongs to |
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.
Member name |
Data type |
Description |
Whether HQL::filter or HQL::sortBy is applied |
---|---|---|---|
instanceID |
string |
Instance ID |
N |
dialogText |
string |
Character string displayed in the Add Response window |
N |
labelButton0 |
string |
Option 0 |
N |
labelButton1 |
string |
Option 1 |
N |
labelButton2 |
string |
Option 2 |
N |
labelButton3 |
string |
Option 3 |
N |
labelButton4 |
string |
Option 4 |
N |
labelButton5 |
string |
Option 5 |
N |
labelButton6 |
string |
Option 6 |
N |
labelButton7 |
string |
Option 7 |
N |
labelButton8 |
string |
Option 8 |
N |
labelButton9 |
string |
Option 9 |
N |
screenURL |
string |
URL for displaying the Add Response window |
N |
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:
-
N: Not applied.
Member name |
Data type |
Description |
Whether HQL::filter or HQL::sortBy is applied |
---|---|---|---|
data |
Object |
List of resources |
N |
instanceID |
string |
Instance ID |
N |
name |
string |
Step name |
N |
startTime |
string |
Start year, month, date, and time of the step (yyyy-MM-dd hh:mm:ss) |
N |
completionTime |
string |
End year, month, date, and time of the step (yyyy-MM-dd hh:mm:ss) |
N |
jobStatus |
enum |
Status of the step
|
N |
comment |
string |
Comment for the step |
N |
stepStatus |
enum |
Status of the step (JP1/AO)
|
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.
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
|
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.
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 |
submitter |
string |
Execution user name |
Y |
serviceName |
string |
Name of the generation source service of the task |
Y |
tags |
string |
Tag information (CSV format) |
N |
scheduleType |
enum |
Schedule type
|
Y |
scheduledStartTime |
ISO8601String |
Start year, month, date, time, and time zone of the task that is executed at the specified date and time |
Y |
startTime |
ISO8601String |
Start year, month, date, time, and time zone of the task |
Y |
completionTime |
ISO8601String |
End year, month, date, time, and time zone of the task |
Y |
stepStartTime |
ISO8601String |
Start year, month, date, time, and time zone of the long-running task |
Y |
recurrenceInterval |
enum |
Execution interval of the periodic execution task
|
Y |
recurrenceMinutes |
integer |
Interval (minutes) of the service is to be executed when the periodic execution cycle is set to daily:
|
N |
recurrenceDayOfWeek |
string |
(When the periodic execution interval is weekly) Day of the week when the service is executed (1: Sunday to 7: Saturday) |
N |
recurrenceDayOfMonth |
string |
(When the periodic execution interval is monthly) Day when the service is executed (1 to 31) |
N |
recurrenceLastDayOfMonth |
boolean |
Whether to execute the service on the last day of each month
|
Y |
recurrenceTime |
string |
Execution time of the periodic execution task (hh:mm:ss) |
Y |
archiveTime |
ISO8601String |
Year, month, date, time, and time zone at which the task was archived |
Y |
taskID |
long |
Task ID |
Y |
submitTime |
ISO8601String |
Year, month, date, time, and time zone at which the task was executed |
Y |
recurrenceStartDate |
ISO8601String |
Start date of the periodic execution task (yyyy-mm-dd) |
Y |
status |
enum |
Status of the task
|
Y |
description |
string |
Description of the task |
Y |
serviceState |
enum |
Release status of the service
|
Y |
toDo |
boolean |
Whether TODO is set for the task
|
Y |
notes |
string |
Notes added to the task |
Y |
serviceGroupName |
string |
Name of the service group that the generation source service of the history record belongs to |
Y |
serviceGroupID |
long |
ID of the service group that the generation source service of the history record belongs to |
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.
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
|
Y |
visibility |
enum |
Visibility of the property
|
Y |
scope |
enum |
Valid range of the property
|
Y |
description |
string |
Description of the property |
N |
mode |
enum |
Input/output type of the property
|
Y |
required |
boolean |
Whether the property must be specified to execute the service
|
Y |
maxLength |
integer |
Maximum length of a character string that can be input in the property |
Y |
minLength |
integer |
Minimum length of a character string that can be input in the property |
Y |
minValue |
string |
Minimum value that can be input in the property |
Y |
maxValue |
string |
Maximum value that can be input in the property |
Y |
pattern |
string |
Regular expression pattern of a character string that can be specified for the property string or password |
Y |
valueList |
string |
Candidate property values that are separated by commas (,) when the data source of the property is Static and this presentation is Selection |
Y |
propertyGroupName |
string |
Property group name |
Y |
validationScript |
string |
Property validation processing JavaScript |
Y |
readOnly |
boolean |
Whether to suppress a change of the property value
|
Y |
hidden |
boolean |
Whether to suppress a display of the property
|
Y |
reference |
boolean |
Whether the property value references another property value
|
Y |
serviceTemplateID |
long |
Service template ID |
Y |
arrayOf |
boolean |
Parameters used internally |
N |
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.
- #
-
Acquired in the following cases.
-
If the data type for the property of the service template created in any version earlier than JP1/AO 12-01 is list, or if the data type for the property of the service created from the service template is list.
-
If List type property which has not been clicked once OK button in Edit Input Property for Service dialog box, after copying the service template created in any version earlier than JP1/AO 12-01.
-
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 |
value |
string |
Current value of the property |
Y |
type |
enum |
Data type of the property
|
Y |
visibility |
enum |
Visibility of the property
|
Y |
scope |
enum |
Valid range of the property
|
Y |
description |
string |
Description of the property |
N |
mode |
enum |
Input/output type of the property
|
Y |
required |
boolean |
Whether the property must be specified to execute the service
|
Y |
maxLength |
integer |
Maximum length of a character string that can be input in the property |
Y |
minLength |
integer |
Minimum length of a character string that can be input in the property |
Y |
minValue |
string |
Minimum value that can be input in the property |
Y |
maxValue |
string |
Maximum value that can be input in the property |
Y |
pattern |
string |
Regular expression pattern of a character string that can be specified for the property string or password |
Y |
valueList |
string |
Candidate property values that are separated by commas (,) when the data source of the property is Static and this presentation is Selection |
Y |
propertyGroupName |
string |
Property group name |
Y |
validationScript |
string |
Parameters used internally |
N |
readOnly |
boolean |
Whether to suppress a change of the property value
|
Y |
hidden |
boolean |
Whether to suppress a display of the property
|
Y |
reference |
boolean |
Whether the property value refers another property value
|
N |
serviceTemplateID |
long |
Service template ID for the resource |
Y |
serviceID |
long |
Service ID for the resource |
Y |
presentation |
string |
Format in which a property is displayed
|
N |
arrayOf |
boolean |
Parameters used internally |
N |
restriction |
string |
Constraint information specified in properties
|
N |
taskID |
long |
Task ID for the resource |
Y |
scheduleID |
long |
Schedule ID for 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.
- #
-
Acquired in the following cases.
-
If the data type for the property of the service template created in any version earlier than JP1/AO 12-01 is list, or if the data type for the property of the service created from the service template is list.
-
If List type property which has not been clicked once OK button in Edit Input Property for Service dialog box, after copying the service template created in any version earlier than JP1/AO 12-01.
-
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
|
Y |
keyName |
string |
Property key name |
Y |
value |
string |
Property value |
Y |
arrayOf |
boolean |
Parameters used internally |
N |
restriction |
string |
Constraint information specified in properties
|
N |
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.
Member name |
Data type |
Description |
Whether HQL::filter or HQL::sortBy is applied |
---|---|---|---|
keyName |
string |
Property group ID |
Y |
displayName |
string |
Display name of the property group |
N |
description |
string |
Description of the property group |
N |
ordinal |
integer |
Display sequence number of the property group |
N |
validationScript |
string |
Parameters used internally |
N |
display |
enum |
Whether to display the property group
|
N |
renderScript |
string |
Parameters used internally |
N |
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 |
Member name |
Data type |
Description |
Whether HQL::filter or HQL::sortBy is applied |
---|---|---|---|
data |
Object |
List of resources |
N |
instanceID |
long |
Instance ID |
Y |
objectID |
string |
Instance ID for the Resource Group resource |
Y |
name |
string |
Name of the service group |
Y |
description |
string |
Description of the service group |
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.
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 |
Name of the tag group |
Y |
tag |
string |
List of tags that belong to the tag group (CSV format) |
N |
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.
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 |
Tag name |
Y |
tagGroupID |
long |
ID of the tag group that the tag belongs to |
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.
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 |
Tag name |
Y |
usedTemplates |
integer |
Number of release and development service templates using the tag |
Y |
usedServices |
integer |
Number of services using the tag |
Y |
usedTasks |
integer |
Number of tasks using the tag |
Y |
usedHistories |
integer |
Number of history records using the tag |
Y |
usedPlugins |
integer |
Number of release plug-ins using the tag |
Y |
usedDevelopPlugins |
integer |
Number of development plug-ins using the tag |
Y |
usedDevelopTemplates |
integer |
Number of development service templates using the tag |
Y |
tagGroupID |
long |
ID of the tag group that the tag belongs to |
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.
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 |
fullName |
string |
Full name of the user |
N |
description |
string |
Description of the user |
N |
|
string |
Email address for the user |
N |
resourceGroup |
ResourceGroup |
Access permissions granted to the user for each Resource Group resource |
N |
- Legend:
-
N: Not applied.
Member name |
Data type |
Description |
Whether HQL::filter or HQL::sortBy is applied |
---|---|---|---|
instanceID |
string |
Instance ID |
N |
name |
string |
Name of the Resource Group resource |
N |
description |
string |
Description of the Resource Group resource |
N |
accessPermission |
string[] |
Access permissions granted to the user for each Resource Group resource |
N |
- Legend:
-
N: Not applied.
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.
Member name |
Data type |
Description |
Whether HQL::filter or HQL::sortBy is applied |
---|---|---|---|
message |
string |
Message |
N |
messageID |
string |
Message ID |
N |
- Legend:
-
N: Not applied.