Exemples de requêtes

Voici des requêtes prêtes à l’emploi pour les cas d’utilisation courants de l’API Altium 365. Tous les exemples utilisent le point de terminaison de l’espace de travail et nécessitent un jeton d’accès valide.

Découverte

Lister les espaces de travail

Récupérer la liste des espaces de travail de l’utilisateur, y compris les URL des points de terminaison de l’API.

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

Projets

Lister les projets

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

Obtenir les détails d’un projet

Récupérer un projet spécifique à partir de son identifiant, y compris ses données de conception, sa dernière révision et ses collaborateurs.

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

Bibliothèque

Obtenir une vue d’ensemble de la bibliothèque

Renvoie la bibliothèque de l’espace de travail avec le nombre de composants, d’empreintes et de symboles.

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

Approvisionnement

Lister les nomenclatures

Renvoie toutes les nomenclatures gérées dans l’espace de travail, avec leur état de santé et le nombre d’éléments.

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

Équipe de l’espace de travail

Lister les membres de l’espace de travail

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