Checklists Admin Questions
Operations Summary
| Method |
Endpoint |
Description |
| GET |
/api/checklists-admin-questions/ |
List Checklists Admin Questions |
| GET |
/api/checklists-admin-questions/{uuid}/ |
Retrieve |
| POST |
/api/checklists-admin-questions/ |
Create |
| PUT |
/api/checklists-admin-questions/{uuid}/ |
Update |
| PATCH |
/api/checklists-admin-questions/{uuid}/ |
Partial Update |
| DELETE |
/api/checklists-admin-questions/{uuid}/ |
Delete |
List Checklists Admin Questions
| http \
GET \
https://api.example.com/api/checklists-admin-questions/ \
Authorization:"Token YOUR_API_TOKEN"
|
| from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.checklist_type_enum import ChecklistTypeEnum # (1)
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_list # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_questions_list.sync(client=client)
for item in response:
print(item)
|
- Model Source:
ChecklistTypeEnum
- API Source:
checklists_admin_questions_list
| import { checklistsAdminQuestionsList } from 'waldur-js-client';
try {
const response = await checklistsAdminQuestionsList({
auth: "Token YOUR_API_TOKEN"
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Name |
Type |
Description |
checklist_type |
string |
Type of compliance this checklist addresses
Enum: project_compliance, proposal_compliance, offering_compliance, project_metadata, onboarding_customer, onboarding_intent, workflow_step |
checklist_uuid |
string (uuid) |
|
has_onboarding_mapping |
boolean |
Filter questions that have onboarding metadata mapping |
page |
integer |
A page number within the paginated result set. |
page_size |
integer |
Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field |
Type |
Description |
uuid |
string (uuid) |
|
required |
boolean |
|
description |
string |
|
user_guidance |
string |
Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects |
|
question_options.uuid |
string (uuid) |
|
question_options.label |
string |
|
question_options.order |
integer |
|
question_options.url |
string (uri) |
|
question_options.question |
string (uri) |
|
question_options.question_uuid |
string (uuid) |
|
question_type |
any |
Type of question and expected answer format |
order |
integer |
|
min_value |
string (decimal) |
Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) |
Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
array of strings |
|
allowed_mime_types |
array of strings |
|
max_file_size_mb |
integer |
Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer |
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
likert_scale_length |
any |
Number of points on the Likert scale (3, 5, or 7). Required for LIKERT type questions. |
likert_low_label |
string |
Label for the lowest point on the Likert scale (e.g. 'Strongly disagree'). Optional. |
likert_high_label |
string |
Label for the highest point on the Likert scale (e.g. 'Strongly agree'). Optional. |
likert_allow_na |
boolean |
Allow respondents to choose 'N/A' as an answer for LIKERT type questions. |
rich_text_char_limit |
integer |
Maximum number of characters allowed in RICH_TEXT type answers. If not set, no limit is enforced. |
rich_text_toolbar_level |
any |
Toolbar level for the rich text editor: 'minimal', 'standard', or 'extended'. |
operator |
any |
|
review_answer_value |
any |
|
always_requires_review |
boolean |
This question always requires review regardless of answer |
guidance_answer_value |
object (free-form) |
Answer value that triggers display of user guidance. |
guidance_operator |
any |
Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean |
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any |
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) |
|
checklist_name |
string |
|
checklist_uuid |
string (uuid) |
|
checklist_type |
string |
|
checklist |
string (uri) |
|
Retrieve
| http \
GET \
https://api.example.com/api/checklists-admin-questions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
Authorization:"Token YOUR_API_TOKEN"
|
1
2
3
4
5
6
7
8
9
10
11
12 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_retrieve # (1)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_questions_retrieve.sync(
uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
client=client
)
print(response)
|
- API Source:
checklists_admin_questions_retrieve
1
2
3
4
5
6
7
8
9
10
11
12
13 | import { checklistsAdminQuestionsRetrieve } from 'waldur-js-client';
try {
const response = await checklistsAdminQuestionsRetrieve({
auth: "Token YOUR_API_TOKEN",
path: {
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Name |
Type |
Required |
uuid |
string (uuid) |
✓ |
200 -
| Field |
Type |
Description |
uuid |
string (uuid) |
|
required |
boolean |
|
description |
string |
|
user_guidance |
string |
Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects |
|
question_options.uuid |
string (uuid) |
|
question_options.label |
string |
|
question_options.order |
integer |
|
question_options.url |
string (uri) |
|
question_options.question |
string (uri) |
|
question_options.question_uuid |
string (uuid) |
|
question_type |
any |
Type of question and expected answer format |
order |
integer |
|
min_value |
string (decimal) |
Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) |
Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
array of strings |
|
allowed_mime_types |
array of strings |
|
max_file_size_mb |
integer |
Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer |
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
likert_scale_length |
any |
Number of points on the Likert scale (3, 5, or 7). Required for LIKERT type questions. |
likert_low_label |
string |
Label for the lowest point on the Likert scale (e.g. 'Strongly disagree'). Optional. |
likert_high_label |
string |
Label for the highest point on the Likert scale (e.g. 'Strongly agree'). Optional. |
likert_allow_na |
boolean |
Allow respondents to choose 'N/A' as an answer for LIKERT type questions. |
rich_text_char_limit |
integer |
Maximum number of characters allowed in RICH_TEXT type answers. If not set, no limit is enforced. |
rich_text_toolbar_level |
any |
Toolbar level for the rich text editor: 'minimal', 'standard', or 'extended'. |
operator |
any |
|
review_answer_value |
any |
|
always_requires_review |
boolean |
This question always requires review regardless of answer |
guidance_answer_value |
object (free-form) |
Answer value that triggers display of user guidance. |
guidance_operator |
any |
Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean |
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any |
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) |
|
checklist_name |
string |
|
checklist_uuid |
string (uuid) |
|
checklist_type |
string |
|
checklist |
string (uri) |
|
Create
| http \
POST \
https://api.example.com/api/checklists-admin-questions/ \
Authorization:"Token YOUR_API_TOKEN" \
checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.question_admin_request import QuestionAdminRequest # (1)
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_create # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = QuestionAdminRequest(
checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = checklists_admin_questions_create.sync(
client=client,
body=body_data
)
print(response)
|
- Model Source:
QuestionAdminRequest
- API Source:
checklists_admin_questions_create
1
2
3
4
5
6
7
8
9
10
11
12
13 | import { checklistsAdminQuestionsCreate } from 'waldur-js-client';
try {
const response = await checklistsAdminQuestionsCreate({
auth: "Token YOUR_API_TOKEN",
body: {
"checklist": "https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Field |
Type |
Required |
Description |
required |
boolean |
|
|
description |
string |
|
|
user_guidance |
string |
|
Additional guidance text visible to users when answering and reviewing |
question_type |
any |
|
Type of question and expected answer format |
order |
integer |
|
|
min_value |
string (decimal) |
|
Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) |
|
Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
array of strings |
|
|
allowed_mime_types |
array of strings |
|
|
max_file_size_mb |
integer |
|
Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer |
|
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
likert_scale_length |
any |
|
Number of points on the Likert scale (3, 5, or 7). Required for LIKERT type questions. |
likert_low_label |
string |
|
Label for the lowest point on the Likert scale (e.g. 'Strongly disagree'). Optional. |
likert_high_label |
string |
|
Label for the highest point on the Likert scale (e.g. 'Strongly agree'). Optional. |
likert_allow_na |
boolean |
|
Allow respondents to choose 'N/A' as an answer for LIKERT type questions. |
rich_text_char_limit |
integer |
|
Maximum number of characters allowed in RICH_TEXT type answers. If not set, no limit is enforced. |
rich_text_toolbar_level |
any |
|
Toolbar level for the rich text editor: 'minimal', 'standard', or 'extended'. |
operator |
any |
|
|
review_answer_value |
any |
|
|
always_requires_review |
boolean |
|
This question always requires review regardless of answer |
guidance_answer_value |
object (free-form) |
|
Answer value that triggers display of user guidance. |
guidance_operator |
any |
|
Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean |
|
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any |
|
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
checklist |
string (uri) |
✓ |
|
201 -
| Field |
Type |
Description |
uuid |
string (uuid) |
|
required |
boolean |
|
description |
string |
|
user_guidance |
string |
Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects |
|
question_options.uuid |
string (uuid) |
|
question_options.label |
string |
|
question_options.order |
integer |
|
question_options.url |
string (uri) |
|
question_options.question |
string (uri) |
|
question_options.question_uuid |
string (uuid) |
|
question_type |
any |
Type of question and expected answer format |
order |
integer |
|
min_value |
string (decimal) |
Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) |
Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
array of strings |
|
allowed_mime_types |
array of strings |
|
max_file_size_mb |
integer |
Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer |
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
likert_scale_length |
any |
Number of points on the Likert scale (3, 5, or 7). Required for LIKERT type questions. |
likert_low_label |
string |
Label for the lowest point on the Likert scale (e.g. 'Strongly disagree'). Optional. |
likert_high_label |
string |
Label for the highest point on the Likert scale (e.g. 'Strongly agree'). Optional. |
likert_allow_na |
boolean |
Allow respondents to choose 'N/A' as an answer for LIKERT type questions. |
rich_text_char_limit |
integer |
Maximum number of characters allowed in RICH_TEXT type answers. If not set, no limit is enforced. |
rich_text_toolbar_level |
any |
Toolbar level for the rich text editor: 'minimal', 'standard', or 'extended'. |
operator |
any |
|
review_answer_value |
any |
|
always_requires_review |
boolean |
This question always requires review regardless of answer |
guidance_answer_value |
object (free-form) |
Answer value that triggers display of user guidance. |
guidance_operator |
any |
Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean |
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any |
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) |
|
checklist_name |
string |
|
checklist_uuid |
string (uuid) |
|
checklist_type |
string |
|
checklist |
string (uri) |
|
Update
| http \
PUT \
https://api.example.com/api/checklists-admin-questions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
Authorization:"Token YOUR_API_TOKEN" \
checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.question_admin_request import QuestionAdminRequest # (1)
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_update # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = QuestionAdminRequest(
checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = checklists_admin_questions_update.sync(
uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
client=client,
body=body_data
)
print(response)
|
- Model Source:
QuestionAdminRequest
- API Source:
checklists_admin_questions_update
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 | import { checklistsAdminQuestionsUpdate } from 'waldur-js-client';
try {
const response = await checklistsAdminQuestionsUpdate({
auth: "Token YOUR_API_TOKEN",
path: {
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
body: {
"checklist": "https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Name |
Type |
Required |
uuid |
string (uuid) |
✓ |
| Field |
Type |
Required |
Description |
required |
boolean |
|
|
description |
string |
|
|
user_guidance |
string |
|
Additional guidance text visible to users when answering and reviewing |
question_type |
any |
|
Type of question and expected answer format |
order |
integer |
|
|
min_value |
string (decimal) |
|
Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) |
|
Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
array of strings |
|
|
allowed_mime_types |
array of strings |
|
|
max_file_size_mb |
integer |
|
Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer |
|
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
likert_scale_length |
any |
|
Number of points on the Likert scale (3, 5, or 7). Required for LIKERT type questions. |
likert_low_label |
string |
|
Label for the lowest point on the Likert scale (e.g. 'Strongly disagree'). Optional. |
likert_high_label |
string |
|
Label for the highest point on the Likert scale (e.g. 'Strongly agree'). Optional. |
likert_allow_na |
boolean |
|
Allow respondents to choose 'N/A' as an answer for LIKERT type questions. |
rich_text_char_limit |
integer |
|
Maximum number of characters allowed in RICH_TEXT type answers. If not set, no limit is enforced. |
rich_text_toolbar_level |
any |
|
Toolbar level for the rich text editor: 'minimal', 'standard', or 'extended'. |
operator |
any |
|
|
review_answer_value |
any |
|
|
always_requires_review |
boolean |
|
This question always requires review regardless of answer |
guidance_answer_value |
object (free-form) |
|
Answer value that triggers display of user guidance. |
guidance_operator |
any |
|
Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean |
|
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any |
|
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
checklist |
string (uri) |
✓ |
|
200 -
| Field |
Type |
Description |
uuid |
string (uuid) |
|
required |
boolean |
|
description |
string |
|
user_guidance |
string |
Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects |
|
question_options.uuid |
string (uuid) |
|
question_options.label |
string |
|
question_options.order |
integer |
|
question_options.url |
string (uri) |
|
question_options.question |
string (uri) |
|
question_options.question_uuid |
string (uuid) |
|
question_type |
any |
Type of question and expected answer format |
order |
integer |
|
min_value |
string (decimal) |
Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) |
Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
array of strings |
|
allowed_mime_types |
array of strings |
|
max_file_size_mb |
integer |
Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer |
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
likert_scale_length |
any |
Number of points on the Likert scale (3, 5, or 7). Required for LIKERT type questions. |
likert_low_label |
string |
Label for the lowest point on the Likert scale (e.g. 'Strongly disagree'). Optional. |
likert_high_label |
string |
Label for the highest point on the Likert scale (e.g. 'Strongly agree'). Optional. |
likert_allow_na |
boolean |
Allow respondents to choose 'N/A' as an answer for LIKERT type questions. |
rich_text_char_limit |
integer |
Maximum number of characters allowed in RICH_TEXT type answers. If not set, no limit is enforced. |
rich_text_toolbar_level |
any |
Toolbar level for the rich text editor: 'minimal', 'standard', or 'extended'. |
operator |
any |
|
review_answer_value |
any |
|
always_requires_review |
boolean |
This question always requires review regardless of answer |
guidance_answer_value |
object (free-form) |
Answer value that triggers display of user guidance. |
guidance_operator |
any |
Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean |
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any |
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) |
|
checklist_name |
string |
|
checklist_uuid |
string (uuid) |
|
checklist_type |
string |
|
checklist |
string (uri) |
|
Partial Update
| http \
PATCH \
https://api.example.com/api/checklists-admin-questions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
Authorization:"Token YOUR_API_TOKEN"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_question_admin_request import PatchedQuestionAdminRequest # (1)
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_partial_update # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = PatchedQuestionAdminRequest()
response = checklists_admin_questions_partial_update.sync(
uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
client=client,
body=body_data
)
print(response)
|
- Model Source:
PatchedQuestionAdminRequest
- API Source:
checklists_admin_questions_partial_update
1
2
3
4
5
6
7
8
9
10
11
12
13 | import { checklistsAdminQuestionsPartialUpdate } from 'waldur-js-client';
try {
const response = await checklistsAdminQuestionsPartialUpdate({
auth: "Token YOUR_API_TOKEN",
path: {
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Name |
Type |
Required |
uuid |
string (uuid) |
✓ |
| Field |
Type |
Required |
Description |
required |
boolean |
|
|
description |
string |
|
|
user_guidance |
string |
|
Additional guidance text visible to users when answering and reviewing |
question_type |
any |
|
Type of question and expected answer format |
order |
integer |
|
|
min_value |
string (decimal) |
|
Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) |
|
Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
array of strings |
|
|
allowed_mime_types |
array of strings |
|
|
max_file_size_mb |
integer |
|
Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer |
|
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
likert_scale_length |
any |
|
Number of points on the Likert scale (3, 5, or 7). Required for LIKERT type questions. |
likert_low_label |
string |
|
Label for the lowest point on the Likert scale (e.g. 'Strongly disagree'). Optional. |
likert_high_label |
string |
|
Label for the highest point on the Likert scale (e.g. 'Strongly agree'). Optional. |
likert_allow_na |
boolean |
|
Allow respondents to choose 'N/A' as an answer for LIKERT type questions. |
rich_text_char_limit |
integer |
|
Maximum number of characters allowed in RICH_TEXT type answers. If not set, no limit is enforced. |
rich_text_toolbar_level |
any |
|
Toolbar level for the rich text editor: 'minimal', 'standard', or 'extended'. |
operator |
any |
|
|
review_answer_value |
any |
|
|
always_requires_review |
boolean |
|
This question always requires review regardless of answer |
guidance_answer_value |
object (free-form) |
|
Answer value that triggers display of user guidance. |
guidance_operator |
any |
|
Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean |
|
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any |
|
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
checklist |
string (uri) |
|
|
200 -
| Field |
Type |
Description |
uuid |
string (uuid) |
|
required |
boolean |
|
description |
string |
|
user_guidance |
string |
Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects |
|
question_options.uuid |
string (uuid) |
|
question_options.label |
string |
|
question_options.order |
integer |
|
question_options.url |
string (uri) |
|
question_options.question |
string (uri) |
|
question_options.question_uuid |
string (uuid) |
|
question_type |
any |
Type of question and expected answer format |
order |
integer |
|
min_value |
string (decimal) |
Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) |
Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
array of strings |
|
allowed_mime_types |
array of strings |
|
max_file_size_mb |
integer |
Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer |
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
likert_scale_length |
any |
Number of points on the Likert scale (3, 5, or 7). Required for LIKERT type questions. |
likert_low_label |
string |
Label for the lowest point on the Likert scale (e.g. 'Strongly disagree'). Optional. |
likert_high_label |
string |
Label for the highest point on the Likert scale (e.g. 'Strongly agree'). Optional. |
likert_allow_na |
boolean |
Allow respondents to choose 'N/A' as an answer for LIKERT type questions. |
rich_text_char_limit |
integer |
Maximum number of characters allowed in RICH_TEXT type answers. If not set, no limit is enforced. |
rich_text_toolbar_level |
any |
Toolbar level for the rich text editor: 'minimal', 'standard', or 'extended'. |
operator |
any |
|
review_answer_value |
any |
|
always_requires_review |
boolean |
This question always requires review regardless of answer |
guidance_answer_value |
object (free-form) |
Answer value that triggers display of user guidance. |
guidance_operator |
any |
Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean |
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any |
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) |
|
checklist_name |
string |
|
checklist_uuid |
string (uuid) |
|
checklist_type |
string |
|
checklist |
string (uri) |
|
Delete