Skip to main content

Collection Capabilities Annotation

  1. The Collection Capabilities annotation allows a client to discover which collections in the service support compositions, how the POST request for the collection is formatted, as well as what properties are required.

  2. "@Redfish.Collection Capabilities" is available under the following resources:

    • Systems Collection - "redfish/v1/Systems"

    • Resource Zone Instance - "redfish/v1/CompositionService/ResourceZones/1"

  3. The following attributes are available in @Redfish.CollectionCapabilities annotation.

Table 1. Collection Capabilities Annotation Property List
NameTypeRead-onlyDescription

Capabilities

Array

True

  1. This property shall contain an array of objects that describe the capabilities of this resource collection.

  2. Refer to Capabilities Annotation Property List

MaxMembers

Integer

True

The maximum number of members allowed in this collection.

Table 2. Capabilities Annotation Property List
NameTypeRead-onlyDescription

UseCase

String

True

This property represents the use case in which a client may issue a POST request to the collection.

EnumDescription

ComputerSystemComposition

This capability describes a client creating a new ComputerSystem instance from a set of disaggregated hardware.

Links(M)

Object

True

The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.

NameTypeRead-onlyDescription

RelatedItem

Array

True

The ID(s) of the resources associated with this capability.

TargetCollection(M)

Array

True

Reference to the collection that this capabilities structure is describing.

CapabilitiesObject

Object

True

Reference to the resource the client may GET to understand how to form a POST request for a given collection.