Exemples de requêtes

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

Projets

Lister les Workspaces

Récupérer la liste des Workspaces de l’utilisateur, y compris l’URL du point de terminaison de l’API.

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

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 par ID, 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 du Workspace 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 le Workspace avec l’état de santé et le nombre d’articles.

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

Équipe du Workspace

Lister les membres du Workspace

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