API of transformation engine (0.9.0)

Download OpenAPI specification:

URL: ../provoly-back/main/index.html License: Apache 2.0

The transformation engine API can be used to configure transformations.

Version

Returns the deployed application and helm package version

Responses

Response samples

200

Content type

application/json

{"applicationVersion": "dev",
"chartVersion": "dev"
}

Transfo

List all registered transformations and their details.

Authorizations:

oidc

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"title": "string",
"gui": {"pos": [0
],
"size": [0
]
},
"spec": { }
}
],
"links": [{"start": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slot": 0
},
"end": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slot": 0
}
}
],
"title": "string",
"description": "string",
"nodeNumber": 0,
"creationDate": "2022-03-10T16:15:50Z",
"jobInstanceId": "935a9a61-f517-4e5e-8b5d-5e3c1781adf6",
"active": true,
"lastJobExecution": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instance": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"model": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"image": "string",
"parameters": [{"name": "string"
}
]
},
"inDataSources": [{"method": "KAFKA_TOPIC",
"dataSourceId": "2b37f84c-d876-441e-9b27-0c3482a7c574"
}
],
"outDatasets": [{"method": "KAFKA_TOPIC",
"datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
],
"parametersValue": [{"name": "string",
"value": "string"
}
],
"active": true
},
"status": "STARTED",
"executionDate": "2022-03-10T16:15:50Z"
}
}
]

Create or update a transformation

Create and validate transformation.

If the transformation already exists, then update parameters.

Active transformations can't be updated.

Return a TransfoStatus Class whose describe parameters and show errors.

Authorizations:

oidc

Request Body schema: application/json

id	string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
	Array of objects (NodeDto)
	Array of objects (LinkDto)
title	string
description	string

Responses

Request samples

Payload

Content type

application/json

Example

Create/update transformation

Request body content all needed information ton create / update a transformation

{"id": "9c99f2d5-6e33-4e18-825b-3352c631e431",
"title": "filtre station velos",
"links": [{"start": {"id": "b15c7f78-3dfe-40fb-91c7-77e13f1aba8c",
"slot": 0
},
"end": {"id": "ab9f19ab-e7e4-43e5-87bc-532cde7f1aeb",
"slot": 0
}
},
{"start": {"id": "ab9f19ab-e7e4-43e5-87bc-532cde7f1aeb",
"slot": 0
},
"end": {"id": "67717502-77ca-408c-8200-9ec14620888d",
"slot": 0
}
}
],
"nodes": [{"gui": {"pos": [132,
198
],
"size": [140,
26
]
},
"id": "b15c7f78-3dfe-40fb-91c7-77e13f1aba8c",
"spec": {"datasetId": "423b5c01-1816-41d4-b358-200000000005"
},
"title": "InputDatasource",
"type": "com.provoly.common.transfo.InputDatasource"
},
{"gui": {"pos": [246,
403
],
"size": [140,
46
]
},
"id": "67717502-77ca-408c-8200-9ec14620888d",
"spec": {"dataset": "423b5c01-1816-41d4-b358-200000000010"
},
"title": "OutputDataset",
"type": "com.provoly.common.transfo.OutputDataset"
},
{"gui": {"pos": [426,
253
],
"size": [140,
26
]
},
"id": "ab9f19ab-e7e4-43e5-87bc-532cde7f1aeb",
"spec": {"attributeName": "freeSpace",
"operator": "GREATER_THAN",
"value": "50"
},
"title": "Filter",
"type": "com.provoly.common.transfo.Filter"
}
]
}

Response samples

200
400
404

Content type

application/json

Example

Create/update transformation

{"errors": [ ],
"status": [{"nodeId": "ab9f19ab-e7e4-43e5-87bc-532cde7f1aeb",
"outModel": {"attributes": {"freeSpace": {"name": "freeSpace",
"type": "integer"
},
"name": {"name": "name",
"type": "keyword"
},
"totalSpace": {"name": "totalSpace",
"type": "integer"
}
}
},
"errors": [ ]
},
{"nodeId": "b15c7f78-3dfe-40fb-91c7-77e13f1aba8c",
"outModel": {"attributes": {"freeSpace": {"name": "freeSpace",
"type": "integer"
},
"name": {"name": "name",
"type": "keyword"
},
"totalSpace": {"name": "totalSpace",
"type": "integer"
}
}
},
"errors": [ ]
},
{"nodeId": "67717502-77ca-408c-8200-9ec14620888d",
"outModel": { },
"errors": [ ]
}
]
}

Retrieved information of a transformation.

Retrieve all transformation information referenced by given ID.

Authorizations:

oidc

path Parameters

id

required

string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

200

Content type

application/json

This transformation is a filter.

{"id": "9c99f2d5-6e33-4e18-825b-3352c631e431",
"nodes": [{"id": "ab9f19ab-e7e4-43e5-87bc-532cde7f1aeb",
"type": "com.provoly.common.transfo.Filter",
"title": "Filter",
"gui": {"pos": [426,
253
],
"size": [140,
26
]
},
"spec": {"attributeName": "freeSpace",
"operator": "GREATER_THAN",
"value": "50"
}
},
{"id": "b15c7f78-3dfe-40fb-91c7-77e13f1aba8c",
"type": "com.provoly.common.transfo.InputDatasource",
"title": "InputDatasource",
"gui": {"pos": [132,
198
],
"size": [140,
26
]
},
"spec": {"datasetId": "423b5c01-1816-41d4-b358-200000000005"
}
},
{"id": "67717502-77ca-408c-8200-9ec14620888d",
"type": "com.provoly.common.transfo.OutputDataset",
"title": "OutputDataset",
"gui": {"pos": [246,
403
],
"size": [140,
46
]
},
"spec": {"dataset": "423b5c01-1816-41d4-b358-200000000010"
}
}
],
"links": [{"start": {"id": "b15c7f78-3dfe-40fb-91c7-77e13f1aba8c",
"slot": 0
},
"end": {"id": "ab9f19ab-e7e4-43e5-87bc-532cde7f1aeb",
"slot": 0
}
},
{"start": {"id": "ab9f19ab-e7e4-43e5-87bc-532cde7f1aeb",
"slot": 0
},
"end": {"id": "67717502-77ca-408c-8200-9ec14620888d",
"slot": 0
}
}
],
"title": "filtre station velos",
"nodeNumber": 3,
"creationDate": "2023-07-28 14:08:21",
"active": false
}

Delete a transformation

Delete the referenced transformation in given ID. Nodes and links are deleted too.

Authorizations:

oidc

path Parameters

id

required

string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Create a Job Instance for the referenced transformation.

Activate the referenced transformation. That generates a job instance that will execute the transformation. If the transformation is invalid, an error message is returned. Also note that invalid transformation can't be activated.

Authorizations:

oidc

path Parameters

id

required

string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Deactivation of a transformation.

Deactivate the referenced ID in the given parameters. Deactivate a transformation means delete all linked job instances. If any error is thrown jobs are not deleted.

Authorizations:

oidc

path Parameters

id

required

string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Return transformation status.

Return all details about given transformation with ID parameter.

Authorizations:

oidc

path Parameters

id

required

string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

200

Content type

application/json

{"errors": [{ }
],
"status": [{"nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
"outModel": {"attributes": {"property1": {"name": "string",
"type": "string"
},
"property2": {"name": "string",
"type": "string"
}
}
},
"errors": [{ }
]
}
]
}