List As2 Incoming Messages

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "as2_partner_id": {
      "type": "integer",
      "format": "int32"
    },
    "cursor": {
      "type": "string"
    },
    "filter": {
      "type": "object"
    },
    "filter_gt": {
      "type": "object"
    },
    "filter_gteq": {
      "type": "object"
    },
    "filter_like": {
      "type": "object"
    },
    "filter_lt": {
      "type": "object"
    },
    "filter_lteq": {
      "type": "object"
    },
    "per_page": {
      "type": "integer",
      "format": "int32"
    },
    "sort_by": {
      "type": "object"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "List As2 Incoming Messages",
    "properties": {
      "activity_log": {
        "type": "string",
        "description": "JSON Structure of the activity log."
      },
      "as2_from": {
        "type": "string",
        "description": "AS2 FROM header of message"
      },
      "as2_partner_id": {
        "type": "integer",
        "format": "int32",
        "description": "Id of the AS2 Partner associated with this message."
      },
      "as2_station_id": {
        "type": "integer",
        "format": "int32",
        "description": "Id of the AS2 Station associated with this message."
      },
      "as2_to": {
        "type": "string",
        "description": "AS2 TO header of message"
      },
      "attachment_filename": {
        "type": "string",
        "description": "Filename of the file being received."
      },
      "body_size": {
        "type": "string",
        "description": "Encrypted Payload Body Size"
      },
      "content_type": {
        "type": "string",
        "description": "Content Type header of the incoming message."
      },
      "created_at": {
        "type": "string",
        "format": "date-time",
        "description": "Message creation date/time"
      },
      "date": {
        "type": "string",
        "description": "Date Header"
      },
      "encrypted_uri": {
        "type": "string",
        "description": "URL to download the encrypted signed smime that is to sent as AS2 body"
      },
      "hex_recipient_serial": {
        "type": "string",
        "description": "Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial in hex format."
      },
      "http_headers": {
        "type": "object",
        "description": "HTTP Headers sent with this message."
      },
      "http_response_code": {
        "type": "string",
        "description": "HTTP Response Code sent for this message"
      },
      "http_response_headers": {
        "type": "object",
        "description": "HTTP Headers sent for this message."
      },
      "id": {
        "type": "integer",
        "format": "int32",
        "description": "Id of the AS2 Partner."
      },
      "ip": {
        "type": "string",
        "description": "IP Address of the Sender"
      },
      "mdn_response_uri": {
        "type": "string",
        "description": "URL to download the http response body"
      },
      "message_decrypted": {
        "type": "boolean",
        "description": "Message decrypted successfully?"
      },
      "message_id": {
        "type": "string",
        "description": "AS2 Message Id"
      },
      "message_mdn_returned": {
        "type": "boolean",
        "description": "MDN returned?"
      },
      "message_processing_success": {
        "type": "boolean",
        "description": "Message processed successfully?"
      },
      "message_received": {
        "type": "boolean",
        "description": "Message body received?"
      },
      "message_signature_verified": {
        "type": "boolean",
        "description": "Message signature verified?"
      },
      "mic": {
        "type": "string",
        "description": "AS2 Message Integrity Check"
      },
      "mic_algo": {
        "type": "string",
        "description": "AS2 Message Integrity Check Algorithm Used"
      },
      "processing_result": {
        "type": "string",
        "description": "Result of processing.",
        "enum": [
          "not_started",
          "unable_to_find_station",
          "unable_to_find_partner",
          "unable_to_validate_signature",
          "decrypt_fail",
          "file_save_fail",
          "success"
        ]
      },
      "processing_result_description": {
        "type": "string",
        "description": "Result of processing description."
      },
      "raw_uri": {
        "type": "string",
        "description": "URL to download the original file contents"
      },
      "recipient_issuer": {
        "type": "string",
        "description": "Incoming Message Recipient(the Client Cert used to encrypt this message)'s issuer"
      },
      "recipient_serial": {
        "type": "string",
        "description": "Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial"
      },
      "smime_signed_uri": {
        "type": "string",
        "description": "URL to download the file contents as smime with signature"
      },
      "smime_uri": {
        "type": "string",
        "description": "URL to download the file contents encoded as smime"
      },
      "subject": {
        "type": "string",
        "description": "AS2 Subject Header"
      },
      "uuid": {
        "type": "string",
        "description": "UUID assigned to this message."
      }
    }
  }
}