Page tree
Skip to end of metadata
Go to start of metadata

Last updated: Feb 10, 2020 15:19

Downloads the item specified by <repositoryItemKey> from the repository area specified by <repository>.

It is possible to download individual items (e.g. JPG) via the user interface (but not folders).

<repository> is specified as follows:

  • media - the repository area for general media files
  • datatables - the repository area for data table file

<repositoryItemKey> is specified as a repository key.

Request syntax

https://mycloud.perfectomobile.com/services/repositories/<repository>/<repositoryItemKey>?operation=download&securityToken=value[&optionalParameter=value]

Note: All REST API commands require authentication, see the general authentication methods here.

Parameters

NameTypeDefaultDescription
securityToken*string
A unique cryptographic key assigned to an authorized user.
userstring 

Deprecated. The name of the user running the operation. 

Note: Going forward, all authentication requires a security token. For information on obtaining a security token, see Generate security tokens.

passwordstring 

Deprecated. The password for the user. 

Note: Going forward, all authentication requires a security token. For information on obtaining a security token, see Generate security tokens.

admin booleanfalsetrue to allow users with administrative credentials to download items located in the private repository of other automation users.
owner string 
The user name of the user who owns the item. This parameter is used in conjunction with the admin parameter to correctly identify items stored in PRIVATE or GROUP repositories of the owner. For example, if an user with administrative credentials wants to download an item where the repositoryItemKey is PRIVATE:myItem.jpg or GROUP:myItem.jpg, specify the parameters asadmin=true and owner=itemUser.
group string 
The group name. This parameter is used in conjunction with the admin parameter to correctly identify items stored in GROUP repositories. For example, if a user with administrative credentials wants to download an item where the repositoryItemKey is GROUP:myItem.jpg, specify the parameters as admin=true and group= groupName.
responseFormat string jsonFormat of response: json, xml

 * Mandatory

Request & Response

Request without optional parameters
https://mycloud.perfectomobile.com/services/repositories/media/homeIcon.png?operation=download&securityToken=<your_token> 

The response is the content of the file. The HTTP content type for the response corresponds to the file format.