Các truy vấn ví dụ

Dưới đây là các truy vấn có thể chạy ngay cho những trường hợp sử dụng phổ biến của API Altium 365. Tất cả ví dụ đều sử dụng điểm cuối Workspace và yêu cầu mã thông báo truy cập hợp lệ.

Khám phá

Liệt kê các Workspace

Truy xuất danh sách các Workspace của người dùng, bao gồm URL điểm cuối API.

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

Dự án

Liệt kê các dự án

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

Lấy thông tin chi tiết dự án

Truy xuất một dự án cụ thể theo ID, bao gồm dữ liệu thiết kế, bản sửa đổi mới nhất và những người cộng tác.

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

Thư viện

Lấy thông tin tổng quan về thư viện

Trả về thư viện Workspace cùng số lượng linh kiện, footprint và ký hiệu.

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

Thu mua

Liệt kê các BOM

Trả về tất cả BOM được quản lý trong Workspace cùng trạng thái sức khỏe và số lượng mục.

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

Nhóm Workspace

Liệt kê các thành viên Workspace

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