files.com
Version:
Files.com SDK for JavaScript
97 lines (87 loc) • 4.43 kB
Markdown
# As2OutgoingMessage
## Example As2OutgoingMessage Object
```
{
"id": 1,
"as2_partner_id": 1,
"as2_station_id": 1,
"uuid": "example",
"http_headers": {
"key": "example value"
},
"processing_result": "example",
"processing_result_description": "example",
"mic": "example",
"mic_sha_256": "example",
"as2_to": "example",
"as2_from": "example",
"date": "example",
"message_id": "example",
"body_size": "example",
"attachment_filename": "example",
"created_at": "2000-01-01T01:00:00Z",
"http_response_code": "example",
"http_response_headers": {
"key": "example value"
},
"http_transmission_duration": 1.0,
"mdn_received": true,
"mdn_valid": true,
"mdn_signature_verified": true,
"mdn_message_id_matched": true,
"mdn_mic_matched": true,
"mdn_processing_success": true,
"raw_uri": "example",
"smime_uri": "example",
"smime_signed_uri": "example",
"encrypted_uri": "example",
"mdn_response_uri": "example"
}
```
* `id` (int64): Id of the AS2 Partner.
* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
* `as2_station_id` (int64): Id of the AS2 Station associated with this message.
* `uuid` (string): UUID assigned to this message.
* `http_headers` (object): HTTP Headers sent with this message.
* `processing_result` (string): Result of processing.
* `processing_result_description` (string): Result of processing description.
* `mic` (string): AS2 Message Integrity Check SHA1
* `mic_sha_256` (string): AS2 Message Integrity Check SHA256
* `as2_to` (string): AS2 TO
* `as2_from` (string): AS2 FROM
* `date` (string): Date Header
* `message_id` (string): AS2 Message Id
* `body_size` (string): Encrypted Payload Body Size
* `attachment_filename` (string): Filename of the file being sent.
* `created_at` (date-time): Message creation date/time
* `http_response_code` (string): HTTP Response Code received for this message
* `http_response_headers` (object): HTTP Headers received for this message.
* `http_transmission_duration` (double): HTTP transmission duration in seceonds
* `mdn_received` (boolean): Did the partner give a response body?
* `mdn_valid` (boolean): Is the response in MDN format?
* `mdn_signature_verified` (boolean): MDN signature verified?
* `mdn_message_id_matched` (boolean): MDN message id matched?
* `mdn_mic_matched` (boolean): MDN MIC matched?
* `mdn_processing_success` (boolean): MDN disposition indicate a successful processing?
* `raw_uri` (string): URL to download the original file contents
* `smime_uri` (string): URL to download the file contents encoded as smime
* `smime_signed_uri` (string): URL to download the file contents as smime with signature
* `encrypted_uri` (string): URL to download the encrypted signed smime that is to sent as AS2 body
* `mdn_response_uri` (string): URL to download the http response body
---
## List AS2 Outgoing Messages
```
await As2OutgoingMessage.list({
'as2_partner_id': 1,
})
```
### Parameters
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at` and `as2_partner_id`.
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.