• INIES Public API
    • Getting Started
    • Export API
    • Import API
    • API Changes (Breaking Changes + Changelog)

Import API

Overview

Import endpoints are used to create/update EPDs and manage linked document metadata/content.

Note : Import is restricted to users with specific write permissions to allow for other databases synchronization and EPD management use cases.

Endpoints

Method Path OperationId Description
POST /ws/Epd ImportEpd Import or update an EPD.
POST /ws/Epd/{epdId}/DocumentMultipart CreateOrReplaceEpdDocumentMultipart Create/replace document via multipart (metadata + file).
POST /ws/Epd/{epdId}/Document CreateOrReplaceEpdDocumentMetadata Create/replace document metadata only.
PUT /ws/Epd/{epdId}/Document/{documentId} UploadEpdDocumentBinary Upload binary content for existing document metadata.
DELETE /ws/Epd/{serialIdentifier} ArchiveEpdBySerialIdentifier Archive validated EPD versions by serial identifier.

Creating/Updating

When calling POST /ws/Epd to create or update an EPD, the payload must include the serialIdentifier property to identify the product.

If the provided serialIdentifier does not exist, a new EPD will be created with the provided data.

On the other hand, if the serialIdentifier already exists, the existing EPD will be archived and a new EPD version will be created with the provided data. The response will include the full data of the newly created EPD version, including its new identifier.

Request format notes

  • POST /ws/Epd accepts JSON and XML.
  • Multipart endpoint uses multipart/form-data.
  • Binary upload endpoint accepts application/octet-stream body.

Response notes

  • POST /ws/Epd returns 201 with full EPD payload (EpdFullDataDto).
  • Validation errors use 422 ValidationProblemDetails.
  • Document and resource errors are exposed as ProblemDetails.

Permissions

  • Write permissions are required for all import endpoints.
  • Missing write access may result in 403 Forbidden.
In this article
Back to top Generated by DocFX