File space query response formats

When you request a list of some or all of the files in a file space from the WebSphere® MQ File Transfer Edition Web Gateway the response is returned in either JSON or XML format, depending on what you have specified using the Accept: header.

XML

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

<fileSpaces xsi:noNamespaceSchemaLocation="WebFileSpaceList.xsd">
  <fileSpace size="1" name="james">
    <file fileLink="/wmqfte/filespace/james/414d51205745422e4654452020202020c1a1a34b03720120/file.zip" 
          transferLink="/wmqfte/transfer/414d51205745422e4654452020202020c1a1a34b03720120" 
          transferID="414d51205745422e4654452020202020c1a1a34b03720120" 
          name="/tmp/ae55bc7">
      <attribute-values mode="text" time="2010-08-26T19:00:02.000Z" 
                        file-size="259354303" 
                        checksum-value="98611a272a27d373f92d73a08cf0d4f4" 
                        checksum-method="none"/>
    </file>
  </fileSpace>
</fileSpaces>
The XML response conforms to the schema WebFileSpaceList.xsd, which is located in the install_directory/samples/schema directory of your WMQFTE installation.

JSON

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

{
   "fileSpaces" : {
      "fileSpace" : {
         "name" : "james",
         "size" : "1",
         "file" : {
            "transferLink" : "\/wmqfte\/transfer\/414d51205745422e4654452020202020c1a1a34b03720120",
            "fileLink" : "\/wmqfte\/filespace\/1234\/414d51205745422e4654452020202020c1a1a34b03720120\/file.zip",
            "name" : "\/tmp\/ae55bc7",
            "transferID" : "414d51205745422e4654452020202020c1a1a34b03720120",
            "attribute-values" : {
               "checksum-value" : "98611a272a27d373f92d73a08cf0d4f4",
               "checksum-method" : "none",
               "time" : "2010-08-26T19:00:02.000Z",
               "file-size" : "259354303",
               "mode" : "text"
            }
         }
      }
   }
}

Understanding the file space query response

The names of the elements and attributes in the XML response format and the names of the objects in the JSON response format are the same. These elements, attributes, and objects are described in the following list:

filespaces
Group containing file space information.
filespace
Group containing the information for a single file space.
Attribute or object Description
size The number of files in the file space returned by the query.
name The name of the file space.
file
Group containing the file information.
Attribute or object Description
fileLink Part of the URI used to download the file from the file space.

The full URI for downloading the file is host-name/fileLink

transferLink Part of the URI used to view the transfer information of the transfer that put the file in the file space.

The full URI for viewing the transfer information is host-name/transferLink

transferID The unique hexadecimal ID of the transfer that put the file in the file space.
name The file path of the file on the system that hosts the file space.
attribute-values
Specifies additional information about the file being transferred.
Attribute or object Description
file-size The size of the file.
mode The mode of the transfer. Valid values are:
  • text
  • binary
checksum-method The method used to produce a checksum value of this file.
checksum-value The checksum value of the file.
time The time when the file was transferred to the file space, in Coordinated Universal Time.
integrity-check-result The result of an integrity check on the file. Valid values are:
  • OK
  • MISSING_FILESYSTEM
  • MISSING_DATABASEENTRY

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_query_resp.htm