Skip to content

Latest commit

 

History

History
92 lines (72 loc) · 2.91 KB

mySoftware_export.rst

File metadata and controls

92 lines (72 loc) · 2.91 KB
Raw

mySoftware_export

.. function:: 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 :ref:`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 :ref:`applianceExportStatus-get`. Once complete, the archive can be downloaded using :ref:`applianceExport-download`.

Note

No request body is required in this HTTP POST.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

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"
.. seealso::

         * :ref:`mySoftware-object`
         * :ref:`mySoftwareArtifact-add`
         * :ref:`mySoftwareArtifact-addChild`
         * :ref:`mySoftwareArtifact-addOrRemoveFileFromCache`
         * :ref:`mySoftwareArtifact-createFromRemoteServer`
         * :ref:`mySoftwareArtifact-delete`
         * :ref:`mySoftwareArtifact-deleteAll`
         * :ref:`mySoftwareArtifact-download`
         * :ref:`mySoftwareArtifact-downloadFile`
         * :ref:`mySoftwareArtifact-get`
         * :ref:`mySoftwareArtifact-getAll`
         * :ref:`mySoftwareArtifact-update`
         * :ref:`mySoftwareArtifact-updateAll`
         * :ref:`mySoftwareArtifact-upload`
         * :ref:`mySoftwareExportStatus-get`
         * :ref:`mySoftwareExport-delete`
         * :ref:`mySoftwareExport-download`
         * :ref:`mySoftwareLicense-delete`
         * :ref:`mySoftwareLicense-download`
         * :ref:`mySoftwareLicense-upload`
         * :ref:`mySoftwareLicense-uploadFile`
         * :ref:`mySoftwareLogo-delete`
         * :ref:`mySoftwareLogo-download`
         * :ref:`mySoftwareLogo-downloadFile`
         * :ref:`mySoftwareLogo-upload`
         * :ref:`mySoftwareRestrictionOS-evaluate`
         * :ref:`mySoftwareRestrictionOS-getAll`
         * :ref:`mySoftwareRestriction-update`
         * :ref:`mySoftwareUsage-getAll`
         * :ref:`mySoftware-availableForImage`
         * :ref:`mySoftware-clone`
         * :ref:`mySoftware-create`
         * :ref:`mySoftware-delete`
         * :ref:`mySoftware-get`
         * :ref:`mySoftware-getAll`
         * :ref:`mySoftware-update`
         * :ref:`softwareBundleImport-get`
         * :ref:`softwarebundleImportStatus-get`
         * :ref:`softwarebundleImport-upload`
         * :ref:`softwarebundle-import`
         * :ref:`softwarebundleexport-object`