reportfiledownloadmtom (Command)

  • Published on Jul 7, 2025
  • 1 minute(s) read
Prev Next

The reportfiledownloadmtom command downloads a report that was previously generated using REPORTCMD_RUN (see  REPORTCMD_RUN). The generated report is referred to by its report file identifier and is downloaded as binary attachment using MTOM encoding.

Parameters

  Table: reportfiledownloadmtom input parameters
Parameter nameData typeDescription
sessionIDStringRequired. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see  logon (Command)).
attributeSetReportFileAttributeSetRequired. The attribute set containing the report file identifier to be downloaded.
  Table: reportfiledownloadmtom output parameters
Parameter nameData typeDescription
resultsReportFileResultsRequired. The result structure containing the return and status codes.
reportfilexop:IncludeOptional. The XML-binary Optimized Packaging (XOP) reference to the report binary attachment specified in ID 4.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: reportfiledownloadmtom (Supported input attributes)
Attribute nameOptionality
REPORTFILEFLD_REPORTFILE_IDMandatory

The following attributes will be specified in the results output parameter of this command:

  Table: reportfiledownloadmtom (Supported output attributes)
Attribute nameReturned
REPORTFILEFLD_CREATE_TIMEMandatory
REPORTFILEFLD_DESCRIPTIONMandatory
REPORTFILEFLD_DOMAIN_NAMEMandatory
REPORTFILEFLD_MODIFY_TIMEMandatory
REPORTFILEFLD_REPORTFILE_IDMandatory
REPORTFILEFLD_SERVER_IDMandatory
REPORTFILEFLD_SIZEMandatory
REPORTFILEFLD_USER_IDMandatory

For more information about the specific attributes, see Table: reportFileExecute field attributes.

Example

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <adm:reportfiledownloadmtom xmlns:adm="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration">
      <sessionID>xM0T9TmM2T?Nxx~sUmc3D.AFTwum??kH</sessionID>
        <attributeSet>
          <attributes>
            <value xsi:type="xsd:string">1562715754070</value>
             <attributeID>REPORTFILEFLD_REPORTFILE_ID</attributeID>
          </attributes>
        </attributeSet>
    </adm:reportfiledownloadmtom>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>