defectdojo_api_generated.QuestionnaireGeneralQuestionnairesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
list	GET /api/v2/questionnaire_general_questionnaires/
retrieve	GET /api/v2/questionnaire_general_questionnaires/{id}/

list

PaginatedQuestionnaireGeneralSurveyList list(limit=limit, offset=offset)

This endpoint is deprecated and will be removed on 2026-06-01.

Example

Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.paginated_questionnaire_general_survey_list import PaginatedQuestionnaireGeneralSurveyList
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.QuestionnaireGeneralQuestionnairesApi(api_client)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)

    try:
        api_response = api_instance.list(limit=limit, offset=offset)
        print("The response of QuestionnaireGeneralQuestionnairesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QuestionnaireGeneralQuestionnairesApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]

Return type

PaginatedQuestionnaireGeneralSurveyList

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve

QuestionnaireGeneralSurvey retrieve(id)

This endpoint is deprecated and will be removed on 2026-06-01.

Example

Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.questionnaire_general_survey import QuestionnaireGeneralSurvey
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.QuestionnaireGeneralQuestionnairesApi(api_client)
    id = 56 # int | A unique integer value identifying this General Engagement Survey.

    try:
        api_response = api_instance.retrieve(id)
        print("The response of QuestionnaireGeneralQuestionnairesApi->retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QuestionnaireGeneralQuestionnairesApi->retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this General Engagement Survey.

Return type

QuestionnaireGeneralSurvey

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]