File Management APIs File Resource
POST pentaho/api/repo/files/backupcurl -X POST \
"http://localhost:8080/pentaho/api/repo/files/backup" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "logFile=/path/to/export.log&logLevel=INFO&outputFile=/path/to/backup.zip"HTTP Basic Authentication
Path to the log file for the backup operation
/path/to/export.logLog level for the backup operation
INFOPath for the output backup file
/path/to/backup.zipSuccessfully exported the existing Pentaho System
Encrypted file stream containing the backup
User has provided an invalid file path
User does not have administrative permissions
Failure to complete the export
POST pentaho/api/repo/files/systemRestorecurl -X POST \
"http://localhost:8080/pentaho/api/repo/files/systemRestore" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: multipart/form-data" \
-F "[email protected]" \
-F "overwriteFile=true" \
-F "applyAclSettings=true" \
-F "overwriteAclSettings=true" \
-F "logFile=/path/to/import.log" \
-F "logLevel=INFO" \
-F "backupBundlePath=/path/to/bundle"HTTP Basic Authentication
The zip file generated using the backup endpoint, used to do a full system restore
The file to be imported
/path/to/overwrite.zipWhether to overwrite existing files during restore. If kept at the default of true, overwrites any value found on the system with the matching value that is being imported. Values that exist on the system, but do not exist in the import will not be deleted. When the overwrite flag is equal to false, any value that is found in the import process that already exists will not be imported.
trueWhether to apply ACL settings from the backup
trueWhether to overwrite existing ACL settings
truePath to the log file for the restore operation
/path/to/import.logLog level for the restore operation
INFOPath to the backup bundle
/path/to/bundleSuccessfully imported the Pentaho System
No content
User has provided an invalid file path
User does not have administrative permissions
Failure to complete the import
No content
PUT pentaho/api/repo/files/deletecurl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/delete" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: text/plain" \
-d "home:admin:file1.txt,home:admin:file2.txt"HTTP Basic Authentication
Comma separated list of the files to be moved to trash folder
home:admin:file1.txt,home:admin:file2.txtSuccessfully moved file to trash
No content
Failure move the file to the trash
No content
PUT pentaho/api/repo/files/deletepermanentcurl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/deletepermanent" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: text/plain" \
-d "home:admin:file1.txt,home:admin:file2.txt"HTTP Basic Authentication
Comma separated list of the files to be deleted permanently
home:admin:file1.txt,home:admin:file2.txtSuccessfully deleted the comma separated list of fileIds from the system
No content
Failure to delete the file due to path not found
No content
GET pentaho/api/repo/exists?pathId=%2Fhome%2Fuser%2Ftest_file.wtrcurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/exists?pathId=%2Fhome%2Fuser%2Ftest_file.wtr" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
Encoded path of the repository file to check. Must be URL-encoded.
home%2Fuser%2Ftest_file.wtrSuccessfully finds the file
No content
Failed to find the file or invalid input
For any other exceptions
No content
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xmlcurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/jmeter-test:test_file_1.xml" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: */*"HTTP Basic Authentication
Colon separated path for the repository file
jmeter-test:test_file_1.xmlSuccessfully get the file or directory
File content stream with appropriate headers (supports any media type)
Failed to find the file or resource
Failed to open content
PUT /repo/files/:jmeter-test:test_file_1.xmlcurl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/jmeter-test:test_file_1.xml" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: */*" \
--data-binary @file_content.xmlHTTP Basic Authentication
The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file
jmeter-test:test_file_1.xmlAn Input Stream with the contents of the file to be created
Successfully created the file
No content
Failure to create the file due to permissions, file already exists, or invalid path id
No content
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/aclcurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/acl" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Colon separated path for the repository file
jmeter-test:test_file_1.xmlReturns the requested file permissions in xml or json format
Repository file access control list
Unique identifier for the ACL
acl-12345Owner of the file
adminType of owner (USER, ROLE)
0Whether ACL inherits from parent
trueWhether entries inherit
trueFile failed to be retrieved. This could be caused by an invalid path, or the file does not exist
PUT pentaho/api/repo/files/:jmeter-test:test_file_1.xml/aclcurl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/acl" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: application/json" \
-d '{"entriesInheriting":true,"id":"d45d4972-989e-48d5-8bd0-f7024a77f08f","owner":"admin","ownerType":0}'curl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/acl" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: application/xml" \
-d '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><repositoryFileAclDto><entriesInheriting>true</entriesInheriting><id>d45d4972-989e-48d5-8bd0-f7024a77f08f</id><owner>admin</owner><ownerType>0</ownerType></repositoryFileAclDto>'HTTP Basic Authentication
Colon separated path for the repository file
jmeter-test:test_file_1.xmlRepository file access control list
Unique identifier for the ACL
acl-12345Owner of the file
adminType of owner (USER, ROLE)
0Whether ACL inherits from parent
trueWhether entries inherit
trueSuccessfully saved file
No content
Failed to save acls due to malformed xml
Failed to save acls due to missing or incorrect properties
Failed to save acls due to another error
No content
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/canAccess?permissions=1curl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/canAccess?permissions=1" \
-H "Authorization: Basic YWRtaW06cGFzc3dvcmQ="trueHTTP Basic Authentication
Colon separated path for the repository file
:jmeter-test:test_file_1.xmlPipe separated list of permissions
1Successfully retrieved the permissions of the given paths
String "true" if the user has requested permissions on the file, or "false" otherwise
Unable to retrieve the permissions of the given paths due to some other error
GET pentaho/api/repo/files/:jmeter-test:test_file_1.txt/canAccessMap?permissions=1curl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.txt/canAccessMap?permissions=1" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Colon separated path for the repository file
home:admin:test_file_1.txtPipe separated permissions to be checked
1Successfully retrieved the permissions of the file
Unable to retrieve the permissions of the file due to some other error
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/download?locale=decurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/download?locale=de" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "User-Agent: Mozilla/5.0" \
-o test_file_1.xmlEncrypted file streamHTTP Basic Authentication
Colon separated path for the repository file.
:jmeter-test:test_file_1.xmltrue or false (download file with manifest). Defaults to true (include manifest) if this string can't be directly parsed to 'false' (case sensitive). This argument is only used if a directory is being downloaded.
trueA string representing the type of browser to use. Currently only applicable if contains 'FireFox' as FireFox requires a header with encoding information (UTF-8) and a quoted filename, otherwise encoding information is not supplied and the filename is not quoted.
Mozilla/5.0Successful download
Encrypted file stream
Usually a bad pathId
pathId points at a file the user doesn't have access to
File not found
Failed to download file for another reason
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/inlinecurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/inline" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<repositoryFileAclDto>
<entriesInheriting>true</entriesInheriting>
<id>d45d4972-989e-48d5-8bd0-f7024a77f08f</id>
<owner>admin</owner>
<ownerType>0</ownerType>
</repositoryFileAclDto>HTTP Basic Authentication
Colon separated path for the repository file
:jmeter-test:test_file_1.xmlSuccessfully retrieved file
The file content for inline display
Failed to retrieve file due to permission problem
Failed to retrieve file due because file was not found
Failed to download file because of some other error
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/localescurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/locales" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Colon separated path for the repository file
:jmeter-test:test_file_1.xmlSuccessfully retrieved locale information
Failed to retrieve locales because the file was not found
Unable to retrieve locales due to some other error
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/localeProperties?locale=jacurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/localeProperties?locale=ja" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Colon separated path for the repository file
:jmeter-test:test_file_1.xmlThe specified locale
jaSuccessfully retrieved locale properties
Unable to retrieve locale properties due to some other error
PUT pentaho/api/repo/files/:jmeter-test:test_file_1.xml/localeProperties?locale=jacurl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/localeProperties?locale=ja" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: application/xml" \
-d '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<stringKeyStringValueDtoes>
<stringKeyStringValueDto>
<key>file.title</key>
<value>チャート選択リスト</value>
</stringKeyStringValueDto>
<stringKeyStringValueDto>
<key>jcr:primaryType</key>
<value>nt:unstructured</value>
</stringKeyStringValueDto>
<stringKeyStringValueDto>
<key>file.description</key>
<value>複数のチャートタイプを表示します</value>
</stringKeyStringValueDto>
</stringKeyStringValueDtoes>'HTTP Basic Authentication
Colon separated path for the repository file
:jmeter-test:test_file_1.xmlA string representation of the locale to set properties on
jaSuccessfully updated locale properties
This response does not contain data
Unable to update locale properties due to some other error
PUT pentaho/api/repo/files/:jmeter-test:test_file_1.xml/deleteLocale?locale=jacurl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/deleteLocale?locale=ja" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="This response does not contain data.HTTP Basic Authentication
Colon separated path for the repository file
:jmeter-test:test_file_1.xmlA string representations of the locale to be deleted
jaSuccessfully deleted the locale
This response does not contain data
Unable to delete the locale properties due to some other error
GET pentaho/api/repo/files/:jmeter-test/childrencurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test/children" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.
:jmeter-testFilter to be applied for search. The filter can be broken down into 3 parts; File types, Child Node Filter, and Member Filters. Each part is separated with a pipe (|) character. File Types are represented by a word phrase. This phrase is recognized as a file type phrase and processed accordingly. Valid File Type word phrases include "FILES", "FOLDERS", and "FILES_FOLDERS" and denote whether to return files, folders, or both files and folders, respectively. The Child Node Filter is a list of allowed names of files separated by the pipe (|) character. Each file name in the filter may be a full name or a partial name with one or more wildcard characters ("*"). The filter does not apply to root node. The Member Filter portion of the filter parameter allows the caller to specify which properties of the metadata to return. Member Filters start with "includeMembers=" or "excludeMembers=" followed by a list of comma separated field names that are to be included in, or, excluded from, the list. Valid field names can be found in org.pentaho.platform.repository2.unified.webservices#RepositoryFileAdapter. Omission of a member filter will return all members. It is invalid to both and includeMembers= and an excludeMembers= clause in the same service call.
Include or exclude hidden files from the file list
falseInclude permission information about the file in the output
falseSuccessfully retrieved the list of child files from selected repository path of the repository
Server Error
GET pentaho/api/repo/files/:public/tree?showHidden=false&filter=*|FILES&_=1389042244670curl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:public/tree?showHidden=false&filter=*|FILES&_=1389042244670" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.
:publicHow many level should the search go.
Filter to be applied for search. The filter can be broken down into 3 parts; File types, Child Node Filter, and Member Filters. Each part is separated with a pipe (|) character.
File Types are represented by a word phrase. This phrase is recognized as a file type phrase and processed accordingly. Valid File Type word phrases include "FILES", "FOLDERS", and "FILES_FOLDERS" and denote whether to return files, folders, or both files and folders, respectively.
The Child Node Filter is a list of allowed names of files separated by the pipe (|) character. Each file name in the filter may be a full name or a partial name with one or more wildcard characters ("*"). The filter does not apply to root node.
The Member Filter portion of the filter parameter allows the caller to specify which properties of the metadata to return. Member Filters start with "includeMembers=" or "excludeMembers=" followed by a list of comma separated field names that are to be included in, or, excluded from, the list. Valid field names can be found in org.pentaho.platform.repository2.unified.webservices#RepositoryFileAdapter. Omission of a member filter will return all members. It is invalid to both and includeMembers= and an excludeMembers= clause in the same service call.
*|FILESInclude or exclude hidden files from the file list.
falseInclude permission information about the file in the output.
falseInclude system directories in the output.
falseSuccessfully retrieved the list of files from root of the repository. A RepositoryFileTreeDto object containing the files at the root of the repository. Will return files but not folders under the "/" folder. The fields returned will include the name, filesize, description, id and title.
Repository file tree structure
Invalid parameters.
Server Error.
GET pentaho/api/repo/files/canAdministercurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/canAdminister" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
Successfully returns a boolean value, either true or false
String "true" if the user can administer the platform, or "false" otherwise.
Successfully returns a boolean value, either true or false
GET pentaho/api/repo/files/canCreatecurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/canCreate" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
Successfully returns true or false depending on the users permissions
String "true" if the user can create new content, or "false" otherwise.
Successfully returns true or false depending on the users permissions
GET pentaho/api/repo/files/reservedCharacterscurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/reservedCharacters" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
Successfully returns a list of repositroy reserved characters
List of characters that are reserved by the repository.
Successfully returns a list of repositroy reserved characters
GET pentaho/api/repo/files/reservedCharactersDisplaycurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/reservedCharactersDisplay" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
Successfully returns a list of repositroy reserved characters
List of characters that are reserved by the repository.
Successfully returns a list of repositroy reserved characters
GET pentaho/api/repo/files/canEditcurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/canEdit" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
Successfully returns true or false depending on the users permissions
String "true" if the user can edit existing content, or "false" otherwise.
Successfully returns true or false depending on the users permissions
PUT pentaho/api/repo/files/:jmeter-test:test_file_1.xml/rename?newName=test_file_8curl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/rename?newName=test_file_8" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.
:jmeter-test:test_file_1.xmlString indicating the new name of the file.
test_file_8Successfully renamed file.
Response with 200 OK, if the file does not exist to be renamed the response will return 200 OK with the string "File to be renamed does not exist".
Forbidden.
File not found.
GET pentaho/api/repo/files/propertiescurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/properties" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Successfully retrieved the properties of the root directory.
Repository file data transfer object
Unique identifier for the file
12345-abcdeName of the file
report.prptFull path to the file
/home/admin/report.prptWhether this is a folder
falseWhether this file is hidden
falseWhether this file is versioned
trueWhether this file is locked
falseSize of the file in bytes
1024When the file was created
2023-01-01T12:00:00ZWhen the file was last modified
2023-01-02T12:00:00ZType of owner (USER, ROLE)
0Title of the file
Sales ReportDescription of the file
Monthly sales reportWhen the file was deleted (if applicable)
2023-01-03T12:00:00ZLocale of the file
enOriginal parent folder path before deletion
/original/path/to/fileVersion identifier of the file
1.3Unable to retrieve the properties of the root directory due to file not found error.
Unable to retrieve the properties of the root directory due to some other error.
GET pentaho/api/repo/files/:/propertiescurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/home:admin:report.prpt/properties" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Colon separated path for the repository file.
home:admin:report.prptSuccessfully retrieved the properties for a file.
Repository file data transfer object
Unique identifier for the file
12345-abcdeName of the file
report.prptFull path to the file
/home/admin/report.prptWhether this is a folder
falseWhether this file is hidden
falseWhether this file is versioned
trueWhether this file is locked
falseSize of the file in bytes
1024When the file was created
2023-01-01T12:00:00ZWhen the file was last modified
2023-01-02T12:00:00ZType of owner (USER, ROLE)
0Title of the file
Sales ReportDescription of the file
Monthly sales reportWhen the file was deleted (if applicable)
2023-01-03T12:00:00ZLocale of the file
enOriginal parent folder path before deletion
/original/path/to/fileVersion identifier of the file
1.3Invalid file path.
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/metadatacurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/home:admin:report.prpt/metadata" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.
:jmeter-test:test_file_1.xmlSuccessfully retrieved metadata.
Invalid path.
Server Error.
PUT pentaho/api/repo/files/:jmeter-test:test_file_1.xml/metadatacurl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/metadata" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: application/json" \
-d '{
"stringKeyStringValueDtoes": [
{
"key": "metadata.key.1",
"value": "metadata.value.1"
}
]
}'HTTP Basic Authentication
The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.
:jmeter-test:test_file_1.xmlSuccessfully retrieved metadata.
No content
Invalid payload.
Invalid path.
Server Error.
No content
PUT pentaho/api/repo/files/:public:jmeter-test-dir/createDircurl -X PUT \
"http://localhost:8080/pentaho/api/repo/files/:public:jmeter-test-dir/createDir" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.
:public:jmeter-test-dirSuccessfully created folder.
No content
Forbidden.
Path already exists.
Server Error.
No content
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/generatedContent?locale=decurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/generatedContent?locale=de" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Colon separated path for the destination for files to be copied.
:jmeter-test:test_file_1.xmlSuccessfully retrieved the list of RepositoryFileDto objects.
Wrapper for list of repository files
Successfully retrieved the list of RepositoryFileDto objects.
GET pentaho/api/repo/files/:jmeter-test:test_file_1.xml/generatedContentForUser?user=admincurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/:jmeter-test:test_file_1.xml/generatedContentForUser?user=admin" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Colon separated path for the destination for files to be copied.
:jmeter-test:test_file_1.xmlThe username for the generated content folder.
adminSuccessfully retrieved the list of RepositoryFileDto objects.
Wrapper for list of repository files
Server Error.
GET pentaho/api/repo/files/canDownloadcurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/canDownload" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
to be validated for download action for the current user.
""Returns a boolean response.
Returns a boolean response.
GET pentaho/api/repo/files/canUploadcurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/canUpload" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="HTTP Basic Authentication
to be validated for upload action for the current user.
""Returns a boolean response.
Returns a boolean response.
GET pentaho/api/repo/files/children?showHidden=false&filter=*|FILES&_=1389042244670curl -X GET \
"http://localhost:8080/pentaho/api/repo/files/children?showHidden=false&filter=*|FILES" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Filter to be applied for search. The filter can be broken down into 3 parts; File types, Child Node Filter, and Member Filters. Each part is separated with a pipe (|) character.
File Types are represented by a word phrase. This phrase is recognized as a file type phrase and processed accordingly. Valid File Type word phrases include "FILES", "FOLDERS", and "FILES_FOLDERS" and denote whether to return files, folders, or both files and folders, respectively.
The Child Node Filter is a list of allowed names of files separated by the pipe (|) character. Each file name in the filter may be a full name or a partial name with one or more wildcard characters ("*"). The filter does not apply to root node.
The Member Filter portion of the filter parameter allows the caller to specify which properties of the metadata to return. Member Filters start with "includeMembers=" or "excludeMembers=" followed by a list of comma separated field names that are to be included in, or, excluded from, the list. Valid field names can be found in org.pentaho.platform.repository2.unified.webservices#RepositoryFileAdapter. Omission of a member filter will return all members. It is invalid to both and includeMembers= and an excludeMembers= clause in the same service call.
*|FILESInclude or exclude hidden files from the file list.
falseInclude permission information about the file in the output.
falseSuccessfully retrieved the list of child files from root of the repository.
Wrapper for list of repository files
Server Error.
GET pentaho/api/repo/files/deletedcurl -X GET \
"http://localhost:8080/pentaho/api/repo/files/deleted" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
Successfully retrieved the list of files from trash folder of the repository.
Wrapper for list of repository files
Server Error.
POST pentaho/api/repo/files/pathsAccessListcurl -X POST \
"http://localhost:8080/pentaho/api/repo/files/pathsAccessList" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: application/json" \
-d '{
"strings": ["/public", "/home/admin", "/etc"]
}'curl -X POST \
"http://localhost:8080/pentaho/api/repo/files/pathsAccessList" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Content-Type: application/xml" \
-d '<?xml version="1.0" encoding="UTF-8"?>
<stringListWrapper>
<strings>/public</strings>
<strings>/home/admin</strings>
<strings>/etc</strings>
</stringListWrapper>'HTTP Basic Authentication
Wrapper for list of strings
List of strings
["item1","item2","item3"]Successfully retrieved the permissions of the given paths.
Unable to retrieve the permissions of the given paths due to some other error.
GET pentaho/api/repo/files/tree?showHidden=false&filter=*|FILES&_=1389042244670curl -X GET \
"http://localhost:8080/pentaho/api/repo/files/tree?showHidden=false&filter=*|FILES" \
-H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
-H "Accept: application/json"HTTP Basic Authentication
How many level should the search go.
Filter to be applied for search. The filter can be broken down into 3 parts; File types, Child Node Filter, and Member Filters. Each part is separated with a pipe (|) character.
File Types are represented by a word phrase. This phrase is recognized as a file type phrase and processed accordingly. Valid File Type word phrases include "FILES", "FOLDERS", and "FILES_FOLDERS" and denote whether to return files, folders, or both files and folders, respectively.
The Child Node Filter is a list of allowed names of files separated by the pipe (|) character. Each file name in the filter may be a full name or a partial name with one or more wildcard characters ("*"). The filter does not apply to root node.
The Member Filter portion of the filter parameter allows the caller to specify which properties of the metadata to return. Member Filters start with "includeMembers=" or "excludeMembers=" followed by a list of comma separated field names that are to be included in, or, excluded from, the list. Valid field names can be found in org.pentaho.platform.repository2.unified.webservices#RepositoryFileAdapter. Omission of a member filter will return all members. It is invalid to both and includeMembers= and an excludeMembers= clause in the same service call.
*|FILESInclude or exclude hidden files from the file list.
falseInclude permission information about the file in the output.
falseSuccessfully retrieved the list of files from root of the repository. A RepositoryFileTreeDto object containing the files at the root of the repository. Will return files but not folders under the "/" folder. The fields returned will include the name, filesize, description, id and title.
Repository file tree structure
Invalid parameters.
Server Error.
Last updated
Was this helpful?