Skip to content

Latest commit

 

History

History
96 lines (76 loc) · 3.05 KB

mySoftware_export.rst

File metadata and controls

96 lines (76 loc) · 3.05 KB
Raw

mySoftware_export

POST /users/{uid}/mysoftware/{msid}/exports

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Request to export the specified software bundle as an archive. This creates an export ticket that contains an archive that can be downloaded. The archive contains the meta-data file of the mySoftware-object.

An archive can be used with the hammr command-line tool.

The response body is an export software bundle ticket. To poll the status of this export, use applianceExportStatus-get. Once complete, the archive can be downloaded using applianceExport-download.

Note

No request body is required in this HTTP POST.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user-object
  • msid (required): the id of the mySoftware-object to be exported

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/exports" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
  • mySoftware-object
  • mySoftwareArtifact-add
  • mySoftwareArtifact-addChild
  • mySoftwareArtifact-addOrRemoveFileFromCache
  • mySoftwareArtifact-createFromRemoteServer
  • mySoftwareArtifact-delete
  • mySoftwareArtifact-deleteAll
  • mySoftwareArtifact-download
  • mySoftwareArtifact-downloadFile
  • mySoftwareArtifact-get
  • mySoftwareArtifact-getAll
  • mySoftwareArtifact-update
  • mySoftwareArtifact-updateAll
  • mySoftwareArtifact-upload
  • mySoftwareExportStatus-get
  • mySoftwareExport-delete
  • mySoftwareExport-download
  • mySoftwareLicense-delete
  • mySoftwareLicense-download
  • mySoftwareLicense-upload
  • mySoftwareLicense-uploadFile
  • mySoftwareLogo-delete
  • mySoftwareLogo-download
  • mySoftwareLogo-downloadFile
  • mySoftwareLogo-upload
  • mySoftwareOs-getAll
  • mySoftwareRestrictionOs-getAll
  • mySoftwareRestriction-add
  • mySoftwareRestriction-delete
  • mySoftwareRestriction-deleteAll
  • mySoftwareRestriction-get
  • mySoftwareRestriction-getAll
  • mySoftwareRestriction-update
  • mySoftwareUsage-getAll
  • mySoftware-clone
  • mySoftware-create
  • mySoftware-delete
  • mySoftware-get
  • mySoftware-getAll
  • mySoftware-update
  • softwareBundleImport-get
  • softwarebundleImportStatus-get
  • softwarebundleImport-upload
  • softwarebundle-import
  • softwarebundleexport-object