Sidra API module: Data Factory¶
It contains endpoints to implement CRUD operations over the information related to Data Factory. More information can be found in the Data Factory tables section.
ActivityTemplates¶
It contains CRUD endpoints to:
- The
ActivityTemplatetable. - The association between an activity template and a pipeline template. Both must be created before establish the association between them. Updating the association is not supported.
DataFactories¶
It allows to retrieve all or a specific Data Factory configured in the platform. Since the information of the Data Factory represents an Azure Data Factory resource, it is not allowed to create, delete nor modify them using the API.
DataSetTemplates¶
It contains CRUD endpoints to:
- The
DataSetTemplatetable. - The association between a dataset template and a pipeline template. Both must be created before establish the association between them. Updating the association is not supported.
Pipelines¶
It contains CRUD endpoints to Pipeline table. Pipelines must be related to a pipeline template and it is required to provide the Id of the template during the creation of the pipeline.
PipelineTemplates¶
It contains CRUD endpoints to PipelineTemplate table. When creating a new pipeline template, it must be provided the Id of the type of pipeline template and the Id of the platform.
These are the available types of pipeline templates:
| Id | Name |
|---|---|
| 1 | Ingestion |
| 2 | System |
| 3 | DW |
| 4 | Log |
| 5 | Other |
| 6 | LoadRegisteredAsset |
| 7 | AzureSearchIndexer |
These are the available platforms:
| Id | Name |
|---|---|
| 1 | AzureDataFactory |
| 2 | AzureSearch |
Triggers¶
It contains CRUD endpoints to:
- The
Triggerstable. Triggers must be related to a trigger template and to a Data Factory. It is required to provide theIdof the template and the Data Factory during the creation of the trigger. - The association between a trigger and a pipeline. Both must be created before establish the association between them. Updating the association is not supported.
TriggerTemplates¶
It contains CRUD endpoints to TriggerTemplate table.