targetFormat_create.rst

targetFormat_create

POST /orgs/{oid}/targetformats

Summary

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

Creates a new target format in an organization. This is a format used to generate machine images. A target format is extends a primitive format type supported by the platform e.g. AMI, VHD, Hyper-V etc.

Please refer to targetformat-object for a complete list of all the target format attributes.

Security Summary

• Requires Authentication: true
• Entitlements Required: org_formats_administrate

URI Parameters

• oid (required): the id of the org-object

HTTP Request Body Parameters

A targetFormat-object object

Example Request

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

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

<ns0:targetFormat xmlns:ns0="http://www.usharesoft.com/uforge">
    <name>My VBox</name>
    <format>
        <name>vbox</name>
    </format>
    <category>
        <name>Virtual</name>
    </category>
    <type>virtual</type>
    <imageInfos>When you will have generated your image, please add it to VirtualBox by doing: Machine > Add. Then select the .xml file.</imageInfos>
</ns0:targetFormat>

• imageformat-object
• primitiveFormat-getAll
• primitiveFormat-update
• targetFormatLogo-delete
• targetFormatLogo-download
• targetFormatLogo-downloadFile
• targetFormatLogo-upload
• targetFormat-delete
• targetFormat-get
• targetFormat-getAll
• targetFormat-getAllTargetPlatforms
• targetFormat-update
• targetFormat-updateAccess
• targetformat-object
• targetplatform-api-resources
• targetplatform-object