Przykładowe zapytania

Poniżej znajdują się gotowe do uruchomienia zapytania dla typowych zastosowań API Altium 365. Wszystkie przykłady korzystają z punktu końcowego Workspace i wymagają prawidłowego tokenu dostępu.

Projekty

Wyświetl listę Workspace’ów

Pobierz listę Workspace’ów użytkownika, w tym adres URL punktu końcowego API.

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

Wyświetl listę projektów

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

Pobierz szczegóły projektu

Pobierz konkretny projekt według identyfikatora ID, wraz z jego danymi projektowymi, najnowszą rewizją i współpracownikami.

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

Biblioteka

Pobierz przegląd biblioteki

Zwraca bibliotekę Workspace z liczbą komponentów, footprintów i symboli.

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

Zaopatrzenie

Wyświetl listę BOM-ów

Zwraca wszystkie zarządzane BOM-y w Workspace wraz ze statusem kondycji i liczbą pozycji.

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

Zespół Workspace

Wyświetl listę członków Workspace

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