Merge branch 'NFVSOL(25)000459_SOL026_Clause_11_Sequence_Diagrams' into 'main'

**Figure 6.4.4-1: Flow of Computer System modification**

The modification of an individual Computer System resource, as illustrated in Figure 6.4.4-1, consists of the following steps.

The modification of an individual Computer System resource, as illustrated in Figure 6.4.4-1, consists of the following steps.

**Precondition:** The individual Computer System resource has been previously created.

## 11.4 Sequence diagrams (informative)

<mark>Editor's Note:    This sub-clause will add sequence diagrams of operations supported over this service interface.</mark>

### 11.4.1 Introduction

Flows related to task monitoring, subscription management and notifications are described in Annex A of the present document.

### 11.4.2 Creation of a Logging Job

This clause describes a sequence for creating an individual Logging Job.

![Figure 11.4.2-1: Flow of Logging Job creation](media/image34.png)

**Figure 11.4.2-1: Flow of Logging Job creation**

The creation of a Logging Job object, as illustrated in Figure 11.4.2-1, consists of the following steps.

**Precondition:** None.

1. The API consumer sends a POST request to the LogService resource URI including a valid representation of the individual Logging Job resource in the message content body.

1. If the PIM supports asynchronous operations and creation of the Logging Job resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.

1. The PIM creates an individual Logging Job resource.

1. The PIM returns a \"201 Created\" response to the API consumer and includes in the message content body a representation of the created Logging Job resource. The response also contains the URI of the newly created resource in the Location header.

**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual Logging Job resource has been created.

**Error handling:** In case of failure, appropriate error information is provided in the response.

### 11.4.3 Querying information about Logging Job resources

This clause describes the sequences for querying information about both Logging Job resource collection and individual Logging Job resource.

![Figure 11.4.3-1: Flow of querying information about Logging Job resources](media/image35.png)

**Figure 11.4.3-1: Flow of querying information about Logging Job resources**

The querying of information about one or more Logging Job resources, as illustrated in Figure 11.4.3-1, consists of the following steps.

**Precondition:** One or more individual Logging Job resources have been created.

1. If the API consumer intends to get information about multiple Logging Job resources, it sends a GET request to the LogService resource URI.

1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of a Logging Job collection, containing information about all the individual Logging Job resources that have been created.

1. If the API consumer intends to get information about an individual Logging Job resource, it sends a GET request to the Individual Logging Job resource identified by its name in the URI.

1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the individual Logging Job resource.

**Postcondition:** None.

**Error handling:** In case of failure, appropriate error information is provided in the response.

### 11.4.4 Modifying a Logging Job resource

This clause describes a sequence for modifying an individual Logging Job resource.

![Figure 11.4.4-1: Flow of Logging Job modification](media/image36.png)

**Figure 11.4.4-1: Flow of Logging Job modification**

The modification of an individual Logging Job resource, as illustrated in Figure 11.4.4-1, consists of the following steps.

**Precondition:** The individual Logging Job resource has been previously created.

1. The API consumer sends a PATCH request to the Individual Logging Job resource, including data structure in the message content body representing the modifiable properties to be modified in the individual Logging Job resource.

1. If the PIM supports asynchronous operations and modification of the Logging Job resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.

1. The PIM modifies the Individual Logging Job resource.

1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the modified Logging Job resource. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.

**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the Individual Logging Job resource has been modified.

**Error handling:** In case of failure, appropriate error information is provided in the response.

### 11.4.5 Replacing a Logging Job resource

This clause describes a sequence for replacing an individual Logging Job resource.

![Figure 11.4.5-1: Flow of Logging Job replacement](media/image37.png)

**Figure 11.4.5-1: Flow of Logging Job replacement**

The replacement of an individual Logging Job resource, as illustrated in Figure 11.4.5-1, consists of the following steps.

**Precondition:** The individual Logging Job resource has been previously created.

1. The API consumer sends a PUT request to the Individual Logging Job resource including a valid representation of the individual Logging Job resource to be replaced in the message content body.

1. If the PIM supports asynchronous operations and replacement of the Logging Job resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.

1. The PIM replaces the Individual Logging Job resource.

1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the replaced Logging Job resource. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.

**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the Individual Logging Job resource has been replaced.

**Error handling:** In case of failure, appropriate error information is provided in the response.

### 11.4.6 Deleting a Logging Job resource

This clause describes a sequence for deleting an Individual Logging Job resource.

![Figure 11.4.6-1: Flow of Logging Job deletion](media/image38.png)

**Figure 11.4.6-1: Flow of Logging Job deletion**

The deletion of an individual Logging Job resource, as illustrated in Figure 11.4.6-1, consists of the following steps.

**Precondition:** The individual Logging Job resource has been previously created.

1. The API consumer sends a DELETE request to the Individual Logging Job resource.

1. If the PIM supports asynchronous operations and deletion of the Logging Job resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.

1. The PIM deletes the individual Logging Job resource.

1. The PIM returns a \"204 No Content\" response to the API consumer indicating that the resource has been successfully deleted. Alternatively, the PIM can also return a \"200 OK\" response to the API consumer including a representation of the deleted Logging Job resource in the message content body.

**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the Individual Logging Job resource has been deleted.

**Error handling:** In case of failure, appropriate error information is provided in the response.

### 11.4.7 Querying information about logs

This clause describes the sequences for querying information about multiple log entries and individual log entry.

![Figure 11.4.7-1: Flow of querying information about Logs](media/image39.png)

**Figure 11.4.7-1: Flow of querying information about Logs**

The querying of information about one or more Log entries, as illustrated in Figure 11.4.7-1, consists of the following steps.

**Precondition:** One or more Log Entries have been generated by the PIM.

1. If the API consumer intends to get information about multiple Log entries, it sends a GET request to the Logs collection URI.

1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of a Logs collection, containing information about all the individual log entries that have been collected.

1. If the API consumer intends to get information about an individual log entry, it sends a GET request to the Individual Log resource identified by its name in the URI.

1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the individual Log entry.

**Postcondition:** None.

**Error handling:** In case of failure, appropriate error information is provided in the response.

### 11.4.8 Receiving diagnostics related logs

This clause describes the sequence for receiving diagnostics related logs collected by the PIM.

![Figure 11.4.8-1: Flow of receiving diagnostics related logs](media/image40.png)

**Figure 11.4.8-1: Flow of receiving diagnostics related logs**

The procedure of receiving receiving logs related to diagnostics consists of the following steps as illustrated in figure 11.4.8-1.

**Precondition:** The API consumer has previously created a Logging Job associated with a target physical resource. 

1. The API consumer sends a POST request to {Base URI of target physical resource}/Actions/LogService.CollectDiagnosticData and includes the necessary action parameters in the message body.

1. The PIM collects the logs to generate the diagnostics report.

1. Upon successful completion of the action, the PIM returns a \"204 No Content\" response to the API consumer indicating that the action has been performed successfully. The Location header in the response contains a URI of a resource, which has the type LogEntry and contains the collected diagnostic data.

1. The API consumer sends a GET request to the LogEntry resource URI provided by the PIM in the Location Header of the \"204 No Content\" response.

1. The PIM responds with \"200 OK\" and valid representation of LogEntry resource containing the logs. 

**Postcondition:** None.

**Error handling:**  In case of failure, appropriate error information is provided in the response.

### 11.4.9 Receiving notification about availability of diagnostics related logs

This clause describes the sequence for receiving notification about availability of diagnostics related logs.

![Figure 11.4.9-1: Flow of receiving notification about availability of diagnostics related logs](media/image41.png)

**Figure 11.4.9-1: Flow of receiving notification about availability of diagnostics related logs**

The procedure consists of the following steps as illustrated in figure 11.4.9-1.

**Precondition:** The API consumer has previously subscribed to receive notifications about messages in the LogService message registry. The API consumer has previously invoked collection of diagnostics related logs.

1. An event is triggered once the collection of diagnostic data is completed by the PIM, resulting in generation of a new DiagnosticDataCollected message in the LogService message registry.

1. The PIM sends the DiagnosticDataCollected message as an event notification to the consumer indicating availability of diagnostics related logs.

**Postcondition:** None.

**Error handling:** None.

## 11.5 Resources