Skip to main content
View as Markdown

DesLifeCycleState

Information about the life cycle state.

Common Data Model​

  • Lifecycle State — A named point in an Item Revision's lifecycle (e.g. Planned, New From Design, In Production, Obsolete) that shows its status from a business perspective. Each state's properties include whether revisions in that state are shown in the Explorer panel and whether they may be used in designs; a revision moves to another state only through a transition defined in its lifecycle definition.

Member Of​

DesFootprint object ● DesLifeCycleStage object ● DesLifeCycleStateTransition object ● DesReuseBlockRevision object ● DesRevisionDetails object ● DesSymbol object

type DesLifeCycleState {
backgroundColor: DesColor!
createdAt: DateTime!
createdBy: DesUser!
description: String!
foregroundColor: DesColor!
isAllowedInDesign: Boolean!
isInitialState: Boolean!
isVisible: Boolean!
lifeCycleStateId: String!
name: String!
stateIndex: Int!
updatedAt: DateTime!
updatedBy: DesUser!
}

Fields​

backgroundColor ● DesColor! non-null object Design​

The background color for this life cycle state.

createdAt ● DateTime! non-null scalar​

The DateTime this life cycle state was created.

createdBy ● DesUser! non-null object​

The user this life cycle state was created by.

description ● String! non-null scalar​

The description of this life cycle state.

foregroundColor ● DesColor! non-null object Design​

The foreground color for this life cycle state.

isAllowedInDesign ● Boolean! non-null scalar​

Determines whether items in this life cycle state are allowed to be used in a design.

isInitialState ● Boolean! non-null scalar​

Determines whether this life cycle state is the first of all the states for the associated life cycle definition.

isVisible ● Boolean! non-null scalar​

Determines whether this life cycle state is visible in the Altium Designer vault panel.

lifeCycleStateId ● String! non-null scalar​

The reference identifier for this life cycle state.

name ● String! non-null scalar​

The name of this life cycle state.

stateIndex ● Int! non-null scalar​

The state index for this life cycle state.

updatedAt ● DateTime! non-null scalar​

The DateTime this life cycle state was last updated at.

updatedBy ● DesUser! non-null object​

The user this life cycle state was last updated by.