Skip to content

Marketplace Offering Users

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-offering-users/ List Marketplace Offering Users
GET /api/marketplace-offering-users/{uuid}/ Retrieve
POST /api/marketplace-offering-users/ Create
POST /api/marketplace-offering-users/{uuid}/update_restricted/ Update restricted
PUT /api/marketplace-offering-users/{uuid}/ Update
PATCH /api/marketplace-offering-users/{uuid}/ Partial Update
PATCH /api/marketplace-offering-users/{uuid}/update_comments/ Action for service providers to update comment and comment URL fields
DELETE /api/marketplace-offering-users/{uuid}/ Delete
Other Actions
GET /api/marketplace-offering-users/{uuid}/checklist/ Get checklist with questions and existing answers
GET /api/marketplace-offering-users/{uuid}/checklist_review/ Checklist review
GET /api/marketplace-offering-users/checklist-template/ Get checklist template for creating new objects
GET /api/marketplace-offering-users/{uuid}/completion_review_status/ Get checklist completion status with review triggers (reviewers only)
GET /api/marketplace-offering-users/{uuid}/completion_status/ Get checklist completion status
POST /api/marketplace-offering-users/{uuid}/begin_creating/ Begin creating
POST /api/marketplace-offering-users/{uuid}/request_deletion/ Action to request deletion of an offering user account
POST /api/marketplace-offering-users/{uuid}/set_deleted/ Action to mark an offering user as successfully deleted
POST /api/marketplace-offering-users/{uuid}/set_deleting/ Action to begin the deletion process for an offering user
POST /api/marketplace-offering-users/{uuid}/set_error_creating/ Set error creating
POST /api/marketplace-offering-users/{uuid}/set_error_deleting/ Set error deleting
POST /api/marketplace-offering-users/{uuid}/set_ok/ Set ok
POST /api/marketplace-offering-users/{uuid}/set_pending_account_linking/ Set pending account linking
POST /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/ Set pending additional validation
POST /api/marketplace-offering-users/{uuid}/set_validation_complete/ Set validation complete
POST /api/marketplace-offering-users/{uuid}/submit_answers/ Submit checklist answers

Core CRUD

List Marketplace Offering Users

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_list # (1)

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

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

try {
  const response = await marketplaceOfferingUsersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
field array
has_consent boolean User Has Consent
is_restricted boolean
modified string (date-time) Modified after
o array Ordering
offering string
offering_slug array Multiple values may be separated by commas.
offering_uuid array Multiple values may be separated by commas.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
provider_uuid string (uuid)
query string Search by offering name, username or user name
state array
user_username string
user_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/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.marketplace_offering_users import marketplace_offering_users_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUsersRetrieve({
  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
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_request import OfferingUserRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_create # (2)

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

body_data = OfferingUserRequest()
response = marketplace_offering_users_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserRequest
  2. API Source: marketplace_offering_users_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingUsersCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
user_uuid string (uuid)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.

Update restricted

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_restricted/ \
  Authorization:"Token YOUR_API_TOKEN" \
  is_restricted=true

 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.offering_user_update_restriction_request import OfferingUserUpdateRestrictionRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_update_restricted # (2)

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

body_data = OfferingUserUpdateRestrictionRequest(
    is_restricted=true
)
response = marketplace_offering_users_update_restricted.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceOfferingUsersUpdateRestricted({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "is_restricted": true
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
is_restricted boolean ✓

200 - No response body

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-offering-users/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.offering_user_request import OfferingUserRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_update # (2)

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

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

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

try {
  const response = await marketplaceOfferingUsersUpdate({
  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
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
user_uuid string (uuid)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-users/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_offering_user_request import PatchedOfferingUserRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_partial_update # (2)

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

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

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

try {
  const response = await marketplaceOfferingUsersPartialUpdate({
  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
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
user_uuid string (uuid)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.

Action for service providers to update comment and comment URL fields

Action for service providers to update comment and comment URL fields.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_comments/ \
  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_offering_user_service_provider_comment_request import PatchedOfferingUserServiceProviderCommentRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_update_comments_partial_update # (2)

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

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

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

try {
  const response = await marketplaceOfferingUsersUpdateCommentsPartialUpdate({
  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
service_provider_comment string
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment

200 -

Field Type Description
service_provider_comment string
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-users/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.marketplace_offering_users import marketplace_offering_users_destroy # (1)

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

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

try {
  const response = await marketplaceOfferingUsersDestroy({
  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

Get checklist with questions and existing answers

Get checklist with questions and existing answers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist/ \
  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.marketplace_offering_users import marketplace_offering_users_checklist_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUsersChecklistRetrieve({
  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
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.

400 -

404 -

Checklist review

Get checklist with questions and existing answers including review logic (reviewers only).

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist_review/ \
  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.marketplace_offering_users import marketplace_offering_users_checklist_review_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUsersChecklistReviewRetrieve({
  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
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
completion.requires_review boolean Whether any answers triggered review requirements
completion.reviewed_by integer User who reviewed the checklist completion
completion.reviewed_by_name string
completion.reviewed_at string (date-time)
completion.review_notes string Notes from the reviewer
completion.review_trigger_summary array of anys
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer

400 -

404 -

Get checklist template for creating new objects

Get checklist template for creating new objects.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/checklist-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  parent_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_checklist_template_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUsersChecklistTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "parent_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
parent_uuid string (uuid) ✓ UUID of the parent object (e.g., customer UUID for new projects)

200 -

Field Type Description
checklist object (free-form)
questions array of objects
questions.uuid string (uuid)
questions.required boolean
questions.description string
questions.user_guidance string Additional guidance text visible to users when answering and reviewing
questions.question_options array of objects
questions.question_options.uuid string (uuid)
questions.question_options.label string
questions.question_options.order integer
questions.question_type any Type of question and expected answer format
questions.order integer
questions.min_value string (decimal) Minimum value allowed for NUMBER type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer
questions.guidance_answer_value any Answer value that triggers display of user guidance.
questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
questions.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
questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
initial_visible_questions array of objects
initial_visible_questions.uuid string (uuid)
initial_visible_questions.required boolean
initial_visible_questions.description string
initial_visible_questions.user_guidance string Additional guidance text visible to users when answering and reviewing
initial_visible_questions.question_options array of objects
initial_visible_questions.question_options.uuid string (uuid)
initial_visible_questions.question_options.label string
initial_visible_questions.question_options.order integer
initial_visible_questions.question_type any Type of question and expected answer format
initial_visible_questions.order integer
initial_visible_questions.min_value string (decimal) Minimum value allowed for NUMBER type questions
initial_visible_questions.max_value string (decimal) Maximum value allowed for NUMBER type questions
initial_visible_questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
initial_visible_questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
initial_visible_questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
initial_visible_questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
initial_visible_questions.operator any
initial_visible_questions.review_answer_value any Answer value that trigger review.
initial_visible_questions.always_requires_review boolean This question always requires review regardless of answer
initial_visible_questions.guidance_answer_value any Answer value that triggers display of user guidance.
initial_visible_questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
initial_visible_questions.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
initial_visible_questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.

400 -

404 -

Get checklist completion status with review triggers (reviewers only)

Get checklist completion status with review triggers (reviewers only).

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_review_status/ \
  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.marketplace_offering_users import marketplace_offering_users_completion_review_status_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUsersCompletionReviewStatusRetrieve({
  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)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)
requires_review boolean Whether any answers triggered review requirements
reviewed_by integer User who reviewed the checklist completion
reviewed_by_name string
reviewed_at string (date-time)
review_notes string Notes from the reviewer
review_trigger_summary array of anys

400 -

404 -

Get checklist completion status

Get checklist completion status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_status/ \
  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.marketplace_offering_users import marketplace_offering_users_completion_status_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUsersCompletionStatusRetrieve({
  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)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)

400 -

404 -

Begin creating

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/begin_creating/ \
  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.marketplace_offering_users import marketplace_offering_users_begin_creating # (1)

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

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

try {
  const response = await marketplaceOfferingUsersBeginCreating({
  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 - No response body

Action to request deletion of an offering user account

Action to request deletion of an offering user account.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/request_deletion/ \
  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.marketplace_offering_users import marketplace_offering_users_request_deletion # (1)

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

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

try {
  const response = await marketplaceOfferingUsersRequestDeletion({
  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 - No response body

Action to mark an offering user as successfully deleted

Action to mark an offering user as successfully deleted.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_deleted/ \
  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.marketplace_offering_users import marketplace_offering_users_set_deleted # (1)

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

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

try {
  const response = await marketplaceOfferingUsersSetDeleted({
  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 - No response body

Action to begin the deletion process for an offering user

Action to begin the deletion process for an offering user.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_deleting/ \
  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.marketplace_offering_users import marketplace_offering_users_set_deleting # (1)

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

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

try {
  const response = await marketplaceOfferingUsersSetDeleting({
  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 - No response body

Set error creating

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_error_creating/ \
  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.marketplace_offering_users import marketplace_offering_users_set_error_creating # (1)

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

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

try {
  const response = await marketplaceOfferingUsersSetErrorCreating({
  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 - No response body

Set error deleting

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_error_deleting/ \
  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.marketplace_offering_users import marketplace_offering_users_set_error_deleting # (1)

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

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

try {
  const response = await marketplaceOfferingUsersSetErrorDeleting({
  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 - No response body

Set ok

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  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.marketplace_offering_users import marketplace_offering_users_set_ok # (1)

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

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

try {
  const response = await marketplaceOfferingUsersSetOk({
  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 - No response body

Set pending account linking

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_pending_account_linking/ \
  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.offering_user_state_transition_request import OfferingUserStateTransitionRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_pending_account_linking # (2)

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

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

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

try {
  const response = await marketplaceOfferingUsersSetPendingAccountLinking({
  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
comment string
comment_url string (uri)

200 - No response body

Set pending additional validation

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_pending_additional_validation/ \
  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.offering_user_state_transition_request import OfferingUserStateTransitionRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_pending_additional_validation # (2)

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

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

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

try {
  const response = await marketplaceOfferingUsersSetPendingAdditionalValidation({
  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
comment string
comment_url string (uri)

200 - No response body

Set validation complete

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_validation_complete/ \
  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.marketplace_offering_users import marketplace_offering_users_set_validation_complete # (1)

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

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

try {
  const response = await marketplaceOfferingUsersSetValidationComplete({
  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 - No response body

Submit checklist answers

Submit checklist answers.

1
2
3
4
echo '[{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]' | http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_answers/ \
  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.marketplace_offering_users import marketplace_offering_users_submit_answers # (1)

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

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

try {
  const response = await marketplaceOfferingUsersSubmitAnswers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
question_uuid string (uuid) ✓
answer_data any ✓

200 -

Field Type Description
detail string
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)

400 -

404 -