Using the assessments Endpoint to Find the Supplier Assessments Ready to Import Responses

The GET/assessments/{assessmentName} endpoint of the Engagement Risk Assessment External Response Import API retrieves information about which supplier assessments are ready for responses to be imported.

Context

A response to an assessment can be imported from an external system when:

The modular questionnaire template for the assessment is defined to expect responses imported from an external system. See Setting Up a Modular Questionnaire to Import Supplier Responses from an External System.
For a given supplier, that assessment currently has the status Waiting for Response. It might be that the supplier has never responded to this assessment, or that a buyer has requested an updated response.

The GET/assessments/{assessmentName} endpoint retrieves the list of suppliers for which a specified assessment is currently Waiting for Response.

Procedure

An engagement requestor creates an engagement request, specifying the applicable commodities, regions, and departments.
Based on these values and on the requestor's answers to the inherent risk screening questionnaire, required risk controls are assigned to the engagement request. Each control specifies at least one assessment, a questionnaire whose answers will help the control reviewer determine the effectiveness of the supplier's risk control in the area addressed by the assessment.

The GET/assessments/{assessmentName} endpoint retrieves the list of suppliers for which a specified assessment is currently Waiting for Response.

Example:

GET {{runtime_URL}}/assessments/someAssessment&realm=mySite

Request Body Parameters
Name	Required?	Description
`realm`	Yes	The unique name of the site.
`assessmentName`	Yes	The unique name of the modular questionnaire being used as a risk assessment.

The request returns an array with identifying information for the suppliers in your site for which the specified assessment is currently in status Waiting for Response. Each supplier may have any or all of an SM vendor ID, ANID, or ERP vendor ID. The response array includes all of these values that exist for the supplier. For example:

{
"supplierID": "S100000","AN0000000001","ER123456"
"status": "readyToImport",
}