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 /listspost /listsput /lists/searchget /lists/{projectId}put /lists/{projectId}get /lists/{projectId}/attachmentfoldersget /lists/{projectId}/attachmentfolders/{folderId}get /lists/{projectId}/attachmentspost /lists/{projectId}/attachmentsget /lists/{projectId}/attachments/{attachmentId}delete /lists/{projectId}/attachments/{attachmentId}put /lists/{projectId}/changestateget /lists/{projectId}/memberspost /lists/{projectId}/membersdelete /lists/{projectId}/members/{userIds}get /lists/{projectId}/projectformsget /lists/{projectId}/projectforms/{formId}put /lists/{projectId}/projectforms/{formId}get /lists/{projectId}/projectuserspost /lists/{projectId}/runget /lists/{projectId}/run/{jobId}
Lists all simple Lists. (getAllComponents)
Returns a list of details of simple Lists in JSON format.
The number of instances returend is governed by Range parameter. The default range is set to 0-10.
This corresponds to offset-pageSize, for example 10-4 will return components starting from 10 to 14.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
status (optional)
Query Parameter — The status of a simple List.
templateName (optional)
Query Parameter — The template name.
owner (optional)
Query Parameter — The owner of a simple List.
startDate (optional)
Query Parameter — The start date of a simple List in the format yyyy-MM-dd.
endDate (optional)
Query Parameter — The end date of a simple List in the format yyyy-MM-dd.
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
422
Invalid data is provided in the request.
401
User doesn't have permission to view list of Simple Lists. Unauthorized request.
500
Internal server error while fetching Simple List Component data.
404
Simple Lists are not found
Creates a new Simple List campaign. (createComponent)
Returns a URI of the newly created Simple List in the response header. Properties 'Template_DB_ID' and 'Project_Name' are required in JSON to create a new Simple List.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The Details of a project that need to be created. Refer ComponentVO model.
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
Simple List Campaign created successfully
422
Invalid data is provided in the request.
401
User doesn't have permission to create Simple List Campaign. Unauthorized request.
500
Internal server error while creating new Simple List Campaign.
Searches components using standard component attributes such as uap_projects.type,uap_projects.state_code . (searchComponent)
Provide only standard attribute properties, see #SearchVO & #SearchCriteriaVO for more details.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter —
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
422
Invalid data is provided in the request.
401
User doesn't have permission to update stanadard attributes of a Advanced List. Unauthorized request
500
Internal server error while updaing standard attributes of a Advanced List.
204
Standard attributs of a Advanced List is updated successfully
404
Advanced List with given project_id is not found
Up
get /lists/{projectId}
Finds a simple List by specified project ID (getComponent)
Fetches a simple List by using the project ID.
Path parameters
projectId (required)
Path Parameter — The project ID.
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
422
Invalid data is provided in the request.
401
User doesn't have permission to view summary tab of simple list. Unauthorized request.
500
Internal server error while fetching Simple List data.
404
No Simple List found
Up
put /lists/{projectId}
Updates the standard attributes of a Simple List campaign. (updateComponent)
Provide only standard attribute properties (Project_Name, Description, Start_Date, End_Date, Security_Policy) in JSON with valid values
Path parameters
projectId (required)
Path Parameter — The project ID of a Simple List campaign.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The standard attributes and its values in JSON format. Refer ComponentVO model.
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
422
Invalid data is provided in the request.
401
User doesn't have permission to update stanadard attributes of a Simple List Campaign. Unauthorized request
500
Internal server error while updaing standard attributes of a Simple List Campaign.
204
Standard attributs of a Simple List Campaign is updated successfully
404
Simple List campaign with given project_id is not found
Up
get /lists/{projectId}/attachmentfolders
Lists all attachment folders from a project. (getAllFolders)
Returns details of all folders in JSON format.
Path parameters
projectId (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
422
Invalid data is provided in the request.
401
User doesn't have permission to do this action.
500
Internal server error while retrieving attachment task and stage data
404
Folder has no tasks and stages. It is empty
Up
get /lists/{projectId}/attachmentfolders/{folderId}
Returns details of folders on the given folderID. (getAttachmentFolder)
Returns details of folder .
Path parameters
projectId (required)
Path Parameter —
folderId (required)
Path Parameter — The folder Id .
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 such folder found
Up
get /lists/{projectId}/attachments
Lists all attachments from a project. (getAllAttachments)
Returns details of all attachments and folders in JSON format.
Path parameters
projectId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
type (optional)
Query Parameter — The type of attachment.
folderId (optional)
Query Parameter — folderId
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
422
Invalid data is provided in the request.
401
User doesn't have permission to do this action.
500
Internal server error while retrieving attachment task and stage data
404
Attachment has no tasks and stages. It is empty
Up
post /lists/{projectId}/attachments
Saves attachment based on attachment file passed (saveAttachment)
Attachement VO that contains information about file saved
Path parameters
projectId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
file (optional)
Form Parameter —
folderid (optional)
Form Parameter —
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 attachment found
Up
get /lists/{projectId}/attachments/{attachmentId}
Returns file attachment based on attachment id passed. (getAttachment)
Returns file attachment in original format.
Path parameters
projectId (required)
Path Parameter —
attachmentId (required)
Path Parameter — The Attachment Id .
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 such attachment found
Up
delete /lists/{projectId}/attachments/{attachmentId}
Deletes file attachment based on attachment id passed. (deleteAttachment)
Path parameters
projectId (required)
Path Parameter —
attachmentId (required)
Path Parameter — The Attachment Id .
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
attachment is found
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 such attachment found
Up
put /lists/{projectId}/changestate
Updates the status of a Simple List campaign. (changeStateOfProject)
Provide only 'Project_Status' property in JSON with allowable action (START, CANCEL, CONTINUE, PAUSE, FINISH) to change status of the project.
Path parameters
projectId (required)
Path Parameter — The project ID of a Simple List campaign.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The New action to change the state of a project in JSON format.
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
422
Invalid data is provided in the request.
401
User doesn't have permission to update status of a Simple Campaign. Unauthorized request
500
Internal server error while updaing standard attributes of a Simple Campaign.
204
Status a Simple Campaign is updated successfully
404
Simple campaign with given project_id is not found
Up
get /lists/{projectId}/members
Lists of all members that are part a project instance. (getAllMembers)
Lists of all members that are part a project instance.
Path parameters
projectId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
accessType (optional)
Query Parameter —
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
422
Invalid data is provided in the request.
401
User doesn't have permission to view list of members. Unauthorized request.
500
Internal server error while fetching users.
404
Members not found for the project
Up
post /lists/{projectId}/members
Updates members of the project instance. (addOrUpdateMembers)
Updates members for the given project instance, based on configured visibility. .
Path parameters
projectId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter —
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
Member list updated successfully
422
Invalid data is provided in the request.
401
User doesn't have permission to update members. Unauthorized request.
500
Internal server error while creating new Simple List Campaign.
Up
delete /lists/{projectId}/members/{userIds}
Deletes given members from the project instance (removeMember)
Deletes given members from the project instance, accepts member ID of the member to be deleted.
Path parameters
projectId (required)
Path Parameter —
userIds (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
201
Member deleted from project instance successfully
422
Invalid data is provided in the request.
401
User doesn't have permission to delete members. Unauthorized request.
500
Internal server error while creating new Simple List Campaign.
Up
get /lists/{projectId}/projectforms
Lists all forms associated with a project. (getAllComponentForms)
Returns details of all form objects.
Path parameters
projectId (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
401
User doesn't have permission to do this action
500
Internal server error while fetching data.
404
There is no such form associated with the project
Up
get /lists/{projectId}/projectforms/{formId}
Gives details about a form and the current values of custom attributes. (getFormDetails)
Returns a custom attribute form object with current values of user variable attributes and offer attributes.
Path parameters
projectId (required)
Path Parameter —
formId (required)
Path Parameter — The form ID.
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
422
Invalid data is provided in the request.
401
User doesn't have permission to do this action
500
Internal server error while fetching data.
404
There are no form associated with project with given form ID
Up
put /lists/{projectId}/projectforms/{formId}
Updates values of custom attributes and offers. (updateFormAttributes)
'Attribute_Name' and 'Attribute_Values' are required properties while updating Custom Attributes(User Variables).
Path parameters
projectId (required)
Path Parameter —
formId (required)
Path Parameter — The form ID.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The attribute name and values in JSON format. Refer ComponentFormVO, ComponentFormAttributeVO and ComponentOfferVO models.
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
422
Invalid data is provided in the request.
401
User doesn't have permission to do this action
500
Internal server error while fetching data.
204
Update has been successful
404
There is no form associated with project of given form id
Up
get /lists/{projectId}/projectusers
Lists all Groups/Users that can be added in a project instance. (getAllMembers_1)
Lists all Groups/Users that can be added in a project instance.
Path parameters
projectId (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
422
Invalid data is provided in the request.
401
User doesn't have permission to view list of users. Unauthorized request.
500
Internal server error while fetching users.
404
Users/Groups are not found
Up
post /lists/{projectId}/run
Runs a flowchart. (runFlowchart)
This operation does not require any body in request. Retuns a URI with Job ID in response header 'Location' when the flowchart run is successful.
Path parameters
projectId (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
201
Flowchart has run successfully
422
Invalid data is provided in the request.
401
User does not have permission to this action. Unauthorized request
500
Internal server error while running flowchart
404
No task found with given task ID
Up
get /lists/{projectId}/run/{jobId}
Gives run results of the flowchart run by using the job ID. (getRunResults)
Returns details of result of the flowchart run in JSON format.
Path parameters
projectId (required)
Path Parameter —
jobId (required)
Path Parameter — The Job ID.
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
422
Invalid data is provided in the request.
401
User doesn't have permission to this action. Unauthorized request
500
Internal server error while fetching flowchart run results
404
No run results found with given job ID
[ Jump to Methods ]
Table of Contents
FolderVOPathSegmentSearchCriteriaVOAttachmentVOGroupVOComponentFormVOResponseRunResultVOComponentVOSearchVOUserVOMemberVOMapFile
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
matrixParameters
javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>
path
String
operator
String Operator
ANY
IN
NOT_IN
NOT_LIKE
LIKE
NOT_EQUAL_TO
EQUAL_TO
value
array[String] Value
attribute_name
String Attribute Name
attribute_type
String Attribute Type
attribute_data_type
String Attribute Data Type
attachmentId
Integer
fileName
String
mimeType
String
size
Integer
description
String
type
String
parentID
Integer
folderID
Integer
attachedFile
File
subGroups
array[GroupVO] Groups Object
groupId
Integer Group Id
groupName
String Group Name
user
array[UserVO] User Object
Form_ID
Integer Form ID
Form_Name
String Form Name
Tab_Name
String Tab Name
User_Variables
array[Array] User Variables
Out_Variables
array[Array] Out Variables
Offers
array[Array] Offers
entity
Object
metadata
javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>
status
Integer
Run_ID
Integer Flowchart Run ID
Flowchart_Status
String Flowchart Status
CAMPAIGN_ERROR
CANT_RUN_TASK
FINISHED
GET_RESULT_ERROR
INVALID_PROJECT_STATENOT_STARTED
QUEUED
RETRY_ERROR
RUN_ERROR
RUNNING
STARTING
STOPPED
Status_Code
String Run Status Code
Status_Message
String Run Status Messsage
Start_Date
String Flowchart Start Date
End_Date
String Flowchart End Date
Count
Long Count
Output_Parameters
Map Output Parameters
Input_Variables
array[Array] Input Parameters
Output_Variables
array[Array] Output Variables
Project_ID
Integer Project ID
Project_Name
String Name of Project
Project_Type
String Type of Project
ALL_TYPE
PROJECT
LIST
LOCAL
CORPORATE
Project_SubType
String Type of Project
ADVANCED
SIMPLE
Description
String Project Description
Template_Name
String Template Name
Template_DB_ID
Integer Template DB ID
Project_Status
String Status of Project
NOT_STARTED
IN_PROGRESS
ON_HOLD
COMPLETED
CANCELLED
Start_Date
Date Project start date
End_Date
Date Project end date
Security_Policy
String Security policy
Project_Code
String Generated code of project
Created_By
UserVO Created By
Forms
array[Array] Forms and Custom Attributes
Creation_Date
Date Creation Date
Last_Modified_By
UserVO Last Modified By
Last_Modified_Date
Date Last Modified Date
project_type
String Search Project Type
LOCAL
LIST
ADVANCED_LIST
CORPORATE
criteria
array[SearchCriteriaVO]
condition
String Criteria Condition
ANY
IN
NOT_IN
NOT_LIKE
LIKE
NOT_EQUAL_TO
EQUAL_TO
User_ID
String User ID
User_Name
String Login Name
First_Name
String First Name
Last_Name
String Last Name
Email_ID
String Email ID
user
UserVO User Object
accessLevel
String Access Level
path
String
name
String
parent
String
parentFile
File
absolute
Boolean
absolutePath
String
absoluteFile
File
canonicalPath
String
canonicalFile
File
directory
Boolean
file
Boolean
hidden
Boolean
totalSpace
Long
freeSpace
Long
usableSpace
Long