File space create or alter request format

You can request to create or alter a file space from the WebSphere® MQ Managed File Transfer Web Gateway by including content in XML format in the HTTP request. The XML format conforms to the schema FileSpaceInfo.xsd, which is located in the MQ_INSTALLATION_PATH/mqft/samples/schema directory of your WMQMFT installation.

The following example shows the format of an XML request to create a file space.


<filespaces>
  <filespace>
    <quota bytes="1048576"/>
    <writers>
      <authorized>
        <agent-user>SYS.ADMIN.*</agent-user>
      </authorized>
      <unauthorized>
        <agent-user>dave</agent-user>
      </unauthorized>
    </writers>
  </filespace>
</filespaces>

The following example shows the format of an XML request to modify the configuration of an existing file space. You must use the action=add, action=remove and action=overwrite attributes to change the lists of authorized and unauthorized writers.


<filespaces>
  <filespace>
    <quota bytes="2097152"/>
    <writers>
      <authorized action="add">
        <agent-user>emily</agent-user>
      </authorized>
      <unauthorized action="remove">
        <agent-user>dave</agent-user>
      </unauthorized>
    </writers>
  </filespace>
</filespaces>

Understanding the file space creation or modification request

The elements and attributes of the request are described in the following list:

filespaces
Element containing a single <filespace> element.
filespace
Group element containing the information for a file space.
quota
Element describing the amount of file system space that the file space can use. If a user submits a file transfer request that would cause the file space to exceed its quota, the transfer fails and an error is produced.
Attribute Description
bytes The maximum number of bytes that the file space can use.
writers
Group containing information about which users are authorized and not authorized to access the file space.
authorized
Group containing a list of users that are authorized to access the file space.
Attribute Description
action The action to take on the agent-user names specified in the child elements. Valid options are:
  • add - add new agent-user names to the authorized list
  • remove - remove agent-user names from the authorized list
  • overwrite - replace all of the existing authorized list with the list provided.
unauthorized
Group containing a list of users that are not authorized to access the file space. If a user is included in both the authorized and unauthorized lists, they are not authorized to access the file space.
Attribute Description
action The action to take on the agent-user names specified in the child elements. Valid options are:
  • add - add new agent-user names to the unauthorized list
  • remove - remove agent-user names from the unauthorized list
  • overwrite - replace all of the existing unauthorized list with the list provided.
agent-user
Element containing the name of the user that is authorized or unauthorized. This user name can include wildcard characters, to match multiple users.