Generate an output file path from file tree template
POST
/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path
Generate file path based on several parameters: asset instance, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision in case no revision is given in parameter.
Path parameters
-
asset_instance_id string(UUID) Required
-
temporal_entity_id string(UUID) Required
Body
Asset instance, output type, task type, revision, mode, name and separator.
-
name string
Default value is
main. -
mode string
Default value is
output. -
output_type_id string(UUID) Required
-
task_type_id string(UUID) Required
-
extension string
-
representation string
-
revision integer
-
separator string
Default value is
/.
POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path
curl \
-X POST http://localhost:8080/api/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path \
-H "Authorization: $API_KEY" \
-d '{"name":"main","mode":"output","output_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","task_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","extension":"string","representation":"string","revision":42,"separator":"/"}'
Request example
{
"name": "main",
"mode": "output",
"output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
"task_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
"extension": "string",
"representation": "string",
"revision": 42,
"separator": "/"
}