Query di esempio

Di seguito sono riportate query pronte all’uso per i casi d’uso più comuni dell’API di Altium 365. Tutti gli esempi utilizzano l’endpoint Workspace e richiedono un token di accesso valido.

Progetti

Elenca gli Workspace

Recupera l’elenco degli Workspace dell’utente, incluso l’URL dell’endpoint API.

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

Elenca i progetti

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

Ottieni i dettagli del progetto

Recupera un progetto specifico tramite ID, inclusi i relativi dati di progettazione, l’ultima revisione e i collaboratori.

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

Libreria

Ottieni una panoramica della libreria

Restituisce la libreria dello Workspace con il conteggio di componenti, footprint e simboli.

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

Approvvigionamento

Elenca le BOM

Restituisce tutte le BOM gestite nello Workspace con lo stato di integrità e il numero di elementi.

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

Team dello Workspace

Elenca i membri dello Workspace

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