Add Blocks to a Workflow (API)

Get Data and Processing Blocks

In this guide, you will learn how to search for data and processing blocks. After selecting the blocks, you can add them one by one to the previously created workflow. Blocks are added as workflow tasks.

In this example, you will populate the empty workflow with blocks used to compute the Normalized Difference Vegetation Index from a Pléiades satellite image. The following data and processing blocks are used:

• Pléiades Reflectance (Download)

• Pan-sharpening

• NDVI

Get Blocks IDs and Block Names

First, get the block names (both docker names and display names) together with their corresponding block ID (see examples in the tables below).

curl -s GET -H "Authorization: Bearer $PTOKEN" https://api.up42.com/blocks \
| jq -r '.data[] | .displayName + " : " + .id'

Filter Block IDs by Name

Alternatively, get the block ID depending on the display name (change it according to your selected block):

curl -s GET -H "Authorization: Bearer $PTOKEN" https://api.up42.com/blocks \
| jq -r '.data[] | select(.displayName=="Pléiades Reflectance (Download)") | .id'

Add Workflow Tasks

Add First Block

Create a file containing the request body with the first workflow task (task1_request.json). A task is associated with a block. The request body contains an array with one object that has the properties of the first block: the block name, the name of the parent block and the previously extracted block ID. By default, the first block has no parent. We strongly recommend using block names without spaces.

[{
 "name":"block1",
 "parentName":null,
 "blockId": "defb134b-ca00-4e16-afa0-639c6dc0c5fe"
 }]

Add the first task to the workflow by using the request body:

curl -s POST -H "Authorization: Bearer $PTOKEN" -H 'Content-Type: application/json' \
https://api.up42.com/projects/$PROJ/workflows/$NEW_WORKFLOW/tasks \
-d @task1_request.json | jq '.'

Get Compatible Blocks

Use the same request body to get the blocks compatible with the first block and extract their name and IDs. The block name has to be identical with the name specified as a query parameter (e.g. block1).

curl -s POST -H "Authorization: Bearer $PTOKEN" -H 'Content-Type: application/json' \
https://api.up42.com/projects/$PROJ/workflows/compatible-blocks?parentTaskName=block1 \
-d @task1_request.json | jq '.data.blocks[] | .name,.blockId'

Add Second Block

To add the second task to the workflow, you need to first create a file containing the request body that includes all the tasks you previously added, along with the task you want to add next (task2_request.json):

[{
 "name":"block1",
 "parentName":null,
 "blockId": "defb134b-ca00-4e16-afa0-639c6dc0c5fe"
 },
 {
 "name":"block2",
 "parentName":"block1",
 "blockId": "903f0435-d638-475e-bbe9-53b5664a22a8"
 }]

Add the second task to the workflow by using the request body:

curl -s POST -H "Authorization: Bearer $PTOKEN" -H 'Content-Type: application/json' \
https://api.up42.com/projects/$PROJ/workflows/$NEW_WORKFLOW/tasks \
-d @task2_request.json | jq '.'

Get Compatible Blocks

Use the same request body to get the blocks compatible with the second block. The block name has to be identical with the name specified as a query parameter (e.g. block2).

curl -s POST -H "Authorization: Bearer $PTOKEN" -H 'Content-Type: application/json' \
https://api.up42.com/projects/$PROJ/workflows/compatible-blocks?parentTaskName=block2 \
-d @task2_request.json | jq '.data.blocks[] | .name,.blockId'

Add Third Block

To add the third task to the workflow, you need to first create a file containing the request body that includes all the tasks you previously added, along with the task you want to add next (task3_request.json):

[{
 "name":"block1",
 "parentName":null,
 "blockId": "defb134b-ca00-4e16-afa0-639c6dc0c5fe"
 },
 {
 "name":"block2",
 "parentName":"block1",
 "blockId": "903f0435-d638-475e-bbe9-53b5664a22a8"
 },
 {
 "name":"block3",
 "parentName":"block2",
 "blockId": "d0da4ac9-94c6-4905-80f5-c95e702ca878"
 }]

Add the third task to the workflow by using the request body:

curl -s POST -H "Authorization: Bearer $PTOKEN" -H 'Content-Type: application/json' \
https://api.up42.com/projects/$PROJ/workflows/$NEW_WORKFLOW/tasks \
-d @task3_request.json | jq '.'

You can also get the blocks compatible with the third block and add another task to the workflow. In this guide, we will only add 3 tasks to the workflow and then continue with configuring the job of the newly-created workflow.

Next Steps

To proceed, please go to Configure Job (API).