File space information response format

When you request information about the definition and attributes of a file space from the WebSphere® MQ File Transfer Edition Web Gateway the response is returned in XML format or in JSON format. The XML response conforms to the schema FileSpaceInfo.xsd, which is located in the install_directory/samples/schema directory of your WMQFTE installation.

XML

The following example shows the format of a simple file space information XML response.

<filespaces xsi:noNamespaceSchemaLocation="FileSpaceInfo.xsd">
  <filespace transfers="1" location="/tmp/filespace/daniel" name="daniel">
    <quota bytes="1048576"/>
    <writers>
      <authorized>
        <agent-user>daniel</agent-user>
        <agent-user>SYS.ADMIN.*</agent-user>
      </authorized>
      <unauthorized>
        <agent-user>dave</agent-user>
      </unauthorized>
    </writers>
  </filespace>
</filespaces>

JSON

The following example shows the format of a simple file space information JSON response.

{ 
  "filespaces":{
    "filespace":{
      "transfers":"1",
      "location":"/tmp/filespace/daniel",
      "name":"daniel",
      "writers":{
        "authorized":{
          "agent-user":"daniel",
          "agent-user":"SYS.ADMIN.*"
        },
        "unauthorized":{
          "agent-user":"dave"
        }     
      },
      "quota":{
        "bytes":"1048576"
      }
    }
  }
}

Understanding the file space information response

The elements and attributes of the file space information response are described in the following list:

filespaces
Group containing one or more <filespace> elements.
filespace
Group containing the information for the file space.
Attribute Description
transfers The number of transfers that are in progress to the file space.
location The location in the file system of the file space.
name The name of the file space.
integrity-check-result The result of an integrity check on the file space. Valid values are:
  • OK
  • MISSING_FILESYSTEM
  • MISSING_DATABASEENTRY
quota
Element describing the amount of file system space that the file space can use.
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.
unauthorized
Group containing a list of users that are not authorized to access the file space. If a user name or a user wildcard match appears in both the authorized and the unauthorized lists, they are not authorized to access the file space.
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.

Reference Reference

Feedback

Timestamp icon Last updated: Tuesday, 30 January 2018
http://www.ibm.com/support/knowledgecenter/SSEP7X_7.0.4/com.ibm.wmqfte.doc/web_filespace_info_format.htm