targetPlatform_updateAccess

PUT /orgs/{oid}/targetplatforms

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

Note

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

Warning

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

HTTP Request Body Parameters

A targetPlatforms object

Example Request

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

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

<ns0:targetPlatforms xmlns:ns0="http://www.usharesoft.com/uforge">
        <targetPlatforms>
                <targetPlatform>
                        <access>true</access>
                        <active>true</active>
                        <uri>orgs/1/targetPlatforms/4</uri>
                </targetPlatform>
                <targetPlatform>
                        <access>false</access>
                        <active>false</active>
                        <uri>orgs/1/targetPlatforms/5</uri>
                </targetPlatform>
        </targetPlatforms>
</ns0:targetPlatforms>