Swagger Sample
A sample swagger server
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
get /templatefolderspost /templatefoldersget /templatefolders/{folderId}put /templatefolders/{folderId}delete /templatefolders/{folderId}get /templatefolders/{folderId}/templatesget /templatefolders/{folderId}/templates/{templateId}get /templatefolders/{folderId}/templates/{templateId}/graphicimagesget /templatefolders/{parentFolderId}/subfolderspost /templatefolders/{parentFolderId}/subfolders
Lists all folders used for templates. (getAllFolders)
Returns all folders.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
500
Internal server error while fetching folders
404
There are no folders
Creates a new folder. (createFolder)
Returns a URI of the newly created folder in the response header with the name 'Location'.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The folder object that needs to be created.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Folder created successfully
401
User is not an administrator. Unauthorized request.
500
Internal server error while creating new folder.
Up
get /templatefolders/{folderId}
Finds a folder by ID. (getFolder)
Returns a single folder.
Path parameters
folderId (required)
Path Parameter — The ID of a folder.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
401
User is not an administrator. Unauthorized request.
500
Internal server error while fetching folder data.
404
Folder not found
Up
put /templatefolders/{folderId}
Updates an existing folder. (updateFolder)
Returns 204 status if the update is successful.
Path parameters
folderId (required)
Path Parameter — The ID of a folder.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The folder object that needs to be updated.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
401
User is not an administrator. Unauthorized request.
500
Internal server error while updating folder.
204
Folder updated successfully
404
Folder not found
Up
delete /templatefolders/{folderId}
Deletes an existing folder. (deleteFolder)
Returns 204 status if the delete is successful.
Path parameters
folderId (required)
Path Parameter — The ID of a folder.
Responses
401
User is not an administrator. Unauthorized request.
500
Internal server error while deleting folder.
204
Folder deleted successfully
404
Folder not found
Up
get /templatefolders/{folderId}/templates
Lists all templates for the specified template type. (getAllTemplates)
Returns all templates
Path parameters
folderId (required)
Path Parameter — ID of a folder
Query parameters
templateType (optional)
Query Parameter — The type of a template.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
500
Internal server error while fetching templates
404
There are no templates
Up
get /templatefolders/{folderId}/templates/{templateId}
Finds a template by the specified ID. (getTemplate)
Returns a single template.
Path parameters
folderId (required)
Path Parameter — ID of a folder
templateId (required)
Path Parameter — The ID of a template.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
500
Internal server error while fetching templates data.
404
Template not found
Up
get /templatefolders/{folderId}/templates/{templateId}/graphicimages
Returns graphic image of template id passed. (getTemplateGraphics)
Returns file attachment in original format.
Path parameters
folderId (required)
Path Parameter — ID of a folder
templateId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
400
Bad request due to decoding the data
422
Invalid data is provided in the request.
401
User doesn't have permission to do this action
500
Internal server error while retrieving data
404
No graphics found
Up
get /templatefolders/{parentFolderId}/subfolders
Gets subfolders from the parent folder. (getAllSubFolders)
Returns a list of folder objects.
Path parameters
parentFolderId (required)
Path Parameter — The ID of the parent folder.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
500
Internal server error while retrieving sub folders from parent folder.
404
Sub Folders not found in parent folder or parent folder not found
Up
post /templatefolders/{parentFolderId}/subfolders
Creates a subfolder under the parent folder. (createSubFolder)
Returns a URI of the newly created folder in the response header with the name 'Location'.
Path parameters
parentFolderId (required)
Path Parameter — The ID of the parent folder.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The folder object that needs to be created.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Sub Folder created successfully in parent folder
401
User is not an administrator. Unauthorized request.
500
Internal server error while creating sub folders in parent folder.
404
Parent folder not found
[ Jump to Methods ]
Table of Contents
ResponseTabVOFolderVOTemplateVO
entity
Object
metadata
javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>
status
Integer
Form_ID
Integer Form ID
Form_Name
String Form Name
Tab_Name
String Tab Name
folderId
Integer
folderName
String
description
String Description of folder
parentId
Integer Folder Name
folderType
String Type of folder. Can be template or form or Attachment
hasAttachments
Boolean
Template_ID
Integer Template ID
Template_Name
String Template Name
Template_Description
String Template Description
Display_Name
String Template Display Name
Security_Policy
array[String] Security Policies
Data_Source
String Data Source
Custom_Validation_Class_Name
String Custom Validation Class Name
ID_Prefix
String Template ID Prifix
Template_Tabs
array[TabVO] Tabs
Template_Type
String Type of template
Template_SubType
String Template sub type
Template_Graphics
String Template Graphics