NFVSOL(26)000034_SOL026_Clause_10_API_structure_and_HTTP_methods

## 10.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>

Figure 10.3-1 shows the resource structure of the Redfish® API [\[2\]](#_ref_2) resources that are applicable for the physical resource fault management service interface.

![Figure 10.3-1: API resource structure of Subscription resource for physical resource fault management service interface](media/image3.png)

**Figure 10.3-1: API resource structure of Subscription resource for physical resource fault management service interface**

Table 10.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 10.3-1 shall be supported by the PIM. The HTTP methods marked as \"O\" (optional) in the \"Cat\" column may be optionally supported by the PIM. The HTTP methods marked as \"CM\" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition.

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

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

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

|                         |                                 |Method           |          |                                                          |

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

|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 1). \                        |

|                         |                                 |                 |          |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 2)                     |                 |          |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: 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 2: 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.                                                |

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

<mark>Editor's Note:    Individual Task Monitor resource may not be needed for this service interface and therefore may be deleted later on. The reason for this is that creation/modification/deletion of subscription resources may not be very time-consuming operations and therefore not require asynchronous support.</mark>

## 10.4 Sequence diagrams (informative)