Think of deep insertion as a one-stop shop for creating complex data. Instead of making multiple API calls to build out different parts of your data, you can send all the necessary information in a single request.How it Works#
Main Object: The core piece of data you want to create.
Related Objects: Additional data connected to the main object.
Single API Call: You send the main object and its related objects in one request.
Example: Creating a Board with Collections, Statuses, and Labels#
Imagine a project management tool where you want to create a new board with pre-defined collections, statuses, and labels.Board: The main object with properties like name, description, etc.
Collection: Related object with properties like name, description.
Status: Related object with properties like name, color.
Label: Related object with properties like name, color.
{
"name": "My Board",
"description": "A board with everything",
"collections": [
{ "name": "To Do", "description": "Tasks to be done" },
{ "name": "In Progress", "description": "Tasks in progress" },
{ "name": "Done", "description": "Completed tasks" }
],
"statuses": [
{ "name": "Open", "color": "green" },
{ "name": "In Review", "color": "yellow" },
{ "name": "Closed", "color": "red" }
],
"labels": [
{ "name": "Bug", "color": "purple" },
{ "name": "Feature", "color": "blue" }
]
}
Modified at 2024-10-04 09:04:56
