Create an archive request

post

https://api.test.ecosio-hub.com:{port}/api/v1/archives

Creates a request to archive EDI messages matching the specified patterns. The response returns a unique archive request ID.

Body Params

For the entryPattern the following fields are recognized for substitution:

EntryPattern Options	Description
YEAR	The year the document was received by the Integration Hub
MONTH	The month in the year the document was received by the Integration Hub
DAY	The day of the mont the document was received by the Integration Hub
TIMESTAMP	The timestamp the document was received at
MESSAGE_ID	The unique identifier of the message archived
MESSAGE_STATUS	The status of the message archived
MIME_TYPE	The MIME type of the document (i.e. XML, CSV, …)
EXTENSION	The extension of the document in the archive
SENDER_UUID	The unique identifier of the sending company
SENDER_NAME	Human readable name of the sender of the document
RECEIVER_UUID	The unique identifier of the receiving company
RECEIVER_NAME	Human readable name of the receiver of the document
DOCUMENT_TYPE	The unique identifier of the identified document type
RANDOM_ALPHANUMERIC_1	Random alphanumeric character
RANDOM_ALPHANUMERIC_8	Sequence of 8 alphanumeric random characters
RANDOM_NUMERIC_1	Random numeric character
RANDOM_NUMERIC_8	Sequence of 8 numeric random characters
IN_OUT	If specified will separate received files from sent files by including a dedicated segment named IN, for received, and OUT, for sent documents.

Archive details

direction

string | null

Specifies if only EDI documents should be archived that have been sent to the Integration Hub (DELIVERED), that have been received from the service (RECEIVED) or if both sent and received EDI documents should be archived (ALL)

companyUuid

string | null

In case of a Multi Tenant Connector the Archive Creation process need to be verified through the companyUuid. This Uuid can be found in the ecosio.monitor section Connectors.

from

date-time | null

Will include EDI documents younger than this timestamp in the resulting archive. The date must be in ISO 8601 format.

till

date-time | null

Will include EDI documents older than this timestamp in the resulting archive. The date must be in ISO 8601 format.

messageIds

array of strings | null

Specifies that only EDI messages with messageIds listed in this array will be added to the archive. If this field is available any time-based related settings (from and till) will be ignored! Entries of that array should be the messageId strings to include

messageIds

entryPattern

string | null

Defines the path structure and file name of the respective files within the archive

includeAcknowledgment

boolean | null

Allows to add acknowledgment files to the archive (e.g. for outbound invoices to SDI)

includePdf

boolean | null

Allows to add PDF files to the archive

includeManifest

boolean | null

Allows to add a JSON file with the overview of the merged/split messages

Responses

Code	Name	Description
100	APPLICATION_KEY_INVALID	Thrown if either no or an invalid application key was provided
110	INVALID_JSON_MESSAGE	Is thrown in case the request is invalid JSON
120	EXPECTED_QUERY_PARAMETER_MISSING	Indicates that a required query parameter is missing in a request. Often this indicates that the appKey parameter is missing
123	QUERY_PARAMETER_UNKNOWN	The value of a provided query parameter is unknown to the service.
200	ARGUMENT_NULL	Indicates that a required argument is null

Code	Name	Description
101	USER_KEY_INVALID	The user provided a wrong user key (deprecated)
104	USER_NOT_PERMITTED	The user authenticated successfully but has no rights to fulfill the requested task

202ACCEPTED. Archive creation has been accepted

401UNAUTHORIZED In case the authentication credentials are not valid CodeNameDescription102CREDENTIALS_INVALIDThe provided credentials are invalid

403FORBIDDEN. In case the user could not be authenticated CodeNameDescription101USER_KEY_INVALIDThe user provided a wrong user key (deprecated)104USER_NOT_PERMITTEDThe user authenticated successfully but has no rights to fulfill the requested task

404NOT FOUND. In case the message could not be found

500INTERNAL SERVER ERROR. CodeNameDescription300INTERNAL_SERVER_ERRORAn unexpected error occurred while processing the request. Please contact [email protected] to gain updates on the cause of the error (deprecated)