Actions

API actions extend the set of operations that can be performed on Admin API resources. Actions can also execute operations unrelated to specific resources. Actions are always invoked using an HTTP POST. Each action is exposed at a dedicated application endpoint using the following convention: /api.rsc/actionName. For example, if is hosted on mydomain.com and listening on port 8001, the following endpoint would be used to access the cleanup Action:

POST http://mydomain.com:8001/api.rsc/cleanup

The action parameters are specified in the JSON-formatted body of the HTTP post. The request must include the appropriate content-type header (such as application/json) for the POST body to be interpreted correctly. Find the available parameters for each action by clicking API on the navbar. The Admin API includes the following actions:

Action	Description
cleanup	Archive or delete log files, transaction entries in the database, and, optionally, files in the Send, Sent, and Received folders, for the specified workspaces and connectors.
copyConnector	Create a new connector using an existing connector configuration.
copyWorkspace	Create a new workspace by making copies of all the connectors in an existing workspace.
createCert	Create a new digital certificate (public/private key pair) for encryption, signing, decryption, verification, SSL/TLS, and so on.
exchangeCert	Exchange the specified certificate public keys with a trading partner. Only applicable for AS2 and OFTP connectors.
export	Create a configuration file (`.arcflow`) out of profiles settings, connector settings, or workspace settings.
exportDataEncryptionKey	Export the master encryption key as an encrypted data block that contains the data encryption key and its associated cryptographic metadata.
getMessageCount	Retrieve a count of all the unsent messages across all connectors in one or more workspaces.
getTransactionLogs	Retrieve detailed transaction log data for a specific transaction.
import	Import profile, connector, or workspace settings to from a configuration archive (`.arcflow`).
importDataEncryptionKey	Import an encryption key (typically exported from a production environment) into a development or test instance, enabling the development environment to decrypt configuration data and credentials from production backups or imports.
receiveFile	Instruct a specific connector to trigger the connector’s receive action to download/receive a specific file (available for FTP, SFTP, and S3 connectors) or all applicable files (based on the connector’s configuration).
requeueMessage	Move a message back into the Send folder processing queue so it can be reprocessed.
sendFile	Instruct a connector to process (upload, send, transform, and so on) a file in that connector’s Send folder.
setFlow	Set the flow connections for the specified workspace.

Getting Started

Flows

EDI Trading Partner Management Console

Connectors

Mapping

Admin API

How-To Guides

Scripting

Software License and Third-Party Copyrights