Skip to main content

Version: 23.10

app-get

The app-get task downloads an application package from a Journey Manager server.

Task Attributes

All attributes are optional unless otherwise indicated.

AttributeDescription
clientCodeString

Required. The client code of the organization in TM.

nameString

Required. The name of the application package.

The application package must belong to the client specified in the clientCode attribute.

urlString

Required. The TM server URL.

usernameString

Required. The TM server login username.

passwordString

Required. The TM server login password.

proxyFileString

HTTP proxy configuration properties file location.

dirString

The directory to download the application package file into.

Note: Either dir or file must be specified.

fileString

The file path to download the application package file to.

Note: Either file or dir must be specified.

TM Security

To use this task, the user specified by username needs an active user account on the TM server with access to the Management Console module.

To be authorized to call the service, the user account also needs the Management Console permission "REST Service Definitions API".

If the user is not a global administrator, only application packages belonging to the organizations assigned to the user will be accessible. For more information, see Security Managers Overview.

Example

The example Ant task below deletes an application package belonging to a client with client code "mycorp".

<app-get clientCode="mycorp"
name="myapp"
url="https://form.mycorp.com/manager/"
username="[email protected]"
password="password"
dir="./../downloads/"
proxyFile="./proxy.properties" />

Example Ant log output:

app-get:
[app-get] Request: GET https://form.mycorp.com/manager/secure/rest/application-package/v1/mycorp/myapp HTTP/1.1
[app-get] Application Package Downloaded: mycorp/myapp