Skip to main content

Use Cases Questionnaires

Manage questionnaires associated with use cases.

Methods​

list​

List Use Case Questionnaires List all questionnaires attached to a use case.

use_case_id = "use_case_id-123"

response = client.use_case_questionnaires.list(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

attach​

Attach Questionnaire to Use Case Attach a questionnaire to a use case.

from credoai import QuestionnaireAttachment

use_case_id = "use_case_id-123"

data = QuestionnaireAttachment(
    id="questionnaires-456"
)

response = client.use_case_questionnaires.attach(
    use_case_id=use_case_id,
    data=data,
)

Parameters:

Returns: Response object

update​

Update Use Case Questionnaire Update a questionnaire attachment on a use case.

from credoai import QuestionnaireAttachmentUpdate

use_case_id = "use_case_id-123"
attachment_id = "attachment_id-123"

data = QuestionnaireAttachmentUpdate(
    id="questionnaires-456"
)

response = client.use_case_questionnaires.update(
    use_case_id=use_case_id,
    attachment_id=attachment_id,
    data=data,
)

Parameters:

  • use_case_id (str, required) - Resource identifier
  • attachment_id (str, required) - Resource identifier
  • data (QuestionnaireAttachmentUpdate, required) - Request payload

Returns: Response object

detach​

Detach Questionnaire from Use Case Detach a questionnaire from a use case.

use_case_id = "use_case_id-123"
attachment_id = "attachment_id-123"

response = client.use_case_questionnaires.detach(
    use_case_id=use_case_id,
    attachment_id=attachment_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier
  • attachment_id (str, required) - Resource identifier

Returns: Response object

Example: Working with Use Cases Questionnaires​

from credoai import CredoAI, RelationshipAdd

client = CredoAI()

# List questionnaires for a use_case
questionnaires = client.use_case_questionnaires.list(use_case_id="use_case-123")
for item in questionnaires.items:
    print(f"\\{item.id}")

# Add a quetionnaire
client.use_case_questionnaires.add(
    use_case_id="use_case-123",
    data=RelationshipAdd(id="quetionnaire-456")
)

# Remove a quetionnaire
client.use_case_questionnaires.remove(
    use_case_id="use_case-123",
    questionnaire_id="quetionnaire-456"
)