MDC Documents System API
home
API Features Summary
This System API enables documents transfer with MDC Records Management Systems
API Overview
| Property | Details |
|---|---|
| Application Technical Name | mdc-documents |
| Application Business Name | MDC Documents System API |
| Mule Application Type | API |
| API Type | |
| Business Domain | Records Management by MDC |
| Purpose of API | This System API enables documents retrieval and transfer with MDC Records Management Systems |
| API Owner | MDC Integration Team |
| Version(s) | 1.0.0 |
| Target Consumers | Externals/Datascape API |
| Consuming Applications/Processes | Externals/Datascape API |
| Design Center URL | https://anypoint.mulesoft.com/designcenter/designer/#/project/7677ad23-2d48-4b58-8f9d-5c1f378e4512 |
| Anypoint Exchange URL | https://anypoint.mulesoft.com/exchange/e952a1f4-b5bf-4939-8f29-d497de78c7af/documents-api-specification/ |
| Environment | Mulesoft URL |
|---|---|
| DEV | https://mdc-documents-dev.au-s1.cloudhub.io/api |
| QA | https://mdc-documents-test.au-s1.cloudhub.io/api |
| PROD | https://mdc-documents.au-s1.cloudhub.io/api |
| Endpoints |
|---|
| POST /containers |
| GET /containers/{containerId} |
| POST /records |
| GET /records/{recordId} |
| POST /records/content |
| GET /healthcheck |
- 4+1 architecture models (only that adds value to consumers)
- Use cases/ Sequence Diagrams
- API-led Connectivity Diagram
- Design Decisions
- CDM Architecture
- Organisation strategy for this particular API
Integration Overview
Technology
The MDC interfaces are web services which return JSON.
GET calls
GET calls are supported by REST APIs retrieving documents from MDC Records Management Systems.
POST calls
External - To post documents to the MDC Records Management Systems, use the Kafka Queue. Internal - Calls that add/update data are supported by sending data and writes into MDC's HPE Content Manager.
Internal - Calls that add/update data are supported by sending data and writes into MDC's HPE Content Manager.
Security
Calls to web service are made over the Internet using HTTPS. The MDC web service API will allow calls from the Datacom specific IP address only.
Interfaces
For API specification summary, click on Summary in the left menu