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.

Parameter	Description
archiveFile	Required. The application package archive ZIP file.
overwriteExisting	Overwrite any existing application package.
importDeliveryChannels	Whether delivery channels will be included in the import. Values: true, false (Default: true)
importForms	Whether forms will be included in the import. Values: true, false (Default: true)
importOrganizationProperties	Whether organization properties will be included in the import. Values: true, false (Default: true)
importServiceConnections	Whether service connections will be included in the import. Values: true, false (Default: true)
importServices	Whether service definitions will be included in the import. Values: true, false (Default: true)
preserveDeliveryChannels	Whether existing delivery channels will be preserved (not modified during import). Values: true, false (Default: false)
preserveServiceConnections	Whether existing service connections will be preserved (not modified during import). Values: true, false (Default: false)
preserveServices	Whether 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"
}