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 /advlists
  2. post /advlists
  3. put /advlists/search
  4. get /advlists/{projectId}
  5. put /advlists/{projectId}
  6. get /advlists/{projectId}/attachmentfolders
  7. get /advlists/{projectId}/attachmentfolders/{folderId}
  8. get /advlists/{projectId}/attachments
  9. post /advlists/{projectId}/attachments
  10. get /advlists/{projectId}/attachments/{attachmentId}
  11. delete /advlists/{projectId}/attachments/{attachmentId}
  12. put /advlists/{projectId}/changestate
  13. get /advlists/{projectId}/members
  14. post /advlists/{projectId}/members
  15. delete /advlists/{projectId}/members/{userIds}
  16. get /advlists/{projectId}/projectforms
  17. get /advlists/{projectId}/projectforms/{formId}
  18. put /advlists/{projectId}/projectforms/{formId}
  19. get /advlists/{projectId}/projectusers
  20. get /advlists/{projectId}/recurrence
  21. put /advlists/{projectId}/recurrence
  22. get /advlists/{projectId}/workflowrows
  23. get /advlists/{projectId}/workflowrows/{folderId}
  24. get /advlists/{projectId}/workflowrows/{rowId}
  25. put /advlists/{projectId}/workflowrows/{rowId}
  26. get /advlists/{projectId}/workflowrows/{rowId}/attachments
  27. post /advlists/{projectId}/workflowrows/{rowId}/attachments
  28. get /advlists/{projectId}/workflowrows/{rowId}/attachments/{attachmentId}
  29. delete /advlists/{projectId}/workflowrows/{rowId}/attachments/{attachmentId}
  30. post /advlists/{projectId}/workflowrows/{rowId}/run
  31. get /advlists/{projectId}/workflowrows/{rowId}/run/{jobId}
Up
get /advlists
Lists all Advanced Lists. (getAllComponents)
Returns a list of details of Advanced 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.

Query parameters

status (optional)
Query Parameter — The status of an Advanced List.
templateName (optional)
Query Parameter — The template name.
owner (optional)
Query Parameter — The owner of an Advanced List.
startDate (optional)
Query Parameter — The start date of an Advanced List in the format yyyy-MM-dd.
endDate (optional)
Query Parameter — The end date of an Advanced List in the format yyyy-MM-dd.

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

422

Invalid data is provided in the request.

401

User doesn't have permission to view list of Advanced lists. Unauthorized request.

500

Internal server error while fetching Advance List Component data.

404

Advanced Lists are not found

Up
post /advlists
Creates a new Advanced List. (createComponent)
Returns a URI of the newly created Advanced List in the response header. Properties 'Template_DB_ID' and 'Project_Name' are required in JSON to create a new Advanced 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 an Advanced List that needs to be created in JSON format. Refer ComponentVO model.

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

201

Advacned List created successfully

422

Invalid data is provided in the request.

401

User doesn't have permission to create Advacned List. Unauthorized request.

500

Internal server error while creating new Advacned List.

404

The template which is used for creating Advanced list is not available.

Up
put /advlists/search
Updates the standard attribute values of an Advanced List. (searchComponent)
Provide only standard attribute properties (Project_Name, Description, Start_Date, End_Date, Security_Policy) in JSON with valid values

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 Accept 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 /advlists/{projectId}
Finds an Advanced List. (getComponent)
Fetches an Advanced List by using the project ID.

Path parameters

projectId (required)
Path Parameter — The project ID.

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

422

Invalid data is provided in the request.

401

User doesn't have permission to view summary tab a Advanced list. Unauthorized request.

500

Internal server error while fetching Advace List data.

404

No Advace List found

Up
put /advlists/{projectId}
Updates the standard attribute values of an Advanced List. (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 an Advanced List.

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 Accept 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 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 /advlists/{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 Accept 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 /advlists/{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 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 such folder found

Up
get /advlists/{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 Accept 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 /advlists/{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 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 attachment found

Up
get /advlists/{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 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 such attachment found

Up
delete /advlists/{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 .

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 /advlists/{projectId}/changestate
Updates the status of an Advanced List. (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 an Advanced List.

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 Accept 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 Advanced List. Unauthorized request

500

Internal server error while updaing standard attributes of a Advanced List.

204

Status a Advanced List is updated successfully

404

Advanced List with given project_id is not found

Up
get /advlists/{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

Query parameters

accessType (optional)
Query Parameter

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

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 /advlists/{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

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 /advlists/{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

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 /advlists/{projectId}/projectforms
Lists all forms associated with a project. (getAllComponentForms)
Returns details of all form objects.

Path parameters

projectId (required)
Path Parameter

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

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 /advlists/{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.

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

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 /advlists/{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 Accept 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 /advlists/{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

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

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
get /advlists/{projectId}/recurrence
Lists recurrence settings of a project. (getRecurrenceSettings)
Lists recurrence settings of a project.

Path parameters

projectId (required)
Path Parameter

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

401

User doesn't have permission to do this action

500

Internal server error while fetching data.

404

Recurrence settings of given proejct are not found

Up
put /advlists/{projectId}/recurrence
Updates the recurrence configuration of an Object. (updateRecurrenceSettings)

Path parameters

projectId (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — Recurrence data to be updated.

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

422

Invalid data is provided in the request.

401

User doesn't have permission to update recurrence of given object. Unauthorized request

500

Internal server error while updaing recurrence of given object.

204

Recurrence of an object is updated successfully

404

Object with given project_id is not found

Up
get /advlists/{projectId}/workflowrows
Lists all attachment folders from a project. (getAllFolders_2)
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:

Request body

body (optional)
Body Parameter

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

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 /advlists/{projectId}/workflowrows/{folderId}
Returns details of folders on the given folderID. (getAttachmentFolder_3)
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:

Request body

body (optional)
Body Parameter

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 such folder found

Up
get /advlists/{projectId}/workflowrows/{rowId}
Finds a workflow task or a stage by specified Row ID. (getWorkflowRow)
Returns details of a workflow row task or stage in JSON format.

Path parameters

projectId (required)
Path Parameter
rowId (required)
Path Parameter — The Row ID of a workflow row.

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 such workflow task or stage found

Up
put /advlists/{projectId}/workflowrows/{rowId}
Updates a workflow task or a stage by specified Row ID. (updateWorkflowRow)
Accepts the property to be updated in JSON format.

Path parameters

projectId (required)
Path Parameter
rowId (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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Task or stage 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 workflow task or stage found

Up
get /advlists/{projectId}/workflowrows/{rowId}/attachments
Lists all attachments from a project. (getAllAttachments_4)
Returns details of all attachments and folders in JSON format.

Path parameters

projectId (required)
Path Parameter
rowId (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 Accept 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 /advlists/{projectId}/workflowrows/{rowId}/attachments
Saves attachment based on attachment file passed (saveAttachment_5)
Attachement VO that contains information about file saved

Path parameters

projectId (required)
Path Parameter
rowId (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 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 attachment found

Up
get /advlists/{projectId}/workflowrows/{rowId}/attachments/{attachmentId}
Returns file attachment based on attachment id passed. (getAttachment_6)
Returns file attachment in original format.

Path parameters

projectId (required)
Path Parameter
rowId (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 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 such attachment found

Up
delete /advlists/{projectId}/workflowrows/{rowId}/attachments/{attachmentId}
Deletes file attachment based on attachment id passed. (deleteAttachment_7)

Path parameters

projectId (required)
Path Parameter
rowId (required)
Path Parameter
attachmentId (required)
Path Parameter — The Attachment Id .

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
post /advlists/{projectId}/workflowrows/{rowId}/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
rowId (required)
Path Parameter

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 /advlists/{projectId}/workflowrows/{rowId}/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
rowId (required)
Path Parameter
jobId (required)
Path Parameter — The Job ID.

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

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

Up

Models

[ Jump to Methods ]

Table of Contents

  1. DailyInfo
  2. WorkflowRowVO
  3. FolderVO
  4. MonthlyInfo
  5. PathSegment
  6. SearchCriteriaVO
  7. AttachmentVO
  8. GroupVO
  9. ComponentFormVO
  10. Response
  11. RunResultVO
  12. WeeklyInfo
  13. ComponentVO
  14. SearchVO
  15. UserVO
  16. MemberVO
  17. RecurrenceVO
  18. Map
  19. File

DailyInfo Up

Num_days_between_occurrences
Integer Number of days between occurrencess

WorkflowRowVO Up

Row_ID
Integer Row ID
Row_Name
String Name
Row_Type
String Type
Enum:
SYSTEM
SYSTEM_FLOWCHART_RUN
SYSTEM_LIST_REVIEW
SYSTEM_NOTIFY_CAMPAIGN
SYSTEM_SCHEDULE
SYSTEM_SUBSCRIPTION
UNDEFINED
USER
Row_Status
String Status of task
Enum:
ACTIVE
FAILED
FINISHED
PENDING
SKIPPED
STOPPED
Flowchart_Tab_Name
String Flowchart Tab Name
Target_Start_Date
Date Target Start Date
Target_End_Date
Date Target End Date
Milestone
String Milestone Type
Percentage_Completed
Integer Percentage Completed
Member_Role
String Member Role
Notes
String Notes
Last_Modified_By
String Last Modified By
Display_Order
Integer Display Order
Display_ID
String Display ID
Dependent_List
String Dependent tasks's display ID
Misconfigured_Task
Boolean Misconfigured Task
Job_ID
String Job ID
Run_ID
Long Run ID

FolderVO Up

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

MonthlyInfo Up

Num_months_between_occurrences
Integer Number of months between occurrencess
Monthly_recurrence_type
Integer Monthly recurrence type
Recurring_on_each_date_of_month
Integer Recurring on each date of month
Recurring_on_each_week_of_month
Integer Recurring on each week of month
Recurring_on_each_day_of_week
Integer Recurring on each day of week

PathSegment Up

matrixParameters
javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>
path
String

SearchCriteriaVO Up

operator
String Operator
Enum:
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

AttachmentVO Up

attachmentId
Integer
fileName
String
mimeType
String
size
Integer
description
String
type
String
parentID
Integer
folderID
Integer
attachedFile
File

GroupVO Up

subGroups
array[GroupVO] Groups Object
groupId
Integer Group Id
groupName
String Group Name
user
array[UserVO] User Object

ComponentFormVO Up

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

Response Up

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

RunResultVO Up

Run_ID
Integer Flowchart Run ID
Flowchart_Status
String Flowchart Status
Enum:
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

WeeklyInfo Up

Num_weeks_between_occurrences
Integer Number of weeeks between occurrencess
Days_of_week
array[Integer] Days of week

ComponentVO Up

Project_ID
Integer Project ID
Project_Name
String Name of Project
Project_Type
String Type of Project
Enum:
ALL_TYPE
PROJECT
LIST
LOCAL
CORPORATE
Project_SubType
String Type of Project
Enum:
ADVANCED
SIMPLE
Description
String Project Description
Template_Name
String Template Name
Template_DB_ID
Integer Template DB ID
Project_Status
String Status of Project
Enum:
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

SearchVO Up

criteria
array[SearchCriteriaVO] Search Criteria
projectType
String
condition
String Criteria Condition

UserVO Up

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

MemberVO Up

user
UserVO User Object
accessLevel
String Access Level

RecurrenceVO Up

Object_Type
String Object Type
Object_ID
Integer Object ID
Recurrence_ID
Integer Recurrence ID
Frequency
String Recurrence Frequency
Enum:
daily
weekly
monthly
Recurrence_Name
String Recurrence Name
Number_of_Occurrences
Integer Number of Occurrences
Start_Date
String Start Date
Recurrence_End_Type
String Recurrence End Type
Enum:
endType_date
endType_nbocurrence
End_Date
String End Date
Daily_Info
DailyInfo Daily Info
Weekly_Info
WeeklyInfo Weekly Info
Monthly_Info
MonthlyInfo Monthly Info

Map Up

empty
Boolean

File Up

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