Updating a Model by Id

Developing

PUT

/model/{modelId}

Updates the details of an existing model using its ID. This may include changes to the model name, description, or structure. Partial or full updates are supported depending on the implementation.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/model/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of the model",
            "example": "Updated Vehicle Model"
        },
        "description": {
            "type": "string",
            "description": "Description of the model",
            "example": "Updated model description"
        },
        "imageUrl": {
            "type": "string",
            "description": "Optional image URL for the model or component",
            "example": "https://your-cdn.com/images/updated-model.jpg"
        },
        "annotationName": {
            "type": "string",
            "description": "Optional: updates/creates the related component name",
            "example": "Engine Block"
        },
        "iconName": {
            "type": "string",
            "description": "Optional icon name for UI display",
            "example": "engine-icon"
        },
        "status": {
            "type": "string",
            "description": "Status of the model",
            "example": "active"
        },
        "completedLevel": {
            "type": "number",
            "description": "Progress level of the model (0.0 to 1.0)",
            "example": 0.9
        }
    },
    "example": {
        "name": "Updated Vehicle Model",
        "description": "Updated model with new engine annotation",
        "imageUrl": "https://your-cdn.com/images/updated-model.jpg",
        "annotationName": "Engine Block",
        "iconName": "engine-icon",
        "status": "active",
        "completedLevel": 0.9
    }
}'

Response Example

{
    "status": 200,
    "message": "Model updated successfully",
    "data": {
        "id": "model_123",
        "name": "Updated Vehicle Model",
        "description": "Updated model with new engine annotation",
        "imageUrl": "https://your-cdn.com/images/updated-model.jpg",
        "iconName": "Engine Block",
        "completedLevel": 0.9,
        "status": "active",
        "isRoot": false,
        "isArchived": false,
        "isDeleted": false,
        "superStructureId": null,
        "subStructureId": null,
        "parentModelId": "model_root_1",
        "rootModelId": "model_root_1",
        "organizationId": "org_001",
        "createdById": "user_abc",
        "createdAt": "2025-06-01T10:00:00.000Z",
        "updatedAt": "2025-06-01T12:15:00.000Z"
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

modelId

string

required

Body Params application/json

object {0}

Examples

Responses

🟢200Success

application/json

Body

object {0}

Modified at 2025-06-02 14:22:16

Deleting A Model By Id

Creating the model Annotations