プロジェクト API - Ionworks Studio

ionworks-api Python パッケージは、プロジェクトをプログラムから管理するためのサブクライアントを提供します。インストールと認証については、Python API クライアントページを参照してください。

プロジェクトの一覧

from ionworks import Ionworks

client = Ionworks()

# List all projects
projects = client.project.list()
for project in projects:
    print(f"{project.name} (ID: {project.id})")

# Filter by name (case-insensitive substring match)
projects = client.project.list(name="NMC")

# Paginate results
projects = client.project.list(limit=10, offset=20)
print(f"Showing {projects.count} of {projects.total} projects")

サポートされるフィルター: name、description、created_at、updated_at(範囲指定用の _gt / _lt 変種を含む)、order_by、order。フィルターとソートはサーバー側で適用されるため、大規模なプロジェクト一覧でも全行を取得することなくページングできます。

プロジェクトには created_by_email フィルターはありません — projects テーブルは作成者を記録しないため、照合する対象が存在しません。レコードの作成者でフィルターしたい場合は client.model.list() など別のリソースを使用してください。

プロジェクトの取得

project = client.project.get("your-project-id")
print(f"{project.name}: {project.description}")

プロジェクトの作成

project = client.project.create({
    "name": "NMC622 Characterization",
    "description": "Parameter identification for NMC622/Graphite cells",
})
print(f"Created project: {project.id}")

プロジェクトの更新

project = client.project.update("your-project-id", {
    "name": "NMC622 Characterization v2",
    "description": "Updated description",
})

プロジェクトの削除

client.project.delete("your-project-id")

どのリソースの ID も、Ionworks Studio Web アプリから確認できます。リソースの詳細ページに移動すると、URL に ID が表示されます。

⌘I