This API adds patch information to a server.
Request parameters
Parameter name | Item | Item description |
|---|---|---|
Version | Description | The version ID of the L-Platform API |
Type | string | |
Value | Fixed. Specify "2.0". | |
Locale | Description | The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639. |
Type | string | |
Value | Select one of the following: | |
Action | Description | The name of the L-Platform API to be executed. |
Type | string | |
Value | Fixed. Specify "AddPatch". | |
userId | Description | The user ID of the user that executes the L-Platform API. |
Type | string | |
Value | No more than 31 characters | |
orgId | Description | The tenant name of the user that executes the L-Platform API. |
Type | string | |
Value | No more than 32 characters | |
lplatformId | Description | L-Platform ID |
Type | string | |
Value | No more than 32 characters | |
lserverId | Description | Server ID. |
Type | string | |
Value | No more than 32 characters | |
softwareId | Description | Software ID |
Type | string | |
Value | No more than 32 characters | |
patchId | Description | Patch ID. |
Type | string | |
Value | No more than 32 characters. Any desired value can be specified. Specify the patch number and so on. If an existing ID is specified, the patch information for the specified ID will be updated. However, linefeed codes and the following characters cannot be specified: < > & ' " | |
[componentName] | Description | The name of the component to which the patch is to be applied. This element can be omitted if the patch specification does not include the concept of components. |
Type | string | |
Value | No more than 85 characters. However, linefeed codes and the following characters cannot be specified: < > & ' " | |
[description] | Description | Description of the patch. |
Type | string | |
Value | No more than 85 characters. However, linefeed codes and the following characters cannot be specified: < > & ' " |
Response
<Status code>
The API returns "200 OK" if it terminates normally.
<XML>
<?xml version="1.0" encoding="UTF-8"?> <AddPatchResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>[Message]</responseMessage> <responseStatus>[Status]</responseStatus> </AddPatchResponse>
<Elements>
Element name | Item | Item description |
|---|---|---|
AddPatchResponse | Description | Element holding the response information |
Type | None | |
Number of occurrences | 1 | |
responseMessage | Description | Message. This element indicates whether the request has been processed correctly. Refer to "Chapter 15 Messages Starting with PAPI" in the "Messages" for message details. |
Type | string | |
Number of occurrences | 1 | |
responseStatus | Description | Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned. |
Type | string | |
Number of occurrences | 1 |
Sample response
<?xml version="1.0" encoding="UTF-8"?> <AddPatchResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>PAPI00000 Processing was completed.</responseMessage> <responseStatus>SUCCESS</responseStatus> </AddPatchResponse>
