97 lines
4.2 KiB
Bash
97 lines
4.2 KiB
Bash
# encoding: utf-8
|
|
#
|
|
# Redmine plugin for Document Management System "Features"
|
|
#
|
|
# Copyright © 2011-19 Karel Pičman <karel.picman@kontron.com>
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License
|
|
# as published by the Free Software Foundation; either version 2
|
|
# of the License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
#!/bin/bash
|
|
|
|
# Authentication as input parameters either as login + password or the API key
|
|
# -u ${1}:${2}
|
|
# -H "X-Redmine-API-Key: ${1}"
|
|
|
|
# BOTH XML and JSON formats are supported.
|
|
# Just replace .xml with .json
|
|
#
|
|
# Uncomment a corresponding line to the case you would like to test
|
|
|
|
# 1. List of documents in a given folder or the root folder
|
|
#curl -v -H "Content-Type: application/xml" -X GET -u ${1}:${2} http://localhost:3000/projects/12/dmsf.xml
|
|
#curl -v -H "Content-Type: application/xml" -X GET -u ${1}:${2} http://localhost:3000/projects/12/dmsf.xml?folder_id=5155
|
|
#curl -v -H "Content-Type: application/xml" -X GET -u ${1}:${2} "http://localhost:3000/projects/12/dmsf.xml?limit=2&offset=1"
|
|
|
|
# 2. Get a document
|
|
#curl -v -H "Content-Type: application/xml" -X GET -u ${1}:${2} http://localhost:3000/dmsf/files/17216.xml
|
|
#curl -v -H "Content-Type: application/octet-stream" -X GET -u ${1}:${2} http://localhost:3000/dmsf/files/41532/download > file.txt
|
|
|
|
# 3. Create a folder
|
|
#curl -v -H "Content-Type: application/xml" -X POST --data "@folder.xml" -u ${1}:${2} http://localhost:3000/projects/12/dmsf/create.xml
|
|
|
|
# 4. Upload a document into a given folder or the root folder
|
|
#curl --data-binary "@cat.gif" -H "Content-Type: application/octet-stream" -X POST -u ${1}:${2} http://localhost:3000/projects/12/dmsf/upload.xml?filename=cat.gif
|
|
#curl -v -H "Content-Type: application/xml" -X POST --data "@file.xml" -u ${1}:${2} http://localhost:3000/projects/12/dmsf/commit.xml
|
|
|
|
# 5. List folder content & check folder existence (by folder title)
|
|
# curl -v -H "Content-Type: application/json" -X GET -H "X-Redmine-API-Key: USERS_API_KEY" http://localhost:3000/projects/1/dmsf.json?folder_title=Updated%20title
|
|
|
|
# 6. List folder content & check folder existence (by folder id)
|
|
# curl -v -H "Content-Type: application/json" -X GET -H "X-Redmine-API-Key: USERS_API_KEY" http://localhost:3000/projects/1/dmsf.json?folder_id=3
|
|
# both returns 404 not found, or json with following structure:
|
|
# {
|
|
# "dmsf":{
|
|
# "dmsf_folders":[
|
|
#
|
|
# ],
|
|
# "total_count":0,
|
|
# "dmsf_files":[
|
|
#
|
|
# ],
|
|
# "dmsf_links":[
|
|
#
|
|
# ],
|
|
# "found_folder":{
|
|
# "id":3,
|
|
# "title":"Updated title"
|
|
# }
|
|
# }
|
|
#}
|
|
|
|
# 7. Update a folder
|
|
# curl -v -H "Content-Type: application/json" -X POST --data "@update-folder-payload.json" -H "X-Redmine-API-Key: USERS_API_KEY" http://localhost:3000//projects/#{project_id}/dmsf/save.json?folder_id=#{folder_id}
|
|
|
|
# update-folder-payload.json
|
|
# {
|
|
# "dmsf_folder": {
|
|
# "title": title,
|
|
# "description": description
|
|
# },
|
|
# }
|
|
|
|
# 8. Delete a folder
|
|
# a) Move to trash only
|
|
# curl -v -H "Content-Type: application/xml" -X DELETE -u ${1}:${2} http://localhost:3000/projects/2387/dmsf/delete.xml?folder_id=#{folder_id}
|
|
# b) Delete permanently
|
|
# curl -v -H "Content-Type: application/xml" -X DELETE -u ${1}:${2} "http://localhost:3000/projects/2387/dmsf/delete.xml?folder_id=#{folder_id}&commit=yes"
|
|
|
|
# 9. Delete a file
|
|
# a) Move to trash only
|
|
# curl -v -H "Content-Type: application/xml" -X DELETE -u ${1}:${2} http://localhost:3000/dmsf/files/196118.xml
|
|
# b) Delete permanently
|
|
# curl -v -H "Content-Type: application/xml" -X DELETE -u ${1}:${2} http://localhost:3000/dmsf/files/196118.xml?commit=yes"
|
|
|
|
# 10. Create a symbolic link
|
|
# curl -v -H "Content-Type: application/xml" -X POST --data "@link.xml" -H "X-Redmine-API-Key: USERS_API_KEY" http://localhost:3000/dmsf_links.xml |