Bulk Low Code Record Operations
Corteza allows you to create create, update or update multiple records with one request.
Creating Bulk Records
A bulk payload where records only define their values create a new record for each entry.
curl -X POST "$BASE_URL/api/compose/namespace/$NAMESPACE_ID/module/$MODULE_ID/record/" \
-H 'accept: application/json, text/plain, */*' \
-H "authorization: Bearer $JWT" \
-H 'content-type: application/json' \
--data-raw '{
"records": [{
"set": [
{"values":[{"name":"f1","value":"a"},{"name":"f1","value":"b"}]},
{"values":[{"name":"f1","value":"a"},{"name":"f1","value":"b"}]}
]
}]
}' \
--compressed
-
$BASE_URLis the URL to your Corteza instance (e.g.https://corteza.mydomain.tld), -
$NAMESPACE_IDis the namespace identifier for which you wish to create records (e.g.257934065070534659), -
$MODULE_IDis the module identifier for which you wish to create records (e.g.257934099950366723), -
$JWTis the access token to authorize the request.
Updating Bulk Records
A bulk payload where records define their recordID and their values will update existing records and their values.
|
Corteza removes any value omitted from the request for the updated record from the existing record. If you wish to preserve it, you must provide the information in the request. |
curl -X POST "$BASE_URL/api/compose/namespace/$NAMESPACE_ID/module/$MODULE_ID/record/" \
-H 'accept: application/json, text/plain, */*' \
-H "authorization: Bearer $JWT" \
-H 'content-type: application/json' \
--data-raw '{
"records": [{
"set": [
{"recordID": "257936153397719043", "values":[{"name":"f1","value":"a edited"},{"name":"f1","value":"b edited"}]},
{"recordID": "257936153565556739", "values":[{"name":"f1","value":"a edited"},{"name":"f1","value":"b edited 2"}]}
]
}]
}' \
--compressed
-
$BASE_URLis the URL to your Corteza instance (e.g.https://corteza.mydomain.tld), -
$NAMESPACE_IDis the namespace identifier for which you wish to update records (e.g.257934065070534659), -
$MODULE_IDis the module identifier for which you wish to update records (e.g.257934099950366723), -
$RECORD_ID_*is therecordIDfor which you wish to update (e.g.257936153397719043), -
$JWTis the access token to authorize the request.
Deleting Bulk Records
A bulk payload where records define their recordID and a deletedAt timestamp deletes the specified records and their values.
curl -X POST "$BASE_URL/api/compose/namespace/$NAMESPACE_ID/module/$MODULE_ID/record/" \
-H 'accept: application/json, text/plain, */*' \
-H "authorization: Bearer $JWT" \
-H 'content-type: application/json' \
--data-raw '{
"records": [{
"set": [
{ "recordID": "$RECORD_ID_0", "deletedAt": "2021-11-15T09:49:22Z" },
{ "recordID": "$RECORD_ID_1", "deletedAt": "2021-11-15T09:49:22Z" },
{ "recordID": "$RECORD_ID_2", "deletedAt": "2021-11-15T09:49:22Z" }
]
}]
}' \
--compressed
-
$BASE_URLis the URL to your Corteza instance (e.g.https://corteza.mydomain.tld), -
$NAMESPACE_IDis the namespace identifier for which you wish to delete records (e.g.257934065070534659), -
$MODULE_IDis the module identifier for which you wish to delete records (e.g.257934099950366723), -
$RECORD_ID_*is therecordIDfor which you wish to delete (e.g.257936153397719043), -
$JWTis the access token to authorize the request.