Table of Contents |
---|
Info | ||
---|---|---|
| ||
Add the following command after the username and password to receive more meaningful HTTP errors:
This command can be added to each call. |
...
Request Method | GET | ||
Description | Returns a list of all the folders in the folder tree in Datameer. | ||
URI Syntax |
| ||
Example Response |
|
...
Request Method | GET | ||
Description | Returns a list of the folder's content in Datameer. | ||
URI Syntax |
| ||
Example Response |
|
...
Request Method | GET | ||
Description | Returns a list of the folder's permissions in Datameer. | ||
URI Syntax |
| ||
Example Response |
|
...
Request Method | GET | ||
Description | Returns a list of the folder's group permissions in Datameer. | ||
URI Syntax |
| ||
Example Response |
|
...
Request Method | GET | ||
Description | Returns a list of the folder's permissions for others in Datameer. | ||
URI Syntax |
| ||
Example Response |
|
...
Request Method | GET | ||
Description | Returns a list of the folder's owners in Datameer. | ||
URI Syntax |
| ||
Example Response |
|
...
Request Method | PUT | ||
Description | Changes the owner of folder in Datameer. | ||
URI Syntax |
|
...
Request Method | POST | ||
Description | Sets permissions for groups for a folder created in Datameer. | ||
URI Syntax |
|
...
Request Method | PUT | ||
Description | Changes permissions for groups for a folder created in Datameer. | ||
URI Syntax |
|
...
Request Method | PUT | ||
Description | Changes permissions for others for a folder in Datameer. | ||
URI Syntax |
|
...
Request Method | DELETE | ||
Description | Deletes the group permissions of a folder in Datameer. | ||
URI Syntax |
|
...
Request Method | GET | ||
Description | Downloads the folder and all its contents including sub folders and their contents. | ||
URI Syntax | INFO: To find a folder using the path, the path needs to be URL encoded, (e.g., use
| ||
Verification | The ZIP file downloaded is located in the directory the REST call was given. |
...
Description | Allows for backing up a project where the data sources (for example) are not contained within the same folder as the rest of the project. | ||
URI Syntax |
|
...
Description | Disregards entities where dependencies are contained outside of the folder to backup, these files aren't written to the zip file. | ||
URI Syntax |
|
...
Request Method | POST | ||||||
Description | Downloads a specific file from a folder. | ||||||
Preparation | To download a specific file from a folder, you need to create and save a JSON file that is used to locate the file you want to download. JSON example using the file path:
JSON example using the file-id:
JSON example using the uuid:
| ||||||
URI Syntax | INFO: To find a folder using the path, the path needs to be URL encoded, (e.g., use
| ||||||
Verification | The ZIP file downloaded is located in the directory the REST call was given. |
...
Request Method | PUT | ||
Description | Uploads the folder and all its contents including sub-folders and their contents. | ||
URI Syntax | To find a folder using the path, the path needs to be URL encoded, (e.g., use
| ||
Verification | The ZIP file downloaded is located in the directory the REST call was given. | ||
Restrictions & Notes |
|
...
Description | Replaces and overwrite files that might be located within the target folder in the target system. Existing configurations with downstream dependencies cannot be overwritten. Overwrite functions adhere to the user’s existing permission settings. If a user has the capability to overwrite Hadoop properties, they will be overwritten, otherwise not.
| |||||
URI Syntax |
| |||||
Example Response |
|
Restore-Skip
Description | If the dependencies of a file can't be resolved, the file is ignored and the REST response includes the skipped files. | ||
URI Syntax |
|
...
Request Method | GET | ||
Description | Backup includes the data permissions for each backed up workbook file in the zip file. | ||
URI Syntax |
| ||
Restrictions & Notes | Ignored if something else other than a workbook is backed up (or restored). |
...
Request Method | GET | ||
Description | Backup includes the group permissions for each backed up file and folder in a zip file. | ||
URI Syntax |
|
...
Request Method | GET | ||
Description | Backup includes the sharing option for each backed up file and folder in the zip file. This includes permission of others and public sharing of an infographic. | ||
URI Syntax |
|
...
Request Method | GET | ||
Description | Backup includes the owner for each backed up file and folder in the zip file. | ||
URI Syntax |
|
...
Request Method | PUT | ||
Description | Restores the permissions for a file or folder in Datameer. | ||
URI Syntax |
| ||
Restrictions & Notes | Restores the data permissions of a workbook and restores read permissions for others. |
Anchor | ||||
---|---|---|---|---|
|
Request Method | PUT | ||
Description | Restores each file or folder with the group permissions specified in the zip file. | ||
URI Syntax |
|
IgnoreUnknownGroups
Description | Restores group permissions and skips unknown groups.
| |||||
URI Syntax |
|
...
Request Method | PUT | ||
Description | Restores each file or folder with the sharing options specified in the zip file. | ||
URI Syntax |
|
...
Request Method | PUT | ||
Description | Restores each file or folder with the owner specified in the zip file. | ||
URI Syntax |
| ||
Restriction & Notes | Restore operation is aborted if the specified owner is unknown to Datameer X unless the option ' When option ' |
substituteMissingUser
Description | Restore owners of files by substituting unknown users with the caller.
| |||||
URI Syntax |
|
...