API Documentation

The DDB API is made up of a number of different microservices. Below you can see the different services you can interact with, along with how to authenticate and get access.

Microservices

Our API is segregated into microservices.

Microservice	Purpose
Comments Service	Hosts threaded comments that relate to a variety of systems, assets and parameters.
Environment Context Service	Stores the current projects in DDB and links to wider Arup systems via ADS.
Parameter Metadata Service	Provides metadata on assets and parameters on projects.
Parameter Service	Stores asset and parameter data on projects and holds the DDB taxonomy.
QA Service	Stores the QA data relating to parameters and entries.
Reference Data Service	Defines references to internal and external sources. Holds the sources of parameter values.
Template Service	Holds template structures of parameters and assets that can be used for content creation and automated processes.
User Service	Manages users' roles on projects to define access permissions per projects.

Each microservice has an independent instance for each of the three environments. For a recap of the purpose of each environment, see here.

The following table includes links to each microservice, for each environment.

Microservice	*Development	Sandbox	Production
Comments Service	comments_service	comments_service	comments_service
Environment Context Service	environment_context_ service	environment_context_ service	environment_context_ service
Parameter Metadata Service	parameter_metadata_ service	parameter_metadata_ service	parameter_metadata_ service
Parameter Service	parameter_service	parameter_service	parameter_service
QA Service	qa_service	qa_service	qa_service
Reference Data Service	reference_data_ service	reference_data_ service	reference_data_ service
Template Service	template_service	template_service	template_service
User Service	user_service	user_service	user_service

*Only the DDB Development team should be using the Development Environment

All the different services use the same base url (e.g. https://ddb.arup.com (opens new window)) and are routed to according to their url.

Each microservice is defined in using Open API 3.0 (Swagger). If you are unsure of API endpoints related to your process contact the Onboarding team for more support.

Coming Soon

Microservice	Purpose
Audit Service	Stores a log of all events and returns a history of changes within a given scope.

API Flow

Diagram below is summarizing steps to take when trying to get and post parameters to the DDB.

Diagram of API calls needed

If you are unsure where to place your data in the DDB asset hierarchy or you are missing asset tree hierarchy, contact the Onboarding team for more support. (opens new window)