Swagger Sample

A sample swagger server
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

  1. get /templates
  2. get /templates/{templateId}
  3. get /templates/{templateId}/graphicimages
Up 
get /templates
Lists all templates for the specified template type. (getAllTemplates)
Returns all templates

Query parameters

templateType (optional)
Query Parameter — The type of a template.

Produces

This API call produces the following media types according to the Accept 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 /templates/{templateId}
Finds a template by the specified ID. (getTemplate)
Returns a single template.

Path parameters

templateId (required)
Path Parameter — The ID of a template.

Produces

This API call produces the following media types according to the Accept 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 /templates/{templateId}/graphicimages
Returns graphic image of template id passed. (getTemplateGraphics)
Returns file attachment in original format.

Path parameters

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 Accept 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

Models

[ Jump to Methods ]

Table of Contents

  1. Response
  2. TabVO
  3. TemplateVO

Response Up

entity
Object
metadata
javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>
status
Integer

TabVO Up

Form_ID
Integer Form ID
Form_Name
String Form Name
Tab_Name
String Tab Name

TemplateVO Up

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