Download AS2 Artifacts Log operation

You can use the Download AS2 Artifacts Log operation to request and download AS2 artifacts logs.

Because large AS2 artifacts logs can take time to download, the Boomi Enterprise Platform API provides an asynchronous technique for downloading them:

1. The client sends a Runtime AS2 Artifacts request to the Boomi Enterprise Platform API that specifies the Runtime ID and the date of the logged events.

2. The Enterprise platform returns a Log Download object that contains a URL with a unique AS2 artifacts log ID.

3. The client opens the URL to download the log.

Note: Purging of the AS2 artifacts logs occurs 30 days after creation.
You must have the Runtime Management privilege to download AS2 artifacts logs. If you have the Runtime Management Read Access privilege, you cannot perform this action.

Atom AS2 Artifacts object

The CREATE operation specifies the Atom AS2 Artifacts object in a request to download an AS2 artifacts log.

Field	Type	Description
atomId	string	The ID of the Runtime.
logDate	date	The date of the logged events.

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not supported	Not supported	Supported	Not supported	Not supported	Not supported

SOAP Implementation

The following example requests the download of a log containing events dated February 5, 2016, on the Atom whose ID is 3456789a-bcde-f0123-4567-89abcdef012.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
 ATOMSPHERE_PASSWORD
          </wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:create>
         <object xsi:type="api:AtomAS2Artifacts" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             atomId="3456789a-bcde-f012-3456-789abcdef012" logDate="2016-02-05">
         </object>
      </api:create>
   </soapenv:Body>
</soapenv:Envelope>

Log Download object

The Log Download object is the response to a Runtime AS2 Artifacts request.

Field	Type	Description
statusCode	string	The status code as one of the following: - 202 — status message: Beginning download. - 504 — status message: Atom is unavailable.
message	string	The status message.
url	string	(statusCode 202 only) The URL for the download.

SOAP implementation

The following is the SOAP response to the example Runtime AS2 Artifacts request shown previously:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:createResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:result xsi:type="bns:LogDownload" statusCode="202" message="Beginning download." 
             url="http://localhost:8081/account/account-123456/api/download/AtomAS2Artifacts-89abcdef-0123-4567-89ab-cdef01234567"/>
      </bns:createResponse>
   </S:Body>
</S:Envelope>

Download request responses

The download URL specified in a Log Download response, such as http://localhost:8081/account/account-123456/api/download/AtomAS2Artifacts-89abcdef-0123-4567-89ab-cdef01234567, is valid for a single request. These are the possible responses to an HTTP request to open a download URL:

Status code
Description

200 (OK)
The download is complete. The log is in the response body.

All subsequent requests to open the download URL returns 404 (Not Found).

202 (Accepted)
The download is in progress.

You might receive multiple 202 responses before you receive a final download response.

204 (No Content)
The log data is not available.

All subsequent requests to open the download URL returns 404 (Not Found).

404 (Not Found)
You received a 200, 204, or 504 response from a previous request to open this URL.

504 (Gateway Time-out)
The Runtime is unavailable. It might have timed out.

All subsequent requests to open the download URL returns 404 (Not Found).