workspaceTemplate_share

POST /orgs/{oid}/workspaces/{wid}/templates

Requests to add an appliance from a user’s Appliance Library to a workspace.

This allows users to share their private appliance templates with other users via a workspace.

The response body is a gallery template that provides the meta-data of the new appliance template being shared. The actual process is done asynchronously. To poll the status, use workspaceTemplateStatus_get.

Once complete, the appliance template is available for other users.

To cancel the process use workspaceTemplateShare_cancel

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

A galleryTemplate object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/templates" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:galleryTemplate xmlns:ns0="http://www.usharesoft.com/uforge">
        <description>This is a description example when sharing a template.</description>
        <name>Appliance Example</name>
        <version>1.0</version>
        <allowComments>true</allowComments>
        <applianceUri>users/root/appliances/6</applianceUri>
        <publisher>user</publisher>
</ns0:galleryTemplate>