Boomi Platform API Reference (1.0.0) - AtomAS2Artifacts
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 Platform API provides an asynchronous technique for downloading them:
- The client sends an Atom AS2 Artifacts request to the Boomi Enterprise Platform API that specifies the Runtime ID and the date of the logged events.
- The Enterprise platform returns a Log Download object that contains a URL with a unique AS2 artifacts log ID.
- 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.
Creates an AtomAS2Artifacts object
You can use the Download AS2 Artifacts Log operation to request and download AS2 artifacts logs.
Authorizations:
basicAuth
Request Body schema: optional
| atomId | string The ID of the Runtime. |
| logDate | string The date of the logged events. |
Responses
Response Schema:
| statusCode | string The status code as one of the following:
|
| message | string The status message. |
| url | string (statusCode 202 only) The URL for the download. |
Request samples
- Payload
Content type
{- "atomId": "3456789a-bcde-f012-3456-789abcdef012",
- "logDate": "2016-02-05"
}Response samples
- 200
- 403
- 410
- 503
Content type
{- "@type": "AtomAS2Artifacts",
- "message": "Beginning download.",
- "statusCode": 202
}Was this topic helpful?