Skip to main content
View as Markdown

DesReleaseComponentInput

Input for releasing component.

Member Of​

desReleaseComponent mutation

input DesReleaseComponentInput {
  componentComment: String
  componentDescription: String
  componentItemName: String!
  componentLifeCycleDefinitionId: String
  componentLifeCycleDefinitionNodeId: ID
  componentParentFolderId: ID
  componentReleaseFolder: String
  componentRevisionNamingSchemeId: String
  componentRevisionNamingSchemeNodeId: ID
  componentTemplateId: ID
  componentTypeId: String
  datasheetReleaseFolder: String
  datasheetReleaseFolderItemNamingSchemeTemplate: String
  datasheets: [DesReleaseComponentDatasheetInput!]
  footprintFiles: [DesReleaseComponentFileInput!]
  footprintItemName: String
  footprintLifeCycleDefinitionId: String
  footprintLifeCycleDefinitionNodeId: ID
  footprintReleaseFolder: String
  footprintRevisionNamingSchemeId: String
  footprintRevisionNamingSchemeNodeId: ID
  footprints: [DesReleaseComponentFootprintInput!]
  parameters: [DesRevisionParameterInput!]!
  symbol: DesReleaseComponentSymbolInput
  symbolFiles: [DesReleaseComponentFileInput!]
  symbolItemName: String
  symbolLifeCycleDefinitionId: String
  symbolLifeCycleDefinitionNodeId: ID
  symbolReleaseFolder: String
  symbolRevisionNamingSchemeId: String
  symbolRevisionNamingSchemeNodeId: ID
  useExistingComponentReleaseFolder: Boolean
  workspaceUrl: String
}

Fields​

componentComment ● String scalar​

Comment for component.

componentDescription ● String scalar​

Description for component.

componentItemName ● String! non-null scalar​

Name of component item.

componentLifeCycleDefinitionId ● String scalar​

**DEPRECATED** Use componentLifeCycleDefinitionNodeId instead with a value from DesLifeCycleDefinition.id.

componentLifeCycleDefinitionNodeId ● ID scalar​

Life cycle definition identifier for component.

componentParentFolderId ● ID scalar​

Destination parent folder identifier for releasing a component. If omitted or empty, componentReleaseFolder is required.

componentReleaseFolder ● String scalar​

New child folder name for releasing a component. If omitted or empty, componentParentFolderId is required.

componentRevisionNamingSchemeId ● String scalar​

**DEPRECATED** Use componentRevisionNamingSchemeNodeId instead with a value from DesRevisionNamingScheme.id.

componentRevisionNamingSchemeNodeId ● ID scalar​

Revision naming scheme identifier for component.

componentTemplateId ● ID scalar​

The component template identifier. The released component is linked to this template; its component type is inherited unless componentTypeId is set.

componentTypeId ● String scalar​

The component type identifier. If omitted or set as null, no component type will be assigned.

datasheetReleaseFolder ● String scalar​

The datasheet folder path, existing or to be created.

datasheetReleaseFolderItemNamingSchemeTemplate ● String scalar​

Naming scheme template for the datasheet folder.

datasheets ● [DesReleaseComponentDatasheetInput!] list input​

Datasheets for component.

footprintFiles ● [DesReleaseComponentFileInput!] list input​

The footprint files. Either footprintFiles or footprints must be provided.

footprintItemName ● String scalar​

The footprint name. Use null to be generated.

footprintLifeCycleDefinitionId ● String scalar​

**DEPRECATED** Use footprintLifeCycleDefinitionNodeId instead with a value from DesLifeCycleDefinition.id.

footprintLifeCycleDefinitionNodeId ● ID scalar​

The footprint life cycle definition identifier.

footprintReleaseFolder ● String scalar​

The footprint folder path, existing or to be created. Required when footprintFiles are provided.

footprintRevisionNamingSchemeId ● String scalar​

**DEPRECATED** Use footprintRevisionNamingSchemeNodeId instead with a value from DesRevisionNamingScheme.id.

footprintRevisionNamingSchemeNodeId ● ID scalar​

The footprint revision naming scheme identifier.

footprints ● [DesReleaseComponentFootprintInput!] list input​

Existing footprints to include. Either footprintFiles or footprints must be provided.

parameters ● [DesRevisionParameterInput!]! non-null input​

Parameters for component.

symbol ● DesReleaseComponentSymbolInput input​

Existing symbol to include. Either symbolFiles or symbol must be provided.

symbolFiles ● [DesReleaseComponentFileInput!] list input​

The symbol files. Either symbolFiles or symbol must be provided.

symbolItemName ● String scalar​

The symbol name. Use null to be generated.

symbolLifeCycleDefinitionId ● String scalar​

**DEPRECATED** Use symbolLifeCycleDefinitionNodeId instead with a value from DesLifeCycleDefinition.id.

symbolLifeCycleDefinitionNodeId ● ID scalar​

The symbol life cycle definition identifier.

symbolReleaseFolder ● String scalar​

The symbol folder path, existing or to be created. Required when symbolFiles are provided.

symbolRevisionNamingSchemeId ● String scalar​

**DEPRECATED** Use symbolRevisionNamingSchemeNodeId instead with a value from DesRevisionNamingScheme.id.

symbolRevisionNamingSchemeNodeId ● ID scalar​

The symbol revision naming scheme identifier.

useExistingComponentReleaseFolder ● Boolean scalar​

When componentReleaseFolder is set, tells to use existing folder if any, otherwise create a new folder.

workspaceUrl ● String scalar​

Workspace URL for releasing a component.