Software upgrade



[tags: DMA]

Resource Root

https://localhost:8443/api/rest//installed-software

Summary


Resources Methods
https://localhost:8443/api/rest//installed-software

GET  Retrieves details of current software version, package details and upgrade history.

https://localhost:8443/api/rest//installed-software/upgrade-package

POST  It will upload the software upgrade image.

https://localhost:8443/api/rest//installed-software/upgrade-package/url

POST  It will upload the file specified by the software upgrade ufl.

https://localhost:8443/api/rest//installed-software/upgrade-history

GET  Retrieves details of history of installed software versions.

https://localhost:8443/api/rest//installed-software/upgrade-package/apply

POST  It will upgrade the software image.

https://localhost:8443/api/rest//installed-software/rollback

POST  It will rollback the software image to previous version of build.

https://localhost:8443/api/rest//installed-software/softclient-roster/rollback

POST  It will rollback the softclient / roster software image to previous version of build.

Resources


https://localhost:8443/api/rest//installed-software


Methods

GET


Retrieves details of current software version, package details and upgrade
history.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-software-upgrade-details+xml
application/vnd.plcm.plcm-software-upgrade-details+json
Software upgrade current information successfully retrieved
304 Software upgrade information has not changed since the last get request.

Note: The API client must provide the
"plcm-software-upgrade-details" representation's
ETag value in the "If-None-Match" HTTP header to ensure the retrieval.
This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical
request in the "If-None-Match" header, then the HTTP response will
contain the
search results in the message body.

The "plcm-software-upgrade-details" ETag can be accessed from the
initial search result's HTTP
response header. This also assumes no other client made changes to
Software upgrade details on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
User roles required: administrator

https://localhost:8443/api/rest//installed-software/upgrade-package


Methods

POST

It will upload the software upgrade image.
[tags: DMA_INTERNAL]

Request

Representations

multipart/form-data

Response

Status Representation Description
201 software upgrade image uploaded successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid software upgrade image format
429 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Too many requests. Maximum number of concurrent requests in progress. Try back later.

https://localhost:8443/api/rest//installed-software/upgrade-package/url


Methods

POST

It will upload the file specified by the software upgrade ufl.
[tags: DMA_INTERNAL]

Request

Representations

application/vnd.plcm.plcm-software-upgrade-upload-url+xml
application/vnd.plcm.plcm-software-upgrade-upload-url+json

Response

Status Representation Description
202 software upgrade image uploaded successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid url format
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid software upgrade image format
429 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Too many requests. Maximum number of concurrent requests in progress. Try back later.

https://localhost:8443/api/rest//installed-software/upgrade-history


Methods

GET


Retrieves details of history of installed software versions.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-software-upgrade-details+xml
application/vnd.plcm.plcm-software-upgrade-details+json
Software upgrade history information successfully retrieved
304 Software upgrade history information has not changed since the last get
request.

Note: The API client must provide the "plcm-software-upgrade-details"
representation's
ETag value in the "If-None-Match" HTTP header to ensure the
retrieval.
This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical
request in the "If-None-Match" header, then the HTTP response will
contain the
search results in the message body.

The "plcm-software-upgrade-details" ETag can be accessed from the
initial search result's HTTP
response header. This also assumes no other client made changes to
Software upgrade details on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
User roles required: administrator

https://localhost:8443/api/rest//installed-software/upgrade-package/apply


Methods

POST

It will upgrade the software image.
[tags: DMA_INTERNAL]

Request

Representations

multipart/form-data

Response

Status Representation Description
201 software upgrade image upgraded successfully.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. DMA roles required: administrator

https://localhost:8443/api/rest//installed-software/rollback


Methods

POST

It will rollback the software image to previous version of
build.
[tags: DMA_INTERNAL]

Request

Response

Status Representation Description
201 Software rollback successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator

https://localhost:8443/api/rest//installed-software/softclient-roster/rollback


Methods

POST

It will rollback the softclient / roster software image to previous version of
build.
[tags: DMA_INTERNAL]

Request

Response

Status Representation Description
201 Software rollback successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator