Skip to main content

DesProject

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

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!
  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​

DesProject.collaborationLatestRevision ● DesCollaborationRevision object​

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

DesProject.collaborationLatestRevision.domain ● DesCollaborationDomain! non-null enum​

The collaboration domain to get the latest revision for.

DesProject.collaborationRevisions ● DesCollaborationRevisionConnection object​

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

DesProject.collaborationRevisions.after ● String scalar​

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

DesProject.collaborationRevisions.before ● String scalar​

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

DesProject.collaborationRevisions.domain ● DesCollaborationDomain! non-null enum​

The collaboration domain to get the revisions for.

DesProject.collaborationRevisions.first ● Int scalar​

Returns the first _n_ elements from the list.

DesProject.collaborationRevisions.last ● Int scalar​

Returns the last _n_ elements from the list.

DesProject.createdAt ● DateTime! non-null scalar​

The DateTime when this project was created.

DesProject.createdBy ● DesUser! non-null object​

The account information for who created this project.

DesProject.description ● String scalar​

The summary of this project content or purpose.

DesProject.design ● DesDesign! non-null object​

The detailed design information for this project.

DesProject.id ● ID! non-null scalar​

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

DesProject.isScaffolding ● Boolean! non-null scalar​

Gets current scaffolding status.

DesProject.latestRevision ● DesVcsRevision object​

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

DesProject.name ● String scalar​

The assigned name for this project.

DesProject.owner ● DesWorkspaceUser object​

Hardware project's owner.

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

The list of the parameters describing this project.

DesProject.parameters.names ● [String!] list scalar​

An optional list of parameter names to search.

DesProject.previewUrl ● String! non-null scalar​

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

DesProject.previewUrl.isDirectLink ● Boolean! non-null scalar​

Tells to get a direct link to the preview image.

DesProject.projectId ● String! non-null scalar​

The reference identifier for this project.

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

The list of project permissions.

DesProject.projectType ● DesProjectType! non-null enum​

The project type.

DesProject.requirementsBlockId ● String scalar​

The requirements block identifier.

DesProject.revisions ● DesVcsRevisionConnection object​

The list of VCS revisions.

DesProject.revisions.after ● String scalar​

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

DesProject.revisions.before ● String scalar​

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

DesProject.revisions.first ● Int scalar​

Returns the first _n_ elements from the list.

DesProject.revisions.last ● Int scalar​

Returns the last _n_ elements from the list.

DesProject.tasks ● [DesTask!]! non-null object​

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

DesProject.updatedAt ● DateTime! non-null scalar​

The DateTime when this project was last modified.

DesProject.updatedBy ● DesUser! non-null object​

The account information for who last modified this project.

DesProject.url ● String! non-null scalar​

The Altium 365 web address.

DesProject.variantCount ● Int! non-null scalar​

The number of design variants.

DesProject.workflows ● [DesWorkflow!] list object​

The list of workflows associated with this project.

DesProject.workflows.isClosed ● Boolean! non-null scalar​

An option to search workflows that have been completed.

DesProject.workflows.modifiedAfter ● DateTime scalar​

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

DesProject.workflows.where ● DesWorkflowFilterInput input​
DesProject.workflows.withVariable ● DesWorkflowFilterByVariableInput input​

Filter workflows by a variable.

DesProject.workspaceUrl ● String! non-null scalar​

The Altium 365 workspace URL.

Interfaces​

Node interface​

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