Versions Compared

Old Version 4

changes.mady.by.user Vincent Thoulé

Saved on

compared with

New Version 5

changes.mady.by.user Vincent Thoulé

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Alkaes JIRA Plugin Field Administration Enhanced  provides some additional API to list files on File System

List File System

Goal : Allows to list files on JIRA side. The path is 

Usage : This API is reserved to Jira System Administrator.

API
  • /rest/extendedAdmin/1.0/filesystem
  • /rest/extendedAdmin/1.0/filesystem/${rootPath}
MethodGET
Params

Params

KeyTypeDescription
rootPathStringFile Path to list. Default path is the current directory (<jiraInstall>/bin)
levelLongNb of level of read sub-folders 
expandString

Specifies the attributes expanded in return JSON :

  • self : Self URL for related read folder
  • isDirectory : append is read element is a directory


Return

FileBean returned :

KeyTypeDescription
filePathStringPath of current File
isDirectorybooleanIs current File is a folder or not (if expand=isDirectory)
selfURIURI for current element
filesList<FileBean>List of FileBean for next level


Return Code

Status
colourGreen
title200
: All changes performed without issue.

Status
colourRed
title401
: Access not authorized to current user.

Status
colourRed
title500
: Internal Server Error.



Excerpt
hiddentrue

Theses APIs allow you to navigate in File System.


Panel

Not yet documented ...

On this page:

Table of Contents