Skip to main content

Version: 22.04

POST Upload Application Package Archive (New Application)

Upload an application package archive ZIP file into the Journey Manager server. The application package with the given name and organization must not exist on the server for the call to succeed.

info

The Application Package REST API Overview provides an introduction to this REST API, including information about:

  • Security (authentication and authorization)

Request

HTTP request

POST https://<JM_SERVER>/manager/secure/rest/application-package/v1/<CLIENT_CODE>/

Parameters

The available Multipart POST request parameters are as follows. All parameters are optional unless otherwise indicated.

ParameterDescription
archiveFileRequired. The application package archive ZIP file.
overwriteExistingOverwrite any existing application package.
importDeliveryChannelsWhether delivery channels will be included in the import.
Values: true, false (Default: true)
importFormsWhether forms will be included in the import.
Values: true, false (Default: true)
importOrganizationPropertiesWhether organization properties will be included in the import.
Values: true, false (Default: true)
importServiceConnectionsWhether service connections will be included in the import.
Values: true, false (Default: true)
importServicesWhether service definitions will be included in the import.
Values: true, false (Default: true)
preserveDeliveryChannelsWhether existing delivery channels will be preserved (not modified during import).
Values: true, false (Default: false)
preserveServiceConnectionsWhether existing service connections will be preserved (not modified during import).
Values: true, false (Default: false)
preserveServicesWhether existing service definitions will be preserved (not modified during import).
Values: true, false (Default: false)

Request body

Do not supply a request body for this operation.

Example

The following example illustrates a multipart POST request.

POST /manager/secure/rest/application-package/v1/maguire/ HTTP/1.1
Host: https://transact.maguire.com
Content-type: multipart/form-data, boundary=AaB03x

--AaB03x
content-disposition: form-data; name="archiveFile"; filename="application-package-archive-Maguire_Services-2017-03-01.zip"
Content-Transfer-Encoding: binary
...
--AaB03x--
==========================

Response

If successful, this operation returns a response with a HTTP 200 OK status code.

Example

An example successful response is shown below.

{
"archiveName": "application-package-archive-Maguire_Services-2017-03-01.zip",
"importMessage": "Application package named 'Maguire Services' for organization 'maguire' was imported successfully.",
"importStatus": "Completed",
"importTime": "2017-03-01T13:38+1100"
}