Примеры запросов

Ниже приведены готовые к выполнению запросы для типичных сценариев использования API Altium 365. Во всех примерах используется конечная точка рабочего пространства и требуется действительный токен доступа.

Обнаружение

Получение списка рабочих пространств

Получение списка рабочих пространств пользователя, включая URL-адреса конечных точек API.

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

Проекты

Получение списка проектов

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

Получение сведений о проекте

Получение конкретного проекта по идентификатору, включая данные проекта, последнюю ревизию и участников совместной работы.

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