This document provides an overview of the API endpoints, their supported HTTP methods, visibility status, and the reasons for their current or future public accessibility.

Table of Contents

  1. Assets

    1. As-Built

    2. As-Planned

    3. Import Report

    4. Publish

  2. BPN Configuration

  3. Contracts

  4. Dashboard

  5. EDC Notification Contract

  6. Internal Quality Alerts and Notifications

  7. Notifications

  8. Policies

  9. Registry

Assets

As-Built

GET /assets/as-built

Description: Retrieve a list of as-built assets.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

GET /assets/as-built/*/children/+{childId}+

Description: Retrieve child assets for a specific as-built asset.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

GET /assets/as-built/+{assetId}+

Description: Retrieve details of a specific as-built asset.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

PATCH /assets/as-built/+{assetId}+

Description: Update specific fields of an as-built asset.

Visibility: - Current: Public - Future: Public

Reason for visibility: Is accessed from other instances.

GET /assets/as-built/countries

Description: Retrieve a list of countries associated with as-built assets.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /assets/as-built/detail-Information

Description: Add detailed information to as-built assets.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /assets/as-built/searchable-values

Description: Add searchable values to as-built assets.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /assets/as-built/sync

Description: Synchronize as-built assets across instances.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

As-Planned

GET /assets/as-planned

Description: Retrieve a list of as-planned assets.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

GET /assets/as-planned/*/children/+{childId}+

Description: Retrieve child assets for a specific as-planned asset.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

GET /assets/as-planned/+{assetId}+

Description: Retrieve details of a specific as-planned asset.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

PATCH /assets/as-planned/+{assetId}+

Description: Update specific fields of an as-planned asset.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /assets/as-planned/detail-Information

Description: Add detailed information to as-planned assets.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /assets/as-planned/searchable-values

Description: Add searchable values to as-planned assets.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /assets/as-planned/sync

Description: Synchronize as-planned assets across instances.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

Import Report

GET /assets/import/report/+{importJobId}+

Description: Retrieve the report of a specific asset import job.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

Publish

POST /assets/publish

Description: Publish assets to make them available to other instances.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

BPN Configuration

GET /bpn-config

Description: Retrieve the current BPN (Business Partner Number) configurations.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

PUT /bpn-config

Description: Update the BPN configurations.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /bpn-config

Description: Add new BPN configurations.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

DELETE /bpn-config/+{bpn}+

Description: Delete a specific BPN configuration.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

Contracts

POST /contracts

Description: Create new contracts between instances.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

Dashboard

GET /Dashboard

Description: Retrieve dashboard information.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

EDC Notification Contract

POST /edc/notification/contract

Description: Create contracts for EDC notifications.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

Internal Quality Alerts and Notifications

Note: These endpoints are marked as private and are intended for internal use.

POST /internal/qualityalerts/receive

Description: Receive internal quality alerts.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /internal/qualityalerts/update

Description: Update internal quality alerts.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /internal/qualitynotifications/receive

Description: Receive internal quality notifications.

  • Visibility:

    • Current: Public

    • Future: Public

    Reason for visibility: Is accessed from other instances.

POST /internal/qualitynotifications/update

Description: Update internal quality notifications.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

Notifications

PUT /notification/+{notificationId}+/edit

Description: Edit a specific notification.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /notifications

Description: Create new notifications.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /notifications/filter

Description: Filter notifications based on criteria.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /notifications/searchable-values

Description: Add searchable values to notifications.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

GET /notifications/+{notificationId}+

Description: Retrieve a specific notification.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /notifications/+{notificationId}+/approve

Description: Approve a notification.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /notifications/+{notificationId}+/cancel

Description: Cancel a notification.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /notifications/+{notificationId}+/close

Description: Close a notification.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /notifications/+{notificationId}+/update

Description: Update a notification.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

Policies

GET /policies

Description: Retrieve a list of policies.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

PUT /policies

Description: Update existing policies.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

POST /policies

Description: Create new policies.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

GET /policies/+{policyID}+

Description: Retrieve a specific policy by ID.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

DELETE /policies/+{policyID}+

Description: Delete a specific policy by ID.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.

Registry

GET /registry/reload

Description: Reload the registry data.

  • Visibility:

    • Current: Public

    • Future: Public

Reason for visibility: Is accessed from other instances.