NFVSOL(26)000061_SOL026_Clause_7_API_structure_and_HTTP_methods

## 7.3 Resource structure and HTTP methods

## 7.3 Resource structure and HTTP methods

<mark>Editor's Note:    This sub-clause will add Resource structure and HTTP methods for the service interface.</mark>

The inventory of physical resources within an NFVI-PoP managed by the PIM are represented by different collections of Redfish® objects. These Redfish® collections, along with their resource URIs, that provide the corresponding information about physical resources in an NFVI-PoP are specified in clause 5.3.4 of the present document.

For the sake of simplicity and to avoid repitition, the present clause denotes each Redfish® collection as \"InventoryObjectCollection\" and each individual object of a collection as \"IndividualInventoryObject\".

Figures 7.3-1, 7.3-2 and 7.3-3 show resource structures of the Redfish® API [\[2\]](#_ref_2) resources that are applicable for the physical resource inventory management service interface.

![Figure 7.3-1: API resource structure of "InventoryObjectCollection" resource for the physical resource inventory management service interface](media/image42.png)

**Figure 7.3-1: API resource structure of "InventoryObjectCollection" resource for the physical resource inventory management service interface**

![Figure 7.3-2: API resource structure of Subscription resource for physical resource inventory management service interface](media/image3.png)

**Figure 7.3-2: API resource structure of Subscription resource for physical resource inventory management service interface**

![Figure 7.3-3: API resource structure of the Individual Task Monitor resource for physical resource inventory management service interface](media/image4.png)

**Figure 7.3-3: API resource structure of the Individual Task Monitor resource for physical resource inventory management service interface**

Table 7.3-1 lists the API resources, and the applicable HTTP methods for each resource endpoint.

The HTTP methods marked as \"M\" (mandatory) in the \"Cat\" column of table 7.3-1 shall be supported by the PIM. The HTTP methods marked as \"CM\" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition. The HTTP methods marked as \"O\" (optional) in the \"Cat\" column may be optionally supported by the PIM.

**Table 7.3-1: API Resources and HTTP methods of physical resource inventory management service interface**<a name="table_7.3-1"></a>

+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+

|Resource name            |Resource URI                     |HTTP\            |Cat       |Meaning                                                   |

|                         |                                 |Method           |          |                                                          |

+:========================+:================================+:================+:=========+:=========================================================+

|InventoryObjectCollection| /redfish/v1 \                   |GET              |M         |Get a collection of inventory objects of same kind.       |

|                         | /{InventoryObjectCollection} \  |                 |          |                                                          |

|                         | (see note 1)                    |                 |          |                                                          |

+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+

|IndividualInventoryObject| /redfish/v1 \                   |GET              |M         |Get an individual object from a collection of \           |

|                         | /{InventoryObjectCollection} \  |                 |          |inventory objects of same kind.                           |

|                         | /{IndividualInventoryObject} \  +-----------------+----------+----------------------------------------------------------+

|                         | (see note 2)                    |PATCH            |M         |Modify an individual object from an inventory collection. |

|                         |                                 +-----------------+----------+----------------------------------------------------------+

|                         |                                 |PUT              |O         |Replace an individual object from an inventory collection.|

+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+

|Subscriptions            |/redfish/v1/EventService\        |POST             |M         |Create a new \"Individual Subscription\" resource.        |

|                         |/Subscriptions                   +-----------------+----------+----------------------------------------------------------+

|                         |                                 |GET              |M         |Get the collection of all available subscriptions.        |

+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+

|Individual Subscription  |/redfish/v1/EventService\        |GET              |M         |Get information about the                                 |

|                         |/Subscriptions/{SubscriptionId}  |                 |          |\"Individual Subscription\" resource.                     |

|                         |                                 +-----------------+----------+----------------------------------------------------------+

|                         |                                 |PATCH            |M         |Modify an \"Individual Subscription\" resource.           |

|                         |                                 +-----------------+----------+----------------------------------------------------------+

|                         |                                 |PUT              |O         |Replace an \"Individual Subscription\" resource.          |

|                         |                                 +-----------------+----------+----------------------------------------------------------+

|                         |                                 |DELETE           |M         |Delete an \"Individual Subscription\" resource.           |

+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+

|Notification endpoint    |{NotificationTargetURI}          |POST             |M         |Send a notification related to                            |

|                         |                                 |                 |          |a subscribed event (see note 3). \                        |

|                         |                                 |                 |          |This resource is used to send information about faults \  |

|                         |                                 |                 |          |to the consumer in the form of an alert type event.       |

+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+

|Individual Task Monitor  |/redfish/v1/TaskService\         |GET              |CM        |Enable API consumer to monitor the                        |

|                         |/TaskMonitors/{TaskMonitorId}    |                 |          |progress of an asynchronous operation                     |

|                         |(see note 4)                     |                 |          |as well as receive the result of the requested            |

|                         |                                 |                 |          |operation once the corresponding task has been completed. |

|                         |                                 |                 |          |This resource endpoint shall be supported                 |

|                         |                                 |                 |          |if the API producer supports asynchronous operations.     |

+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+

|NOTE 1: See clause 5.3.4 for the resource URIs of each inventory object collection.                                                                |

|NOTE 2: The resource URI of an indivdual object can be acquired from the corresponding object collection in its \"Members\" property.              |

|NOTE 3: Notification endpoint resource and the corresponding NotficiationTargetURI                                                                 |

|is used by the API producer to send notifications to the API consumer.                                                                             |

|This resource is not produced by the API producer. \                                                                                               |

|NOTE 4: The URI of the task monitor is provided in the Location header                                                                             |

|of the HTTP response to the API consumer when the API producer returns a \"202 Accepted\" response.                                                |

+---------------------------------------------------------------------------------------------------------------------------------------------------+

## 7.4 Sequence diagrams (informative)

## 7.4 Sequence diagrams (informative)