CLI Reference Guide

<utilization> </utilization>
<utilization> </utilization>
</UtilizationList>
Values for the detail parameter
The detail parameter has the following values:
l Required: Retrieves all the non-null and non-optional fields of an artifact. This includes fields
with Java primitive types byte, short, int, long, float, double, boolean and char.
l Basic: In addition to the Required fields of an artifact, retrieves nullable primitive types (Java
wrapper classes) and Date, Time, TimeStamp and BigDecimal.
l Standard: In addition to the Basic fields of an artifact, retrieves all non-CSA type fields.
l Template: Retrieves all fields of an artifact except for artifact collection references and artifacts
that are part of a containment relationship. This is same as the Full option without artifact
collection references. This option is mainly used for performance reasons, because you could
end up retrieving a large amount of data. For example, you can use this option if you do not want
to load the base service instances when retrieving its service blueprint. Service instances are
artifacts and are associated through a collection reference with its blueprint.
l Full: All fields except for artifacts that are part of a containment relationship. Retrieval of the
internal artifacts is controlled by the scope parameter. Using this option has a performance
impact (See Template option) because this option also returns artifact collection references.
Note: Some API calls do not support all possible values for this parameter.
Values for the scope parameter
The scope parameter has the following values:
l Base: Retrieves the root entity of the artifact including all required attributes.
l Baseplusone: In addition to Base, retrieves all first level child artifacts.
l Subtree: In addition to Base, retrieves all its descendants. Using this option could have a
performance impact because the information being retrieved can be very large.
l View: Retrieves only those attributes defined for the view specified in the detail parameter.
HP Cloud Service Automation (4.00)Page 139 of 141
APIReference
Contents