Skip to content

Latest commit

 

History

History
84 lines (61 loc) · 2.51 KB

targetFormat_updateAccess.rst

File metadata and controls

84 lines (61 loc) · 2.51 KB
Raw

targetFormat_updateAccess

PUT /orgs/{oid}/targetformats

Summary

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

Updates one or more target formats in an organization. This can be either to enable or disable a target format; add or remove a target format or update the default target format list. If a target format has been flagged inactive globally then this target format will no longer be available in the organization.

Note

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

Warning

If you add a target format as default, all existing users will NOT automatically be given access to this target 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 targetFormats-object object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetformats" -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:targetFormats xmlns:ns0="http://www.usharesoft.com/uforge">
    <targetFormats>
        <targetFormat>
            <access>true</access>
            <active>true</active>
            <uri>orgs/1/targetFormats/4</uri>
        </targetFormat>
        <targetFormat>
            <access>false</access>
            <active>false</active>
            <uri>orgs/1/targetFormats/5</uri>
        </targetFormat>
    </targetFormats>
</ns0:targetFormats>
  • imageformat-object
  • primitiveFormat-getAll
  • primitiveFormat-update
  • targetFormatLogo-delete
  • targetFormatLogo-download
  • targetFormatLogo-downloadFile
  • targetFormatLogo-upload
  • targetFormat-create
  • targetFormat-delete
  • targetFormat-get
  • targetFormat-getAll
  • targetFormat-getAllTargetPlatforms
  • targetFormat-update
  • targetformat-object
  • targetplatform-api-resources
  • targetplatform-object