Create the Model
Developing
POST
/model/
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/model/' \
--header 'Content-Type: application/json' \
--data-raw '{
"PickModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the model (CUID)"
},
"name": {
"type": "string",
"description": "Name of the pick model"
},
"type": {
"type": "string",
"description": "Type of the pick model"
},
"imageUrl": {
"type": "string",
"nullable": true,
"description": "URL of the model image"
},
"iconName": {
"type": "string",
"nullable": true,
"description": "Name of the icon for UI representation"
},
"description": {
"type": "string",
"nullable": true,
"description": "Description of the model"
},
"superStructureId": {
"type": "string",
"nullable": true,
"description": "ID of the associated super structure"
},
"subStructureId": {
"type": "string",
"nullable": true,
"description": "ID of the associated sub structure"
},
"parentModelId": {
"type": "string",
"nullable": true,
"description": "ID of the parent model"
},
"rootModelId": {
"type": "string",
"nullable": true,
"description": "ID of the root model"
},
"organizationId": {
"type": "string",
"nullable": true,
"description": "ID of the organization"
},
"completedLevel": {
"type": "number",
"format": "float",
"nullable": true,
"description": "Completion level of the model"
},
"isRoot": {
"type": "boolean",
"default": false,
"description": "Indicates if this is a root model"
},
"createdById": {
"type": "string",
"nullable": true,
"description": "User ID who created the model"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the model was created"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the model was last updated"
},
"isArchived": {
"type": "boolean",
"default": false,
"description": "Indicates if the model is archived"
},
"isDeleted": {
"type": "boolean",
"default": false,
"description": "Indicates if the model is deleted"
},
"status": {
"type": "string",
"nullable": true,
"default": "active",
"description": "Status of the model (e.g., active, inactive)"
},
"projectModel": {
"type": "array",
"items": { "type": "object" },
"description": "Linked project models"
},
"superStructure": {
"type": "object",
"nullable": true,
"description": "Related super structure entity"
},
"createdBy": {
"type": "object",
"nullable": true,
"description": "User who created the model"
},
"attributes": {
"type": "array",
"items": { "type": "object" },
"description": "List of attributes for the model"
},
"templates": {
"type": "array",
"items": { "type": "object" },
"description": "Associated templates"
},
"parentModel": {
"type": "object",
"nullable": true,
"description": "Reference to the parent model"
},
"rootModel": {
"type": "object",
"nullable": true,
"description": "Reference to the root model"
},
"childModels": {
"type": "array",
"items": { "type": "object" },
"description": "Child models in the hierarchy"
},
"rootModels": {
"type": "array",
"items": { "type": "object" },
"description": "Models that consider this as root"
},
"configurations": {
"type": "array",
"items": { "type": "object" },
"description": "Configurations associated with the model"
},
"configurationPickModels": {
"type": "array",
"items": { "type": "object" },
"description": "Pick models part of configurations"
},
"subStructure": {
"type": "object",
"nullable": true,
"description": "Related sub structure entity"
},
"Notification": {
"type": "array",
"items": { "type": "object" },
"description": "Notifications related to this model"
},
"components": {
"type": "array",
"items": { "type": "object" },
"description": "Components associated with the model"
},
"parentComponents": {
"type": "array",
"items": { "type": "object" },
"description": "Parent components of the model"
},
"organization": {
"type": "object",
"nullable": true,
"description": "Organization that owns this model"
}
}
}
}'
Response Response Example
{}
Request
Body Params application/json
Responses
Modified at 2025-06-06 16:19:14