Retrieving Attachments from Process Intake Forms or Modular Questionnaires Using the Supplier Data API with Pagination and External Approval API Integration

This topic explains how to use the Supplier Data API with Pagination to download attachments from process intake forms or modular questionnaires.

Prerequisites

Procedure

  1. Use the processes endpoint to request all process IDs for a supplier. For example, to return basic information about all processes for the supplier with SM vendor ID S10028001:
    GET {{runtime_URL}}/supplierdatapagination/v4/prod/vendors/S10028001/processes
  2. Use the processes/{wid} endpoint to request the documentation ID of the process intake form or questionnaire. For example, to return details for the process with workspace ID WS19708:
    GET {{runtime_URL}}/supplierdatapagination/v4/prod/vendors/S10028001/processes/WS19708
  3. Use the versions endpoint to request intake form details or questionnaire details in the latest version. For example, to return details of the intake form with document ID Doc12345678 for the supplier with SM vendor ID S10028001:
    GET {{runtime_URL}}/supplierdatapagination/v4/prod/vendors/S10028001/workspaces/questionnaires/Doc12345678/qna/versions

    The process intake form details in the latest version are returned in the response. According to the latest version ID, you can know the number of versions that the intake form has.

  4. Optional: Use the versions/{versionId} endpoint to request intake form details or questionnaire details in a specific version, for example, version 3.
    GET {{runtime_URL}}/supplierdatapagination/v4/prod/vendors/S10028001/workspaces/questionnaires/Doc12345678/qna/versions/3
  5. Use the /{entity_type}/{entity_id} endpoint to retrieve the details for the intake form or questionnaire, including any attachment IDs. For example, you can retrieve attachment id Doc12345678, AANcAe2G2!4WA, AANcAH42!4Wg.
    GET {{runtime_URL}}/entity.svc/RFXDcoument/Doc12345678
    For more information, see Entity_type and Entity_id Values.
  6. Use the {entity_type}/{entity_id}/attachments/{attachment_id} endpoint to download the attachment from the intake form or questionnaire. For example:
    GET {{runtime_URL}}/entity.svc/RFXDcoument/Doc12345678/attachments/Doc12345678,AANcAe2G2!4WA,AANcAH42!4Wg
    For more information, see Entity_type and Entity_id Values.

Results

The attachment is downloaded from the specified intake from or modular questionnaire.