POST /stgupdates/repository/import/SELF?jobid=<job_id>

Use the POST method to import a management-server update to the updates repository. Only the user that created the job has the permission to import the update using the job ID that was returned from that method.

Attention: This REST API is deprecated in XClarity Administrator v2.1.0 or later.. Use POST /files/managementServer/updates?action=import&jobid=<job_id> instead.

This REST API returns the 307 error code indicating that the URL changed. The Location attribute in the response header returns the correct URL to use.

Before you can import an update, you must first create an import job using the POST /managementServer/updates?action=import method.

You can monitor the status of the import request using the GET /tasks/<job_list> method.

Authentication

Authentication with user name and password is required.

Request URL

POST https://<management_server_IP>/stgupdates/repository/import/SELF?jobid=<job_id>

Query parameters

Parameters Required / Optional Description
jobid=<job_id> Required The ID of the job that was created to import images using the last POST /managementServer/updates?action=import method
The following example imports a management-server update using job ID 1.
POST https://192.0.2.0/stgupdates/repository/import/SELF?jobid=1

Request body

Use the "multipart/form-data" media type to import the update package. Use the attributes in the following table as the multipart name in the body. For more information about the multipart/form-data media type, see Returning Values from Forms: multipart/form-data webpage.

Attributes Required / Optional Type Description
fileSize Optional String The size of the update file to be imported (in bytes).
uploadedfile Required Object Information about the image being imported.
  fileName Required String Name of the update file.

Request example

HTTP Header
Content-Type: multipart/form-data; boundary=AaB03x
Request body
--AaB03x
   Content-Disposition: form-data; name="uploadedfiles[]"; 
                        filename="lnvgy_sw_lxca_serverrepo2-1.1.1_anyos_noarch.chg"
   Content-Type: application/octet-stream

--AaB03x
   Content-Disposition: form-data; name="uploadedfiles[]"; 
                       filename="lnvgy_sw_lxca_serverrepo2-1.1.1_anyos_noarch.tgz"
   Content-Type: application/x-compressed

--AaB03x
   Content-Disposition: form-data; name="uploadedfiles[]"; 
                        filename="lnvgy_sw_lxca_serverrepo2-1.1.1_anyos_noarch.txt"
   Content-Type: text/plain

--AaB03x
   Content-Disposition: form-data; name="uploadedfiles[]"; 
                        filename="lnvgy_sw_lxca_serverrepo2-1.1.1_anyos_noarch.xml"
   Content-Type: text/xml

--AaB03x--

Response codes

Code Description
307 Temporary Redirect. The URL changed for this REST API. The response header returns the correct URL in the Location attribute.

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

When the request is successful (response code of 201), a message body similar to the following is returned:

Note: If the request is successful, you can use the GET /tasks/<job_list> resource to monitor the progress of the deployment.
{
   "result": "success",
   "messages":[]
}

When the request is not successful (such as a response code of 409), a message body similar to the following is returned:

{
   "result": "failed",
   "errorMsg": {
      "result": "major",
      "messages": [{
         "explanation": "The operation failed for an unknown reason.  The network connection
                         might have gone down",
         "id": "FQXHMUP2502L",
         "recovery": {
            "text": "Check the network connection.  Retry the operation."
         },
         "text": "The repository operation failed."
      }]
   }
}