Skip to main content

Related Digital Product Passports (DPPs) Management

This API allows users to manage related DPPs by searching for existing DPPs and associating related files, tech cards, and characteristics with a target DPP.


View ModelsView Models

1. Search DPPs

Parameters:

  • userId: The ID of the user requesting DPPs.

Response:

StatusDescription
200 OKSuccessfully fetched related DPPs.
400 Bad RequestMissing userId parameter.
500 Internal Server ErrorAn error occurred while fetching DPPs.

Response Object:

{
"message": "DPPs fetched successfully",
"dpps": [
{
"id": "string",
"company_id": "string",
"name": "string",
"description": "string",
"type": "string",
"created_at": "string",
"updated_at": "string",
"related_dpps": ["string"]
}
],
"ok": true
}

POST /related-dpps/:companyId/:dppId

Parameters:

  • companyId: The ID of the company owning the target DPP.
  • dppId: The ID of the target DPP.

Request Body:

{
"relatedDppIds": ["string"]
}

Response:

StatusDescription
200 OKRelated DPPs created successfully.
400 Bad RequestMissing or invalid parameters: companyId, dppId, or relatedDppIds.
404 Not FoundTarget DPP not found for the provided dppId and companyId.
500 Internal Server ErrorAn error occurred while creating related DPPs.

Response Object:

{
"message": "Related DPPs created successfully",
"updatedDppId": "string",
"related_files": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "string",
"path": "string",
"url": "string",
"created_at": "string",
"updated_at": "string"
}
],
"related_tech_cards": [
{
"id": "string",
"name": "string",
"description": "string",
"characteristics": [
{
"id": "string",
"characteristic": "string",
"dpp_card_id": "string"
}
]
}
],
"ok": true
}