Use of the Supplier Data API with Pagination qna Endpoint

The Supplier Data API with Pagination qna endpoint uses the GET method to send a JSON request to your site. The request retrieves question and answer data from supplier management questionnaires.

The GET URL includes query and filter parameters, and the request header specifies authentication.

Method	Endpoint	Pagination Limit Per Page	Description
`GET`	{{runtime_URL}}supplierdatapagination/v4/prod/vendors/{SM vendor ID}/workspaces/questionnaires/qna	100	Gets all question and answer data in all questionnaires for the specified supplier.
`GET`	{{runtime_URL}}supplierdatapagination/v4/prod/vendors//{SM vendor ID}/workspaces/{workspace id}/questionnaires/qna	100	Gets all question and answer data in all questionnaires in the specified project (workspace) for the specified supplier.
`GET`	{{runtime_URL}}supplierdatapagination/v4/prod/vendors/{SM VendorID}/workspaces/questionnaires/{questionnaire id}/qna	100	Gets question and answer data in the specified questionnaire for the specified supplier.
`GET`	{{runtime_URL}}supplierdatapagination/v4/prod/vendors/{SM VendorID}/workspaces{workspace id}/questionnaires/{questionnaire id}/qna	100	Gets question and answer data in the specified questionnaire in the specified project (workspace) for the specified supplier.

For example, the following URL retrieves all of the questions and answers in a specific workspace for a specific supplier:

GET {{runtime_URL}}supplierdatapagination/v4/prod/vendors/SM100015/workspaces/WS9050423/questionnaires/qna/?realm=mysitename

These endpoints retrieve question and answer data for all question answer types in active projects except for Attachment or Certificate, which are not included in results. They also don't retrieve data for text questions with sensitive data masking. You can use the separate certificates endpoint to retrieve Certificate question and answer data.

Additionally, these endpoints do not return any data for questions and answers from inactive projects, deleted questionnaires, questionnaires that are canceled as part of a process cancellation, or from questionnaires that have not been fully answered and approved.

If you request data from a questionnaire that is incomplete or not yet approved, the endpoint returns an error indicating that the questionnaire ID is invalid. Once the questionnaire is fully answered and approved, the endpoint returns the expected data.

See Supplier Data API with Pagination Header Parameters for information on header parameters.

The following example shows a sample result for a qna endpoint. The externalSystemCorrelationId is the KI ID, a unique identifier for a piece of content in a questionnaire, which also shows in Excel exports of questionnaires from the user interface. externalSystemCorrelationIds are only unique within an individual questionnaire; it is possible for a supplier to have two questionnaires with identical externalSystemCorrelationIds. If the question is a repeatable section, the externalSystemCorrelationId is for the repeatable section itself (not the parent) and the alternative is the instance of the section, where 0 is the first instance and each additional instance is numbered in increments of 1.

{
    "_embedded": {
        "questionAnswerResourceList": [
            {
                "questionAnswerApi": {
                    "active": true,
                    "itemId": "9978602",
                    "alternative": null,
                    "externalSystemCorrelationId": "KI_1579537",
                    "processId": null,
                    "questionnaireId": "Doc7999335",
                    "searchTerm": null,
                    "answer": "test",
                    "enumerationCodeDelimiters": null,
                    "dataType": "String",
                    "multiValued": false,
                    "smVendorId": "S1830600",
                    "workspaceType": null,
                    "workspaceId": "WS7999332",
                    "type": null,
                    "totalQuestions": "1",
                    "questionnaireLabel": "Subcontractor specific content",
                    "questionLabel": "Please provide all the subcontractor details in the attached file",
                    "answerType": "ShortText",
                    "rootId": "68:QUESTANS:82020",
                    "timeUpdated": 1516903604910
                }
            }
        ]
    }