From eec037892739ca2b1c30dce01e6b3f25c37f5ac6 Mon Sep 17 00:00:00 2001 From: NPJ-OP-LUX Date: Thu, 5 Dec 2024 09:09:41 +0000 Subject: [PATCH] [CI] Publish Documentation for 9d27105282cad54079a30bb3a0bcfada510e4868 --- api/3.0/convert.html | 51 +- api/3.0/search.html | 75 +- eforms-common/FAQ/index.html | 15 +- eforms-common/active-versions/index.html | 13 +- .../articles/eforms-change-management.html | 17 +- eforms-common/eforms-core/index.html | 13 +- eforms-common/efx-toolkit/index.html | 13 +- eforms-common/index.html | 13 +- eforms-common/notice-editor/index.html | 13 +- eforms-common/notice-viewer/index.html | 13 +- eforms-common/preview/index.html | 44 +- eforms-common/roadmap/index.html | 15 +- eforms-common/sdk2/efx2.html | 13 +- eforms-common/sdk2/index.html | 13 +- eforms-common/versioning/index.html | 15 +- .../articles/eforms-change-management.html | 9 + sitemap-EPO.xml | 132 +- sitemap-ESPD-EDM.xml | 518 +- sitemap-ODS.xml | 112 +- sitemap-api-home.xml | 2 +- sitemap-api.xml | 24 +- sitemap-eforms-common.xml | 26 +- sitemap-eforms.xml | 11586 ++++++++-------- sitemap-epo-home.xml | 66 +- sitemap-epo-wgm.xml | 676 +- sitemap-espd-home.xml | 14 +- sitemap-espd-wgm.xml | 50 +- sitemap-home.xml | 2 +- sitemap-reuse.xml | 12 +- 29 files changed, 6845 insertions(+), 6720 deletions(-) create mode 100644 home/eforms/articles/eforms-change-management.html diff --git a/api/3.0/convert.html b/api/3.0/convert.html index dc88b7731be..d6772a65a29 100644 --- a/api/3.0/convert.html +++ b/api/3.0/convert.html @@ -250,27 +250,68 @@

TED API

Conversion API

+
+

Purpose

+
-

Conversion API provides operation:

+

Converts legacy TED XML notices into current eForms notices, to facilitate continuity and consistency in data.

+
+
+
+

What It Does

+
+
+
    +
  • +

    Transforms legacy TED XML notice formats into "partial" eForms notices, which can then be completed by users.

    +
  • +
  • +

    Bridges the gap between legacy systems and the eForms standard that is currently in use.

    +
  • +
+
+
+
+
+

Why This API Exists

+
+
+

As eForms replaced legacy TED XML notices, the Conversion API simplifies the transition by enabling systems to convert older formats automatically. This ensures compatibility and preserves access to critical procurement data.

+
+
+
+
+

Endpoint

+
-
POST /v3/notices/convert
+
POST /v3/notices/convert    Convert TED XML notices into partial eForms notices
+
+
+
+

Who Uses This API

+
  • -

    This operation returns a partial eForms notice as a result of conversion of XML notice in the old TED XML format

    +

    eSenders migrating legacy data to the eForms ecosystem.

  • -

    Request body contains notice content in TED XML format.

    +

    Developers managing legacy procurement notices.

  • -

    CustomizationID element in the returned eForms notice is set to the latest value maintained for conversion and this value can change in time.

    +

    eNotices2 web user interface when users select to import a published TED XML notice to continue a procedure.

+
+

Explore the full documentation here: https://github.com/OP-TED/ted-xml-data-converter

+
+
+
diff --git a/api/3.0/search.html b/api/3.0/search.html index 65af6ff7423..f78067ddc67 100644 --- a/api/3.0/search.html +++ b/api/3.0/search.html @@ -250,48 +250,79 @@

TED API

Search API

+
+

Purpose

+
-

Search API provides operation:

+

Allows developers to search and retrieve published procurement notices and their data.

-
-
-
POST /v3/notices/search
+
+

What It Does

+
  • -

    This operation returns list of published notices matching the search query and their data.

    +

    Provides access to published notices via expert queries.

  • -

    Parameter query is mandatory and contains query description using expert search syntax.

    -
  • -
  • -

    Parameter fields is mandatory and contains list of fields to be returned with each notice matching the search query.

    -
  • -
  • -

    Parameter page specifies a sequential number of the page to be returned from the search results with a pagination applied. If not specified, value 0 is used as default.

    -
  • -
  • -

    Parameter limit specifies page size as number of results to be returned per page. If not specified, value 10 is used as default.

    -
  • -
  • -

    Parameter scope specifies scope of search. (LATEST: only notices of the current OJ S release, ACTIVE: only active notices, ALL: all notices). If not specified, value LATEST is used as default.

    +

    Enables bulk downloads of notices in XML format for analysis or reuse.

  • +
+
+
+
+
+

Why This API Exists

+
+
+

The Search API is mostly targeted to data reusers; it ensures transparency and accessibility by making publicly available procurement data easy to find and reuse.

+
+
+
+
+

Endpoint

+
+
+
+
POST /v3/notices/search		Search and retrieve published notices
+
+
+
+
+
+

Special Features

+
+
+

This API does not require authentication, making it accessible to any system or user.

+
+
+
+
+

Who Uses This API

+
+
+
  • -

    Parameter checkQuerySyntax specifies if the search is to be executed (false), or only the syntax of the query is to be checked, but the search query is not executed. When not specified, value false is used as default.

    +

    Commercial organisations providing added-value services to vendors and buyers by integrating TED data into their platforms.

  • -

    Parameter paginationMode specifies type of pagination to be applied. The PAGE_NUMBER mode allows retrieval up to 15000 notices for a given query, using pagination. To retrieve more notices, it is possible to use the ITERATION mode. ITERATION mode does not have limitation on the number of retrievable notices, but in this case it is not possible to choose the specific page. The first request will return an iterationNextToken that should be provided to the next call of the search endpoint in order to retrieve the next result page. If not specified, PAGE_NUMBER value is used as default.

    +

    Researchers analysing public procurement trends.

  • -

    Parameter onlyLatestVersions specifies if all versions of matching notices is to be returned, or only the latest versions. If not specified, value true is used as default.

    +

    Developers creating transparency tools or reusing public data.

  • -

    Parameter iterationNextToken specifies Opaque token returned by the previous call to the search endpoint to retrieve the next result page. It shouldn’t be provided in PAGE_NUMBER mode or if this is the first request in ITERATION mode.

    +

    eNotices2 web interface when a user imports a notice from TED to continue a procedure.

+ +
+
diff --git a/eforms-common/FAQ/index.html b/eforms-common/FAQ/index.html index bcbff59d4a4..6f660b449f1 100644 --- a/eforms-common/FAQ/index.html +++ b/eforms-common/FAQ/index.html @@ -80,22 +80,25 @@

eForms SDK

diff --git a/eforms-common/active-versions/index.html b/eforms-common/active-versions/index.html index 3ea000737a2..5fa11a47379 100644 --- a/eforms-common/active-versions/index.html +++ b/eforms-common/active-versions/index.html @@ -80,22 +80,25 @@

eForms SDK

-
-

We are working on resolving the following limitations and known issues:

-
-
-
    -
  • -

    Since SDK 1.7, the dispatch date (BT-05) rule checks the value against the current date. The rule may be currently more permissive, but as of SDK 2.0, it will strictly only allow the dispatch date to be between 0 and 24 hours before actual reception date/ time.

    -
  • -
-
@@ -865,12 +858,27 @@

-The validation mode "dynamic" checks data that may vary in time, e.g. the current date or information in another notice. +The validation mode "dynamic" checks data that may vary in time, e.g. the current date or, in the future, information in another notice.
+
+

Known issues

+
+
    +
  • +

    Since SDK 1.7, the dispatch date (BT-05) rule checks the value against the current date. The rule may be currently more permissive, but as of SDK 2.0, it will strictly only allow the dispatch date to be between 0 and 24 hours before actual reception date/ time.

    +
  • +
  • +

    A concurrency bug might cause incorrect validation reports to be returned if validation requests are processed simultaneously for different notice subtypes. +This only affects notices validated with SDK version 1.9 or below. In SDK 1.10 and later, the schematron rules have a different structure that does not trigger this bug. +This does not affect the version in Production, and will be resolved in the next version.

    +
  • +
+
+

TED Viewer

@@ -929,7 +937,7 @@

Pla

-

Known issues

+

Known issues

  • diff --git a/eforms-common/roadmap/index.html b/eforms-common/roadmap/index.html index f9b347fb216..cc5aeb433ee 100644 --- a/eforms-common/roadmap/index.html +++ b/eforms-common/roadmap/index.html @@ -80,22 +80,25 @@

    eForms SDK