Exemplos de Consultas

As consultas a seguir estão prontas para uso em casos comuns de uso da API do Altium 365. Todos os exemplos usam o endpoint do Workspace e exigem um token de acesso válido.

Projetos

Listar Workspaces

Recuperar a lista de workspaces do usuário, incluindo a URL do endpoint da API.

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

Listar Projetos

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

Obter Detalhes do Projeto

Buscar um projeto específico por ID, incluindo seus dados de projeto, revisão mais recente e colaboradores.

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

Biblioteca

Obter Visão Geral da Biblioteca

Retorna a biblioteca do Workspace com contagens de componentes, footprints e símbolos.

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

Suprimentos

Listar BOMs

Retorna todos os BOMs gerenciados no Workspace com status de integridade e contagem de itens.

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

Equipe do Workspace

Listar Membros do Workspace

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