Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 2.43 KB

primitiveFormat_update.rst

File metadata and controls

86 lines (63 loc) · 2.43 KB
Raw

primitiveFormat_update

PUT /orgs/{oid}/formats

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the access rights for a primitive format in an organization. If a primitive format has been flagged inactive globally then this primitive format will no longer be available in the organization.

Note

When a primitive format is flagged as default then any new user created or added to the organization will be automatically given access to this primitive format.

Warning

If you add a primitive format as default, all existing users will NOT automatically be given access to this primitive format. You will need to do this explicitly.

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 imageFormats-object object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/formats" -X PUT \
-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:imageFormats xmlns:ns0="http://www.usharesoft.com/uforge">
    <imageFormats>
        <imageFormat>
            <access>true</access>
            <active>true</active>
            <preselected>true</preselected>
            <uri>format/5</uri>
        </imageFormat>
        <imageFormat>
            <access>true</access>
            <active>true</active>
            <preselected>true</preselected>
            <uri>format/7</uri>
        </imageFormat>
    </imageFormats>
</ns0:imageFormats>
  • imageformat-object
  • primitiveFormat-getAll
  • targetFormatLogo-delete
  • targetFormatLogo-download
  • targetFormatLogo-downloadFile
  • targetFormatLogo-upload
  • targetFormat-create
  • targetFormat-delete
  • targetFormat-get
  • targetFormat-getAll
  • targetFormat-getAllTargetPlatforms
  • targetFormat-update
  • targetFormat-updateAccess
  • targetformat-object
  • targetplatform-api-resources
  • targetplatform-object