クエリの例

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

検出

ワークスペースの一覧を取得

APIエンドポイントのURLを含む、ユーザーのワークスペースの一覧を取得します。

query {
  desWorkspaceInfos { 
    name
    description
    url
    location {
      apiServiceUrl
      filesServiceUrl
    }
  }
}

プロジェクト

プロジェクトの一覧を取得

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
    }
  }
}

ライブラリ

ライブラリの概要を取得

コンポーネント、フットプリント、シンボルの数を含むワークスペースライブラリを返します。

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

調達

BOMの一覧を取得

健全性ステータスとアイテム数を含む、ワークスペース内のすべての管理対象BOMを返します。

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

ワークスペースチーム

ワークスペースメンバーの一覧を取得

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