クエリの例

以下は、一般的な Altium 365 API のユースケース向けにすぐ実行できるクエリです。すべての例では Workspace エンドポイントを使用し、有効なアクセストークンが必要です。

プロジェクト

プロジェクト一覧

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
      projectType
      updatedAt
    }
  }
}

プロジェクト詳細の取得

ID を指定して特定のプロジェクトを取得します。設計データ、最新リビジョン、コラボレーター情報を含みます。

query GetProject($id: ID!) {
  desProjectById(id: $id) {
    id
    name
    description
    projectType
    createdAt
    updatedAt
    design {
      releases {
        totalCount
      }
      variants {
        name
      }
    }
    latestRevision {
      author
      createdAt
      message
      revisionId
    }
  }
}

ライブラリ

ライブラリ概要の取得

Workspace ライブラリを返します。コンポーネント、フットプリント、シンボルの件数を含みます。

query GetLibraryOverview{
  desLibrary {
    name
    description
    updatedAt
    components {
      nodes {
        id
        name
      }
    }
    footprints {
      totalCount
    }
    symbols {
      totalCount
    }
  }
}

調達

BOM 一覧

Workspace 内で管理されているすべての BOM を、健全性ステータスとアイテム数とともに返します。

query {
  bomBoms(first: 5) {
    nodes {
      bomId
      name
      createdAt
      updatedAt
      items {
        totalCount
      }
      releases {
        totalCount
        nodes {
          name
          releasedAt
          releaseNotes
        }
      }
      issues {
        severity
        description
        howToFix
      }
    }
  }
}

Workspace チーム

Workspace メンバー一覧

query ListWorkspaceUsers {
  desWorkspaceTeamByAuth {
    workspaceGroups {
      nodes {
        id
        name
      }
    }
    workspaceUsers {
      nodes {
        id
        displayName
        email
      }
    }
  }
}