Deprecation of POST APIs for File Classification and Container Info
Change
The Below APIs are deprecated, and scheduled to be removed in a Flywheel major version March 2026 or later. Replacement HTTP PATCH APIs are available, and used by the Flywheel SDK starting with version 20.0.0.
Client code using these Flywheel SDK functions will need to be updated to use Flywheel SDK version 20.0.0 or later, which is adjusted to using replacement PATCH HTTP APIs. No code change is required.
Viewer Extension SDK Applications need no modification.
Applications directly using the HTTP APIs will need to be updated to use the HTTP PATCH APIs.
| SDK Function | API Route |
|---|---|
| modify_acquisition_file_info | POST /api/acquisitions/{cid}/files/{filename}/info |
| modify_container_file_info | POST /api/containers/{cid}/files/{filename}/info |
| modify_collection_file_info | POST /api/collections/{cid}/files/{filename}/info |
| modify_project_file_info | POST /api/projects/{cid}/files/{filename}/info |
| modify_session_file_info | POST /api/sessions/{cid}/files/{filename}/info |
| modify_subject_file_info | POST /api/subjects/{cid}/files/{filename}/info |
| modify_acquisition_info | POST /api/acquisitions/{cid}/info |
| modify_analysis_info | POST /api/analyses/{cid}/info |
| modify_collection_info | POST /api/collections/{cid}/info |
| modify_container_info | POST /api/containers/{cid}/info |
| modify_project_info | POST /api/projects/{cid}/info |
| modify_session_info | POST /api/sessions/{cid}/info |
| modify_subject_info | POST /api/subjects/{cid}/info |
| modify_acquisition_file_classification | POST /api/acquisitions/{cid}/files/{filename}/classification |
| modify_collection_file_classification | POST /api/collections/{cid}/files/{filename}/classification |
| modify_container_file_classification | POST /api/containers/{cid}/files/{filename}/classification |
| modify_project_file_classification | POST /api/projects/{cid}/files/{filename}/classification |
| modify_session_file_classification | POST /api/sessions/{cid}/files/{filename}/classification |
| modify_subject_file_classification | POST /api/subjects/{cid}/files/{filename}/classification |
| modify_current_user_info | POST /api/users/self/info |
| modify_session_subject_info | POST /api/sessions/{session_id}/subject/info |
Reason For Change
- Utilizing HTTP PATCH allows for automatic API request retries for these SDK functions, making the scripts and gears running them more robust.
- HTTP PATCH is considered best practice for the record update functionality supported by these APIs.
Recommended Action
Prior to March 2026:
- Client code (including SDK gears) using the affected Flywheel SDK functions should be updated to flywheel-sdk version 20.0.0 or newer.
- Client code using the affected HTTP APIs directly should be updated to use the HTTP PATCH APIs.