Update VNF package information
Use this API to update the information of a VNF package resource. The PATCH method updates the information of a VNF package.
The following elements of the request, example, and responses are described:
Request
Aspect | Value |
---|---|
Endpoint URL | /api/etsi/vnfpkgm/v2/vnf_packages/<package-id> |
HTTP Method | PATCH |
Request headers
Header | Value |
---|---|
Content-Type | application/json |
Version | 2.1.0 |
Request data
The request data is a json object that contains the fields that are outlined in Table 3:
Parameter | Type | Description | Required |
---|---|---|---|
operationalState | string | To set the operational state of an onboarded VNF package from one state to another.
Possible Values:
|
No |
userDefinedData | object | Key-Value map of user-defined values to either add new entries or update existing values. | No |
Request data example
{
"operationalState": "DISABLED",
"userDefinedData": {
"key1": "value1",
"key2": "value2"
}
}
Response codes
HTTP status code | Description |
---|---|
200 | When the VNF Packages Info was successfully updated. |
400 | The response body contains details about the error. |
404 | When No Package for supplied ID is found. |
409 | This code occurs when attempting to Disable a VNF package resource of which the operational state is not "ENABLED" or Enable a VNF package resource of which the operational state is not "DISABLED". |
500 | Internal Server Error |
4xx/5xx | In addition to the response codes defined in this table, any common error response codes. |
Response headers
Header | Description |
---|---|
Content-Type | application/json |
Response data
The response body contains the VNF package information modifications details.
{
"operationalState": "DISABLED",
"userDefinedData": {
"key1": "value1",
"key2": "value2"
}
}