Library Component Questions

Get all Component Questions

This endpoint retrieves a list of Component Questions.

GET /api/v2/library/componentquestions/

Query Parameters

The following parameters may be used to filter the Component Questions in the response.

Parameter Description
component Filter Component Questions by its Component ID.
search Filter Component Questions by performing a textual search on its ID, text or description.

GET /api/v2/library/componentquestions/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [
        {
            "id": "AQ1",
            "text": "Select the Artificial Intelligence (AI) topics applicable to this component:",
            "description": "",
            "answers": [
                {
                    "id": "AA1",
                    "text": "AI Governance",
                    "description": "",
                    "attribute": "AT420"
                },
                {
                    "id": "AA2",
                    "text": "LLMs",
                    "description": "",
                    "attribute": "AT151"
                }
            ],
            "components": [
                {
                    "id": "SC101",
                    "title": "Project Characteristics",
                    "parent_answer_id": null,
                    "parent_answer_question_id": null
                },
                {
                    "id": "SC42",
                    "title": "Generic Component",
                    "parent_answer_id": null,
                    "parent_answer_question_id": null
                }
            ],
            "created": "2024-09-18T17:20:29.207000-04:00",
            "updated": "2024-11-13T09:33:32.907000-05:00",
            "question_type": "MC",
            "db_id": 20388
        },
        {
            "id": "AQ10",
            "text": "Select the application layer communication protocols/methods this component uses:",
            "description": "",
            "answers": [
                {
                    "id": "AA26",
                    "text": "AMQP",
                    "description": "",
                    "attribute": "AT1432"
                },
                {
                    "id": "AA27",
                    "text": "FTP",
                    "description": "",
                    "attribute": "AT1421"
                }
            ],
            "components": [
                {
                    "id": "SC42",
                    "title": "Generic Component",
                    "parent_answer_id": "AA1",
                    "parent_answer_question_id": "AQ1"
                },
                {
                    "id": "SC46",
                    "title": "Firmware",
                    "parent_answer_id": "AA2",
                    "parent_answer_question_id": "AQ1"
                }
            ],
            "created": "2024-09-18T17:21:02.821000-04:00",
            "updated": "2024-09-24T12:06:03.752000-04:00",
            "question_type": "MC",
            "db_id": 20397
        }
    ]
}

Get a specific Component Question

This endpoint retrieves a specific Component Question.

GET /api/v2/library/componentquestions/{component_question_id}/

URL Parameters

Parameter Description
component_question_id The id of the Component Question to retrieve.
GET /api/v2/library/componentquestions/AQ1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "AQ1",
    "text": "Select the Artificial Intelligence (AI) topics applicable to this component:",
    "description": "",
    "answers": [
        {
            "id": "AA1",
            "text": "AI Governance",
            "description": "",
            "attribute": "AT420"
        },
        {
            "id": "AA2",
            "text": "LLMs",
            "description": "",
            "attribute": "AT151"
        }
    ],
    "components": [
        {
            "id": "SC101",
            "title": "Project Characteristics",
            "parent_answer_id": null,
            "parent_answer_question_id": null
        },
        {
            "id": "SC42",
            "title": "Generic Component",
            "parent_answer_id": null,
            "parent_answer_question_id": null
        }
    ],
    "created": "2024-09-18T17:20:29.207000-04:00",
    "updated": "2024-11-13T09:33:32.907000-05:00",
    "question_type": "MC",
    "db_id": 20388
}

results matching ""

    No results matching ""