Models¶
Endpoints related to models.
- GET /anatomical-model-part/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested part cannot be found.
400 Bad Request – Something constraints are invalid, so this part can’t be processed.
405 Method Not Allowed – MethodNotAllowed
- POST /anatomical-model-part/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested part cannot be found.
400 Bad Request – Something constraints are invalid, so this part can’t be processed.
405 Method Not Allowed – MethodNotAllowed
- Response Headers:
Location – URI of the created resource
- GET /anatomical-model-part/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested part cannot be found.
400 Bad Request – Something constraints are invalid, so this part can’t be processed.
405 Method Not Allowed – MethodNotAllowed
- PUT /anatomical-model-part/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – The requested part cannot be found.
400 Bad Request – Something constraints are invalid, so this part can’t be processed.
405 Method Not Allowed – MethodNotAllowed
- DELETE /anatomical-model-part/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – The requested part cannot be found.
400 Bad Request – Something constraints are invalid, so this part can’t be processed.
405 Method Not Allowed – MethodNotAllowed
- GET /model/<uuid:model_uuid>/snapshot/binary/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
- POST /model/<uuid:model_uuid>/snapshot/binary/¶
- Status Codes:
201 Created – Resource created successfully
- Response Headers:
Location – URI of the created resource
- GET /model/<uuid:model_uuid>/snapshot/binary/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
- GET /model/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
401 Unauthorized – no-model-rights: You do not have any rights on this model
- POST /model/¶
Create a new model.
Create a new model.
NOTE: Most ‘model’ updates should be done by creating a new model. See docs.authentise.com or PlatformModel code for more details.
- Status Codes:
201 Created – Resource created successfully
401 Unauthorized – no-model-rights: You do not have any rights on this model
- Response Headers:
Location – URI of the created resource
- GET /model/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
401 Unauthorized – no-model-rights: You do not have any rights on this model
- PUT /model/{uuid}/¶
update an existing model. An ‘update’ event is consequently fired after the model has been updated.
update an existing model. An ‘update’ event is consequently fired after the model has been updated.
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
401 Unauthorized – no-model-rights: You do not have any rights on this model
- DELETE /model/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
401 Unauthorized – no-model-rights: You do not have any rights on this model
- GET /part/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
400 Bad Request – NotImplementedError
- GET /fusion-model/¶
Get a list of fusion models with optional filters
Get a list of fusion models with optional filters
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – fusion-model-not-found: The requested fusion model was not found
401 Unauthorized – fusion-integration-disabled: Fusion integration is not enabled for this bureau
400 Bad Request – invalid-version: The requested version is not valid for this fusion model
- GET /fusion-model/{uuid}/¶
Get a single fusion model by UUID
Get a single fusion model by UUID
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – fusion-model-not-found: The requested fusion model was not found
401 Unauthorized – fusion-integration-disabled: Fusion integration is not enabled for this bureau
400 Bad Request – invalid-version: The requested version is not valid for this fusion model
- PUT /fusion-model/{uuid}/¶
Update a fusion model to a different version and download its STL representation.
Update a fusion model to a different version and download its STL representation.
This method provides the API endpoint for switching to a different version of the same Fusion 360 design. When called, it triggers a workflow that:
Validates the requested version exists in Fusion 360
Downloads the specified version as an STL file
Creates a new Nautilus model with this STL content
Updates the Fusion model record to point to the new version
Migrates ModelLibrary associations to the new model
Version Switching Implementation Details: - The operation creates a NEW Nautilus model rather than modifying the existing one - The Fusion model record is updated to track both:
The new version number in Fusion 360
The UUID of the newly created Nautilus model
Any ModelLibrary records that reference the original model are updated to
reference the new model instead, ensuring seamless workflow integration
The model processing pipeline is triggered for the new model automatically
This implementation ensures that: - Version history is properly maintained - The new geometry is properly processed by the platform - Existing workflows seamlessly transition to using the new version
Args:
uuid (UUID): UUID of the fusion model to update payload (dict): Contains the new version number to switch to
Returns:
tuple: Empty body, HTTP status, and empty headers
Raises:
Unauthorized: If Fusion integration is not enabled for this bureau RecordNotFound: If the requested fusion model was not found InvalidPayload: If the version is invalid or the process fails
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – fusion-model-not-found: The requested fusion model was not found
401 Unauthorized – fusion-integration-disabled: Fusion integration is not enabled for this bureau
400 Bad Request – invalid-version: The requested version is not valid for this fusion model
- GET /fusion-assembled-model/¶
Get a list of fusion assembled models with optional filters.
Get a list of fusion assembled models with optional filters.
Retrieves a paginated list of Fusion assembled models, supporting filtering by various criteria such as run, status, or bureau.
- Returns:
ResourceList: Paginated list of assembled models with total count
- Raises:
Unauthorized: If Fusion feature is not enabled for the bureau
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – fusion-assembled-model-not-found: The requested fusion assembled model was not found
401 Unauthorized – autodesk-fusion-feature-disabled: Fusion Feature Flag is not enabled for this bureau
- GET /fusion-assembled-model/{uuid}/¶
Get a single fusion assembled model by UUID.
Get a single fusion assembled model by UUID.
Retrieves a specific Fusion assembled model and returns it with enhanced data including Fusion deep links for ready models.
- Args:
uuid: The UUID of the fusion assembled model to retrieve
- Returns:
dict: The assembled model data with URI and optional fusion_uri
- Raises:
Unauthorized: If Fusion feature is not enabled for the bureau RecordNotFound: If the assembled model doesn’t exist
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – fusion-assembled-model-not-found: The requested fusion assembled model was not found
401 Unauthorized – autodesk-fusion-feature-disabled: Fusion Feature Flag is not enabled for this bureau
- GET /anatomical-model/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested anatomical model cannot be found.
405 Method Not Allowed – MethodNotAllowed
- POST /anatomical-model/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested anatomical model cannot be found.
405 Method Not Allowed – MethodNotAllowed
- Response Headers:
Location – URI of the created resource
- GET /anatomical-model/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested anatomical model cannot be found.
405 Method Not Allowed – MethodNotAllowed
- PUT /anatomical-model/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – The requested anatomical model cannot be found.
405 Method Not Allowed – MethodNotAllowed
- DELETE /anatomical-model/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – The requested anatomical model cannot be found.
405 Method Not Allowed – MethodNotAllowed
- POST /model/<uuid:uuid>/transformation/¶
Create a new model
Create a new model
- Status Codes:
201 Created – Resource created successfully
400 Bad Request – invalid-payload
- Response Headers:
Location – URI of the created resource
- GET /anatomical-model-piece-report/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested anatomical model piece report cannot be found.
403 Forbidden – You are not authorized to complete the request.
- POST /anatomical-model-piece-report/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested anatomical model piece report cannot be found.
403 Forbidden – You are not authorized to complete the request.
- Response Headers:
Location – URI of the created resource
- GET /anatomical-model-piece-report/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested anatomical model piece report cannot be found.
403 Forbidden – You are not authorized to complete the request.
- GET /fusion-model/versions/{uuid}/¶
Get version history for a fusion model
Get version history for a fusion model
- Args:
uuid: UUID of the fusion model to get versions for
- Returns:
dict: Contains versions array with version information
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – fusion-model-not-found: The requested fusion model was not found
401 Unauthorized – fusion-integration-disabled: Fusion integration is not enabled for this bureau
- GET /library/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – RecordNotFound
- POST /library/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – RecordNotFound
- Response Headers:
Location – URI of the created resource
- GET /library/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – RecordNotFound
- PUT /library/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – RecordNotFound
- DELETE /library/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – RecordNotFound
- GET /model/<uuid:model_uuid>/snapshot/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
- POST /model/<uuid:model_uuid>/snapshot/¶
- Status Codes:
201 Created – Resource created successfully
- Response Headers:
Location – URI of the created resource
- GET /model/<uuid:model_uuid>/snapshot/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
- POST /model-library/<uuid:uuid>/replace/¶
- Status Codes:
201 Created – Resource created successfully
400 Bad Request – invalid-payload
- Response Headers:
Location – URI of the created resource
- GET /model-library/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – RecordNotFound
403 Forbidden – Unauthorized: You do not have the necessary model_library permissions to complete the request. Forbidden
- POST /model-library/¶
create a new model-library entry. must have an existing item.
create a new model-library entry. must have an existing item.
- Status Codes:
201 Created – Resource created successfully
404 Not Found – RecordNotFound
403 Forbidden – Unauthorized: You do not have the necessary model_library permissions to complete the request. Forbidden
- Response Headers:
Location – URI of the created resource
- GET /model-library/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – RecordNotFound
403 Forbidden – Unauthorized: You do not have the necessary model_library permissions to complete the request. Forbidden
- PUT /model-library/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – RecordNotFound
403 Forbidden – Unauthorized: You do not have the necessary model_library permissions to complete the request. Forbidden
- DELETE /model-library/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – RecordNotFound
403 Forbidden – Unauthorized: You do not have the necessary model_library permissions to complete the request. Forbidden
- GET /anatomical-model-assembly/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested assembly cannot be found.
405 Method Not Allowed – MethodNotAllowed
- POST /anatomical-model-assembly/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested assembly cannot be found.
405 Method Not Allowed – MethodNotAllowed
- Response Headers:
Location – URI of the created resource
- GET /anatomical-model-assembly/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested assembly cannot be found.
405 Method Not Allowed – MethodNotAllowed
- PUT /anatomical-model-assembly/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – The requested assembly cannot be found.
405 Method Not Allowed – MethodNotAllowed
- DELETE /anatomical-model-assembly/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – The requested assembly cannot be found.
405 Method Not Allowed – MethodNotAllowed