URL obj = new URL("http://localhost:3030/api/projects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
URL obj = new URL("http://localhost:3030/api/projects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
URL obj = new URL("http://localhost:3030/api/projects/{projectId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/users/{userId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /projects/{projectId}/tasks
Parameters
Name
In
Type
Required
Description
start_time
query
string(date-time)
false
If not provided, retrieves all tasks created after start_time.
end_time
query
string(date-time)
false
If not provided, retrieves all tasks created before end_time.
last_sync_time
query
string(date-time)
false
(For mobile application) Retrieve tasks that were published after last_sync_time.
status
query
string
false
If not provided, retrieves all tasks regardless of status.
type
query
string
false
If not provided, retrieves all tasks regardless of type.
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»»»» options
[any]
true
none
none
»»»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»»»» display_logic
object
false
none
Not used in v1.0.
»»»»»» skip_logic
[any]
false
none
none
»»»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»»»» anonymous
object
false
none
none
»»»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»»» anonymous
object
false
none
none
»»»»»» tag
string
true
none
none
»»»»»» options
[any]
true
none
none
»»»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»»» anonymous
object
false
none
none
»»»»»» tag
string
true
none
none
»»»»»» low
integer
true
none
Min value of scale.
»»»»»» high
integer
true
none
Max value of scale.
»»»»»» lowLabel
string
false
none
Label of min value.
»»»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»»»» anonymous
object
false
none
none
»»»»»» tag
string
true
none
none
»»»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» title
string
false
none
Same with query.
»»»» properties
object
false
none
none
»»»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» completionTitle
string
true
none
Title of completion message.
»»»» completionDescription
string
false
none
none
»»»» required
boolean
false
none
none
»»»» type
string
true
none
none
»»»» properties
object
false
none
Field for configurable values. This is not used for v1.0.
continued
Name
Type
Required
Restrictions
Description
»» sequence
integer
true
none
Sequence of this item in a task.
Enumerated Values
Property
Value
status
DRAFT
status
PUBLISHED
type
SURVEY
type
ACTIVITY
type
QUESTION
type
SECTION
type
ACTIVITY
type
CHOICE
type
TEXT
type
RANK
type
SCALE
type
DATETIME
tag
RADIO
tag
CHECKBOX
tag
DROPDOWN
tag
MULTIIMAGE
tag
IMAGE
tag
TEXT
tag
RANK
tag
SLIDER
tag
DATETIME
type
TAPPING_SPEED
type
REACTION_TIME
type
RANGE_OF_MOTION
type
GAIT_AND_BALANCE
type
GUIDED_BREATHING
type
STROOP_TEST
type
SPEECH_RECOGNITION
type
MOBILE_SPIROMETRY
type
SUSTAINED_PHONATION
Status Code default
Name
Type
Required
Restrictions
Description
» code
integer(int32)
true
none
none
» message
string
true
none
none
Create a new task.
Code samples
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/tasks/{taskId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»»»» options
[any]
true
none
none
»»»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»»»» display_logic
object
false
none
Not used in v1.0.
»»»»»» skip_logic
[any]
false
none
none
»»»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»»»» anonymous
object
false
none
none
»»»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»»» anonymous
object
false
none
none
»»»»»» tag
string
true
none
none
»»»»»» options
[any]
true
none
none
»»»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»»» anonymous
object
false
none
none
»»»»»» tag
string
true
none
none
»»»»»» low
integer
true
none
Min value of scale.
»»»»»» high
integer
true
none
Max value of scale.
»»»»»» lowLabel
string
false
none
Label of min value.
»»»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»»»» anonymous
object
false
none
none
»»»»»» tag
string
true
none
none
»»»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» title
string
false
none
Same with query.
»»»» properties
object
false
none
none
»»»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» completionTitle
string
true
none
Title of completion message.
»»»» completionDescription
string
false
none
none
»»»» required
boolean
false
none
none
»»»» type
string
true
none
none
»»»» properties
object
false
none
Field for configurable values. This is not used for v1.0.
continued
Name
Type
Required
Restrictions
Description
»» sequence
integer
true
none
Sequence of this item in a task.
Enumerated Values
Property
Value
status
DRAFT
status
PUBLISHED
type
SURVEY
type
ACTIVITY
type
QUESTION
type
SECTION
type
ACTIVITY
type
CHOICE
type
TEXT
type
RANK
type
SCALE
type
DATETIME
tag
RADIO
tag
CHECKBOX
tag
DROPDOWN
tag
MULTIIMAGE
tag
IMAGE
tag
TEXT
tag
RANK
tag
SLIDER
tag
DATETIME
type
TAPPING_SPEED
type
REACTION_TIME
type
RANGE_OF_MOTION
type
GAIT_AND_BALANCE
type
GUIDED_BREATHING
type
STROOP_TEST
type
SPEECH_RECOGNITION
type
MOBILE_SPIROMETRY
type
SUSTAINED_PHONATION
Status Code default
Name
Type
Required
Restrictions
Description
» code
integer(int32)
true
none
none
» message
string
true
none
none
Update a specific task.
Code samples
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/tasks/{taskId}?revision_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PATCH /projects/{projectId}/tasks/{taskId}
Only tasks in DRAFT status can be updated. This is intended for auto-save or status changes.
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/in-lab-visits");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/in-lab-visits");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Retrieve in-lab visits with a specific inLabVisitId.
Code samples
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/in-lab-visits/{inLabVisitId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /projects/{projectId}/in-lab-visits/{inLabVisitId}
Update in-lab visit data with a specific inLabVisitId.
Code samples
URL obj = new URL("http://localhost:3030/api/projects/{projectId}/in-lab-visits/{inLabVisitId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
options
[any]
true
none
none
» value
string
true
none
For Image Question, you have to put link of Image in this field.
» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
display_logic
object
false
none
Not used in v1.0.
skip_logic
[any]
false
none
none
» condition
string
false
none
Expression that match BranchRule.
» goToAction
string
false
none
Not used in v1.0.
» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»» options
[any]
true
none
none
»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»» display_logic
object
false
none
Not used in v1.0.
»» skip_logic
[any]
false
none
none
»»» condition
string
false
none
Expression that match BranchRule.
»»» goToAction
string
false
none
Not used in v1.0.
»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»» options
[any]
true
none
none
»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»» display_logic
object
false
none
Not used in v1.0.
»»»» skip_logic
[any]
false
none
none
»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» options
[any]
true
none
none
»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» low
integer
true
none
Min value of scale.
»»»» high
integer
true
none
Max value of scale.
»»»» lowLabel
string
false
none
Label of min value.
»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» title
string
false
none
Same with query.
»» properties
object
false
none
none
»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» completionTitle
string
true
none
Title of completion message.
»» completionDescription
string
false
none
none
»» required
boolean
false
none
none
»» type
string
true
none
none
»» properties
object
false
none
Field for configurable values. This is not used for v1.0.
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»» options
[any]
true
none
none
»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»» display_logic
object
false
none
Not used in v1.0.
»»»» skip_logic
[any]
false
none
none
»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» options
[any]
true
none
none
»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» low
integer
true
none
Min value of scale.
»»»» high
integer
true
none
Max value of scale.
»»»» lowLabel
string
false
none
Label of min value.
»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» title
string
false
none
Same with query.
»» properties
object
false
none
none
»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» completionTitle
string
true
none
Title of completion message.
»» completionDescription
string
false
none
none
»» required
boolean
false
none
none
»» type
string
true
none
none
»» properties
object
false
none
Field for configurable values. This is not used for v1.0.
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»» options
[any]
true
none
none
»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»» display_logic
object
false
none
Not used in v1.0.
»»»» skip_logic
[any]
false
none
none
»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» options
[any]
true
none
none
»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» low
integer
true
none
Min value of scale.
»»»» high
integer
true
none
Max value of scale.
»»»» lowLabel
string
false
none
Label of min value.
»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» title
string
false
none
Same with query.
»» properties
object
false
none
none
»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» completionTitle
string
true
none
Title of completion message.
»» completionDescription
string
false
none
none
»» required
boolean
false
none
none
»» type
string
true
none
none
»» properties
object
false
none
Field for configurable values. This is not used for v1.0.
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»» options
[any]
true
none
none
»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»» display_logic
object
false
none
Not used in v1.0.
»»»» skip_logic
[any]
false
none
none
»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» options
[any]
true
none
none
»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» low
integer
true
none
Min value of scale.
»»»» high
integer
true
none
Max value of scale.
»»»» lowLabel
string
false
none
Label of min value.
»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»» anonymous
object
false
none
none
»»»» tag
string
true
none
none
»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» title
string
false
none
Same with query.
»» properties
object
false
none
none
»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» completionTitle
string
true
none
Title of completion message.
»» completionDescription
string
false
none
none
»» required
boolean
false
none
none
»» type
string
true
none
none
»» properties
object
false
none
Field for configurable values. This is not used for v1.0.
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»»» options
[any]
true
none
none
»»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»»» display_logic
object
false
none
Not used in v1.0.
»»»»» skip_logic
[any]
false
none
none
»»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» options
[any]
true
none
none
»»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» low
integer
true
none
Min value of scale.
»»»»» high
integer
true
none
Max value of scale.
»»»»» lowLabel
string
false
none
Label of min value.
»»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
»» anonymous
object
false
none
none
»»» title
string
false
none
Same with query.
»»» properties
object
false
none
none
»»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
»» anonymous
object
false
none
none
»»» completionTitle
string
true
none
Title of completion message.
»»» completionDescription
string
false
none
none
»»» required
boolean
false
none
none
»»» type
string
true
none
none
»»» properties
object
false
none
Field for configurable values. This is not used for v1.0.
cronQuartz format. This is required if status is PUBLISHED.
startTime
string(date-time)
false
none
This is required if status is PUBLISHED.
endTime
string(date-time)
false
none
If not exists, there's no expiration.
validTime
integer
false
none
Valid time of each task (minute-based). This is required if status is PUBLISHED.
status
string
true
none
none
type
string
true
none
none
items
[any]
true
none
none
» type
string
true
none
Type of Item
» contents
any
true
none
According to the type, it will be changed.
oneOf
Name
Type
Required
Restrictions
Description
»» anonymous
object
false
none
none
»»» title
string
true
none
Same with query.
»»» explanation
string
false
none
none
»»» required
boolean
false
none
none
»»» type
string
true
none
none
»»» properties
object
true
none
It depends on the value of 'type'.
oneOf
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»»» options
[any]
true
none
none
»»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»»» display_logic
object
false
none
Not used in v1.0.
»»»»» skip_logic
[any]
false
none
none
»»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» options
[any]
true
none
none
»»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» low
integer
true
none
Min value of scale.
»»»»» high
integer
true
none
Max value of scale.
»»»»» lowLabel
string
false
none
Label of min value.
»»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
»» anonymous
object
false
none
none
»»» title
string
false
none
Same with query.
»»» properties
object
false
none
none
»»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
»» anonymous
object
false
none
none
»»» completionTitle
string
true
none
Title of completion message.
»»» completionDescription
string
false
none
none
»»» required
boolean
false
none
none
»»» type
string
true
none
none
»»» properties
object
false
none
Field for configurable values. This is not used for v1.0.
Only one option can be chosen for radio, dropdown, image. Multiple options can be chosen for checkbox, multi-image.
»»»»» options
[any]
true
none
none
»»»»»» value
string
true
none
For Image Question, you have to put link of Image in this field.
»»»»»» label
string
false
none
This field can be used when type is IMAGE to generate Image Question with label. Also, if you want to create Image Question with label, all options have to include their own labels.
»»»»» display_logic
object
false
none
Not used in v1.0.
»»»»» skip_logic
[any]
false
none
none
»»»»»» condition
string
false
none
Expression that match BranchRule.
»»»»»» goToAction
string
false
none
Not used in v1.0.
»»»»»» goToItemSequence
integer
false
none
If condition holds, then skip to sequence $goToItemSequence.
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» options
[any]
true
none
none
»»»»»» value
string
true
none
none
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» low
integer
true
none
Min value of scale.
»»»»» high
integer
true
none
Max value of scale.
»»»»» lowLabel
string
false
none
Label of min value.
»»»»» highLabel
string
false
none
Label of max value.
xor
Name
Type
Required
Restrictions
Description
»»»» anonymous
object
false
none
none
»»»»» tag
string
true
none
none
»»»»» isTime
boolean
false
none
Either isTime or isDate has to be true.
»»»»» isDate
boolean
false
none
Either isTime or isDate has to be true.
»»»»» isRange
boolean
false
none
none
xor
Name
Type
Required
Restrictions
Description
»» anonymous
object
false
none
none
»»» title
string
false
none
Same with query.
»»» properties
object
false
none
none
»»»» display_logic
object
false
none
Not used in v1.0.
xor
Name
Type
Required
Restrictions
Description
»» anonymous
object
false
none
none
»»» completionTitle
string
true
none
Title of completion message.
»»» completionDescription
string
false
none
none
»»» required
boolean
false
none
none
»»» type
string
true
none
none
»»» properties
object
false
none
Field for configurable values. This is not used for v1.0.