Skip to main content
View as Markdown

DesProject

A project manages all development stages of the PCB/PCA product lifecycle.

Common Data Model​

  • Hardware Project — A design project stored in a Workspace, normally under its built-in version control, such as a PCB project. It groups the design documents that together define one implementation of a product, along with its project parameters and variants; it is the source from which releases are made and from which Managed BOMs can be created.

Returned By​

desProjectById query ● desProjectsByIds query

Member Of​

DesProjectConnection object ● DesProjectEdge object ● DesSharedWithMeProjectInfo object ● DesWorkspace object ● SolSolution object

Interfaces​

Node interface​

The node interface is implemented by entities that have a global unique identifier.

type DesProject implements Node {
  collaborationLatestRevision(
    domain: DesCollaborationDomain!
  ): DesCollaborationRevision
  collaborationRevisions(
    after: String
    before: String
    domain: DesCollaborationDomain!
    first: Int
    last: Int
  ): DesCollaborationRevisionConnection
  createdAt: DateTime!
  createdBy: DesUser!
  description: String
  design: DesDesign!
  id: ID!
  isScaffolding: Boolean!
  latestRevision: DesVcsRevision
  name: String
  owner: DesWorkspaceUser
  parameters(
    names: [String!]
  ): [DesProjectParameter!]!
  previewUrl(
    isDirectLink: Boolean! = false
  ): String!
  projectId: String!
  projectPermissions: [DesProjectPermission!]!
  projectType: DesProjectType!
  repositoryType: DesProjectRepositoryType
  repositoryUrl: String
  requirementsBlockId: String
  revisions(
    after: String
    before: String
    first: Int
    last: Int
  ): DesVcsRevisionConnection
  tasks: [DesTask!]!
  updatedAt: DateTime!
  updatedBy: DesUser!
  url: String!
  variantCount: Int!
  workflows(
    isClosed: Boolean! = false
    modifiedAfter: DateTime
    where: DesWorkflowFilterInput
    withVariable: DesWorkflowFilterByVariableInput
  ): [DesWorkflow!]
  workspaceUrl: String!
}

Fields​

collaborationLatestRevision ● DesCollaborationRevision object​

The latest ECAD, MCAD or ESD revision. See also desProjectCollaborationLatestRevision.

domain ● DesCollaborationDomain! non-null enum​

The collaboration domain to get the latest revision for.

collaborationRevisions ● DesCollaborationRevisionConnection object​

ECAD, MCAD or ESD revisions returned by pages. See also desProjectCollaborationRevisions.

after ● String scalar​

Returns the elements in the list that come after the specified cursor.

before ● String scalar​

Returns the elements in the list that come before the specified cursor.

domain ● DesCollaborationDomain! non-null enum​

The collaboration domain to get the revisions for.

first ● Int scalar​

Returns the first _n_ elements from the list.

last ● Int scalar​

Returns the last _n_ elements from the list.

createdAt ● DateTime! non-null scalar​

The DateTime when this project was created.

createdBy ● DesUser! non-null object Platform​

The account information for who created this project.

description ● String scalar​

The summary of this project content or purpose.

design ● DesDesign! non-null object​

The detailed design information for this project.

id ● ID! non-null scalar​

The node identifier for this project (used by desProjectById).

isScaffolding ● Boolean! non-null scalar​

Gets current scaffolding status.

latestRevision ● DesVcsRevision object​

The latest VCS revision. May be null, see GraphQL errors.

name ● String scalar​

The assigned name for this project.

owner ● DesWorkspaceUser object Platform​

Hardware project's owner.

parameters ● [DesProjectParameter!]! non-null object​

The list of the parameters describing this project.

names ● [String!] list scalar​

An optional list of parameter names to search.

previewUrl ● String! non-null scalar​

The web address to download a preview image for this project.

Tells to get a direct link to the preview image.

projectId ● String! non-null scalar​

The reference identifier for this project.

projectPermissions ● [DesProjectPermission!]! non-null object​

The list of project permissions.

projectType ● DesProjectType! non-null enum​

The project type.

repositoryType ● DesProjectRepositoryType enum​

Whether the Git repository is hosted inside or outside Altium 365. Null when the project has no VCS repository, or when the repository lookup fails (in which case see GraphQL errors).

repositoryUrl ● String scalar​

The Git remote URL for the repository. Treat it as an opaque value — request it from the API and use it as-is.

requirementsBlockId ● String scalar​

The requirements block identifier.

revisions ● DesVcsRevisionConnection object​

The list of VCS revisions.

after ● String scalar​

Returns the elements in the list that come after the specified cursor.

before ● String scalar​

Returns the elements in the list that come before the specified cursor.

first ● Int scalar​

Returns the first _n_ elements from the list.

last ● Int scalar​

Returns the last _n_ elements from the list.

tasks ● [DesTask!]! non-null object Collaboration​

The list of project tasks. For a particular project consider using the more effective query desProjectTasks.

updatedAt ● DateTime! non-null scalar​

The DateTime when this project was last modified.

updatedBy ● DesUser! non-null object Platform​

The account information for who last modified this project.

url ● String! non-null scalar​

The Altium 365 web address.

variantCount ● Int! non-null scalar​

The number of design variants.

workflows ● [DesWorkflow!] list object Customization​

The list of workflows associated with this project.

isClosed ● Boolean! non-null scalar​

An option to search workflows that have been completed.

modifiedAfter ● DateTime scalar​

An option to search workflows that have been modified after a specific DateTime.

where ● DesWorkflowFilterInput input Customization​
withVariable ● DesWorkflowFilterByVariableInput input Customization​

Filter workflows by a variable.

workspaceUrl ● String! non-null scalar​

The Altium 365 workspace URL.