Access to Master Data Management functions via APIs
Access to Master Data Management functions via APIs¶
Introduction¶
CCH Tagetik makes it possible to run Master Data Management data processing via APIs (RESTful APIs) developed according to the OData V4.0 standard.
| STATUS | SWAGGER | |
| ACTIVE | - |
|
| FORMAT | ROOT ENDPOINT | |
| REST / OpenAPI | <api root>/mdm |
Certain conditions must be met to use this consultation method.
Access conditions¶
To be able to use these specific APIs, the user must be authenticated (Basic Auth, OAuth2).
APIs must also be enabled in the Repository. For reverse proxies, further settings are necessary. They can be used with both http and https protocols.
For more details on authentication and enabling, see REST API Overview.
API for running the export (DB to File)¶
Method¶
POST
URL¶
<api-root>/mdm/export/v1/routine_code
Parameters¶
routine_code = routine MDM to be exported
IMPORTANT: If the indicated Routine MDM is not DB to File, an error message is returned.
Data returned¶
In the response, the following ID will be returned in JSON format:
dataprocessingId = data processing ID.
E.g.: { "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }
API for checking export status (DB to File)¶
Method¶
GET
URL¶
<api-root>/mdm/export/v1/dataprocessingId
Data returned¶
In the response, the data processing status will be returned in JSON format:
status: RUNNING/FAILED/COMPLETED
| Status | Description |
|---|---|
| RUNNING | Running |
| FAILED | Failed |
| COMPLETED | Completed successfully |
E.g.: {"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}
fileName_[routine_name]: name of the produced file
E.g.: {"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED", "parameters": {"fileName_001": "tcpm_mdmTables_USER_DB_xxx_part_1_of_1.zip"}}
API for stopping the export (DB to File)¶
Method¶
DELETE
URL¶
<api-root>/mdm/export/v1/dataprocessingId
Data returned¶
In the response, the following ID will be returned in JSON format:
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| Message | Description |
|---|---|
| Stop on dataprocessingOid | Requests the interruption of data processing still running |
| Notify on dataprocessingOid | Requests the interruption of data processing that has already ended. The system responds with the end of processing message. |
E.g.: {"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}
API for running the import (File to DB)¶
Method¶
POST
URL¶
<api-root>/mdm/import/v1/routine_code
Parameters¶
routine_code = routine MDM to be imported
IMPORTANT: If the indicated Routine MDM is not File to DB, an error message is returned.
Property¶
The following properties can be included in JSON format in the body of the request.
| Property | Description | Options |
|---|---|---|
| filename | Mandatory. Files to import. | - |
| endpoint | Endpoint to be used if the file is located in a remote directory. See Endpoint page. | - |
| dir | Directory in which the files are located | If an endpoint is specified, it allows the sub-directory to be specified based on the endpoint’s root. If an endpoint has not been specified, the following can be specified: - empty field = directory configured as a CCH Tagetik writable folder - relative path = writable folder sub-directory - absolute path = generic directory indicated in the Allowed Directories |
Examples¶
{ "filename":"export.zip", "endpoint":"", "dir":""} - import of the "export.zip" file from the Writable folder
{ "filename":"export.zip", "endpoint":"", "dir":"tmp"} - import of the "export.zip" file from the "tmp" sub-directory of the Writable folder
{ "filename":"export.zip", "endpoint":"", "dir":"C:\impexp"} - import of the "export.zip” file from the "C:\impexp” directory
{ "filename":"export.zip", "endpoint":"SFTP", "dir":""} - import of the "export.zip" file via the SFTP endpoint
{ "filename":"export.zip", "endpoint":"SFTP", "dir":"tmp"} - import of the "export.zip" file present in the "tmp" sub-directory of the SFTP endpoint
Data returned¶
In the response, the following ID will be returned in JSON format:
dataprocessingId: data processing ID.
E.g.: { "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }
API for checking import status (File to DB)¶
Method¶
GET
URL¶
<api-root>/mdm/import/v1/dataprocessingId
Data returned¶
In the response, the data processing status will be returned in JSON format:
status: RUNNING/FAILED/COMPLETED
| Status | Description |
|---|---|
| RUNNING | Running |
| FAILED | Failed |
| COMPLETED | Completed successfully |
E.g.: {"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}
API for stopping the import (File to DB)¶
Method¶
DELETE
URL¶
<api-root>/mdm/import/v1/dataprocessingId
Data returned¶
In the response, the following ID will be returned in JSON format:
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| Message | Description |
|---|---|
| Stop on dataprocessingOid | Requests the interruption of data processing still running |
| Notify on dataprocessingOid | Requests the interruption of data processing that has already ended. The system responds with the end of processing message. |
E.g.: {"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}
API for running the import (DB to DB)¶
Method¶
POST
URL¶
<api-root>/mdm/import/v1/routine_code
Parameters¶
routine_code = routine MDM to be imported
IMPORTANT: If the indicated Routine MDM is not DB to DB, an error message is returned.
Data returned¶
In the response, the following ID will be returned in JSON format:
dataprocessingId = data processing ID
E.g.: { "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }
API for checking import status (DB to DB)¶
Method¶
GET
URL¶
Data returned¶
In the response, the data processing status will be returned in JSON format:
status: RUNNING/FAILED/COMPLETED
| Status | Description |
|---|---|
| RUNNING | Running |
| FAILED | Failed |
| COMPLETED | Completed successfully |
E.g.: {"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}
API for stopping the import (DB to DB)¶
Method¶
DELETE
URL¶
<api-root>/mdm/import/v1/dataprocessingId
Data returned¶
In the response, the following ID will be returned in JSON format:
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| Message | Description |
|---|---|
| Stop on dataprocessingOid | Requests the interruption of data processing still running |
| Notify on dataprocessingOid | Requests the interruption of data processing that has already ended. The system responds with the end of processing message. |
E.g.: {"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}