Skip to content

Checklists Admin

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/checklists-admin/ List Checklists Admin
GET /api/checklists-admin/{uuid}/ Retrieve
POST /api/checklists-admin/ Create
PUT /api/checklists-admin/{uuid}/ Update
PATCH /api/checklists-admin/{uuid}/ Partial Update
DELETE /api/checklists-admin/{uuid}/ Delete
Other Actions
GET /api/checklists-admin/{uuid}/questions/ Return checklist questions

Core CRUD

List Checklists Admin

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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 import checklists_admin_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ChecklistTypeEnum
  2. API Source: checklists_admin_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { checklistsAdminList } from 'waldur-js-client';

try {
  const response = await checklistsAdminList({
  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_type__in array Filter by multiple checklist types
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)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin/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 import checklists_admin_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminRetrieve } from 'waldur-js-client';

try {
  const response = await checklistsAdminRetrieve({
  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)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/checklists-admin/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-checklists-admin"

 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.checklist_request import ChecklistRequest # (1)
from waldur_api_client.api.checklists_admin import checklists_admin_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ChecklistRequest(
    name="my-awesome-checklists-admin"
)
response = checklists_admin_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ChecklistRequest
  2. API Source: checklists_admin_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminCreate } from 'waldur-js-client';

try {
  const response = await checklistsAdminCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-checklists-admin"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
checklist_type any Type of compliance this checklist addresses

201 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/checklists-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-checklists-admin"

 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.checklist_request import ChecklistRequest # (1)
from waldur_api_client.api.checklists_admin import checklists_admin_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ChecklistRequest(
    name="my-awesome-checklists-admin"
)
response = checklists_admin_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ChecklistRequest
  2. API Source: checklists_admin_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { checklistsAdminUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-checklists-admin"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
checklist_type any Type of compliance this checklist addresses

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/checklists-admin/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_checklist_request import PatchedChecklistRequest # (1)
from waldur_api_client.api.checklists_admin import checklists_admin_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedChecklistRequest()
response = checklists_admin_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedChecklistRequest
  2. API Source: checklists_admin_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminPartialUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminPartialUpdate({
  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
name string
description string
checklist_type any Type of compliance this checklist addresses

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/checklists-admin/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 import checklists_admin_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminDestroy } from 'waldur-js-client';

try {
  const response = await checklistsAdminDestroy({
  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) ✓

204 - No response body

Other Actions

Return checklist questions

Return checklist questions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/questions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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 import checklists_admin_checklist_questions # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_checklist_questions.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: ChecklistTypeEnum
  2. API Source: checklists_admin_checklist_questions
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminChecklistQuestions } from 'waldur-js-client';

try {
  const response = await checklistsAdminChecklistQuestions({
  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) ✓
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_type__in array Filter by multiple checklist types
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)