Skip to content

Marketplace Offering User Checklist Completions

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-user-checklist-completions/ List checklist completions for offering users
GET /api/marketplace-offering-user-checklist-completions/{id}/ Retrieve a checklist completion

List checklist completions for offering users

1
2
3
    Returns a paginated list of all checklist completions for offering users that the current user is allowed to see.
    This endpoint is used by service providers to monitor compliance status and by users to see their own required checklists.
    Visibility follows the same rules as the `OfferingUsers` endpoint.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-user-checklist-completions/ \
  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_user_checklist_completions import marketplace_offering_user_checklist_completions_list # (1)

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

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

try {
  const response = await marketplaceOfferingUserChecklistCompletionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
is_completed boolean
modified string (date-time) Modified after
o array Ordering
offering_uuid string (uuid) Filter by offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_uuid string (uuid) Filter by user UUID

200 -

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

Field Type Description
uuid string (uuid)
offering_user any
offering_user_uuid string
offering_name string
offering_uuid string
customer_provider_uuid string
customer_provider_name string
checklist_uuid string
checklist_name string
checklist_description string
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions integer
requires_review boolean Whether any answers triggered review requirements
reviewed_by integer User who reviewed the checklist completion
reviewed_at string (date-time)
review_notes string Notes from the reviewer
created string (date-time)
modified string (date-time)

Retrieve a checklist completion

Returns the details of a specific checklist completion for an offering user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-user-checklist-completions/123/ \
  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_user_checklist_completions import marketplace_offering_user_checklist_completions_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUserChecklistCompletionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this Checklist completion.

200 -

Field Type Description
uuid string (uuid)
offering_user any
offering_user_uuid string
offering_name string
offering_uuid string
customer_provider_uuid string
customer_provider_name string
checklist_uuid string
checklist_name string
checklist_description string
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions integer
requires_review boolean Whether any answers triggered review requirements
reviewed_by integer User who reviewed the checklist completion
reviewed_at string (date-time)
review_notes string Notes from the reviewer
created string (date-time)
modified string (date-time)