Duro GraphQL API Reference
Duro's GraphQL API enables customers to access data in a flexible and scalable fashion. Visit the Quick Start Guide for additional information.
Terms of Service
API Endpoints
# Production:
https://<BASE_URL>/graphql
Headers
# Refer to the Quick Start guide to obtain a token. Contact support for the BASE_URL.
apiToken: <YOUR_TOKEN_HERE>Queries
apiToken
Response
Returns an ApiToken
Arguments
| Name | Description |
|---|---|
type - ApiTokenType
|
Example
Query
query ApiToken($type: ApiTokenType) {
apiToken(type: $type) {
token
}
}
Variables
{"type": "TBD"}
Response
{"data": {"apiToken": {"token": "xyz789"}}}
categories
Response
Returns a Categories
Arguments
| Name | Description |
|---|---|
orderBy - [CategoriesOrderByInput]
|
Example
Query
query Categories($orderBy: [CategoriesOrderByInput]) {
categories(orderBy: $orderBy) {
connection {
edges {
...CategoryEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
}
Variables
{"orderBy": [CategoriesOrderByInput]}
Response
{
"data": {
"categories": {"connection": CategoryConnection}
}
}
categoriesByIds
Response
Returns [Category]
Arguments
| Name | Description |
|---|---|
ids - [ID]
|
Example
Query
query CategoriesByIds($ids: [ID]) {
categoriesByIds(ids: $ids) {
archived
code
customSpecs {
allowedValues
company {
...CompanyFragment
}
defaultValue
id
isDropDown
isPcb
isRequired
name
type
}
id
isAllowedInPartAndAssembly
isDefaultCategory
name
shortName
specs {
allowedValues
company {
...CompanyFragment
}
defaultValue
id
isDropDown
isPcb
isRequired
name
type
}
tags
type
unitOfMeasure
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"categoriesByIds": [
{
"archived": true,
"code": "abc123",
"customSpecs": [Spec],
"id": 4,
"isAllowedInPartAndAssembly": false,
"isDefaultCategory": false,
"name": "abc123",
"shortName": "xyz789",
"specs": [Spec],
"tags": ["MCAD"],
"type": "abc123",
"unitOfMeasure": "AR"
}
]
}
}
changeOrders
Response
Returns a ChangeOrders
Arguments
| Name | Description |
|---|---|
orderBy - [ChangeOrdersOrderByInput]
|
Example
Query
query ChangeOrders($orderBy: [ChangeOrdersOrderByInput]) {
changeOrders(orderBy: $orderBy) {
connection {
edges {
...ChangeOrderEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
}
Variables
{"orderBy": [ChangeOrdersOrderByInput]}
Response
{
"data": {
"changeOrders": {"connection": ChangeOrderConnection}
}
}
changeOrdersByIds
Response
Returns [ChangeOrder]
Example
Query
query ChangeOrdersByIds(
$ids: [ID],
$includeArchived: Boolean
) {
changeOrdersByIds(
ids: $ids,
includeArchived: $includeArchived
) {
alias
approvalType
approvers {
action
id
invitedAt
performedAt
user {
...UserFragment
}
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
componentRevisions {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
components {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
con {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
erpOptions {
additionalPayloadForNotifications {
...AdditionalPayloadForNotificationsFragment
}
effectivity {
...ChangeOrderErpEffectivityFragment
}
itemType {
...ChangeOrderErpItemTypeFragment
}
}
exportBundleKey
history {
action
comment
created
id
user {
...UserFragment
}
}
id
isParentInclude
lastModified
legacyCon
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
name
productRevisions {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
products {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
resolution
status
transitionOrigin
type
unchangedComponents {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
unchangedProducts {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
}
}
Variables
{"ids": [4], "includeArchived": false}
Response
{
"data": {
"changeOrdersByIds": [
{
"alias": "xyz789",
"approvalType": "FIRST_IN",
"approvers": [ChangeOrderApprover],
"archived": true,
"coExternalNotifyUserEmails": [
"abc123"
],
"coInternalNotifyUsers": [User],
"company": Company,
"componentRevisions": [ComponentRevision],
"components": [Component],
"con": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "abc123",
"documentLinks": [DocumentLink],
"erpOptions": ChangeOrderErpOptions,
"exportBundleKey": "abc123",
"history": [ChangeOrderHistory],
"id": "4",
"isParentInclude": false,
"lastModified": "2007-12-03T10:15:30Z",
"legacyCon": "abc123",
"library": Library,
"name": "abc123",
"productRevisions": [ProductRevision],
"products": [Product],
"resolution": "APPROVED",
"status": "CLOSED",
"transitionOrigin": "DURO",
"type": "DCO",
"unchangedComponents": [Component],
"unchangedProducts": [Product]
}
]
}
}
companiesByIds
Example
Query
query CompaniesByIds($ids: [ID]) {
companiesByIds(ids: $ids) {
address {
city
country
state
street
suite
zip
}
archived
categories {
archived
code
customSpecs {
...SpecFragment
}
id
isAllowedInPartAndAssembly
isDefaultCategory
name
shortName
specs {
...SpecFragment
}
tags
type
unitOfMeasure
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
allowedDocTypes
allowedUserRoles
buildScheduleScheme
changeOrderTemplateMapping {
...ChangeOrderTemplateMappingFragment
}
configurations {
...ConfigurationsFragment
}
customFields {
...CustomFieldsFragment
}
customUomLabels
defaultBlacklistedRevisions
defaultCurrency
displayRefDesAndItemNumber
ecoAcceptOpen
ecoDefaultApproval
erpItemTypeOptions
fileStorageLimit
isAllowedBlankItemNumber
isApplicabilityFieldEnabled
isBuildEnabled
isDcoEnabled
isEcadGeneralSpecsEnabled
isFirstResonanceEnabled
isNexusEnabled
isNotRevisionManaged
isPrimarySourceWarningDisabledInCO
isSSOEnabled
isSerializationEnabled
isSpecValidationEnabled
isValispaceEnabled
massPrecisionValue
massUnit
maxFileSize
shouldAutoSelectRolledUpCost
shouldUseCpnRevFileNameFormat
unitPricePrecision
}
specs {
allowedValues
company {
...CompanyFragment
}
defaultValue
id
isDropDown
isPcb
isRequired
name
type
}
subdomain
subscriptions {
active
created
duration
maxRoUsers
maxUsers
package
paidDate
}
users {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
website
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"companiesByIds": [
{
"address": Address,
"archived": true,
"categories": [Category],
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": 4,
"integrations": {},
"isEnabledCustomCategory": true,
"legacyCpnVariantScheme": "abc123",
"logo": Image,
"name": "xyz789",
"onshapeRegisteredCompanies": [
"xyz789"
],
"revisionScheme": "ALPHA_BETA_AB",
"settings": CompanySettings,
"specs": [Spec],
"subdomain": "abc123",
"subscriptions": [PaidSubscription],
"users": [User],
"website": "abc123"
}
]
}
}
companyCategories
Response
Returns [Category]
Arguments
| Name | Description |
|---|---|
id - ID
|
Example
Query
query CompanyCategories($id: ID) {
companyCategories(id: $id) {
archived
code
customSpecs {
allowedValues
company {
...CompanyFragment
}
defaultValue
id
isDropDown
isPcb
isRequired
name
type
}
id
isAllowedInPartAndAssembly
isDefaultCategory
name
shortName
specs {
allowedValues
company {
...CompanyFragment
}
defaultValue
id
isDropDown
isPcb
isRequired
name
type
}
tags
type
unitOfMeasure
}
}
Variables
{"id": "4"}
Response
{
"data": {
"companyCategories": [
{
"archived": true,
"code": "xyz789",
"customSpecs": [Spec],
"id": 4,
"isAllowedInPartAndAssembly": false,
"isDefaultCategory": false,
"name": "xyz789",
"shortName": "abc123",
"specs": [Spec],
"tags": ["MCAD"],
"type": "abc123",
"unitOfMeasure": "AR"
}
]
}
}
componentRevisionsByIds
Response
Returns [ComponentRevision]
Arguments
| Name | Description |
|---|---|
ids - [ID]
|
Example
Query
query ComponentRevisionsByIds($ids: [ID]) {
componentRevisionsByIds(ids: $ids) {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documents {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
integrationFields {
altium {
...AltiumInfoFragment
}
}
lastModified
lastReleaseRevision {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
releasesCount
restoreVariantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
revisionHistory {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
distributor
dpn
manufacturer
mpn
}
rolledUpCostAsPrimary
specs {
key
value
}
status
subRevisions {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
unitOfMeasure
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
vendorId
vendorInfo {
currentVendors
isLinked
originalVendor
previousVendors
}
workflowState
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"componentRevisionsByIds": [
{
"alias": "CMP",
"archived": true,
"assemblyParents": [Component],
"category": "xyz789",
"changeOrder": ChangeOrder,
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documents": [DocumentLink],
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"id": "4",
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": true,
"integrationFields": [Integrations],
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "xyz789",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": false,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"notes": "xyz789",
"parent": Component,
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 987,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": true,
"revisionType": "CHANGE_ORDER",
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpec],
"status": "DESIGN",
"subRevisions": [ComponentRevision],
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "abc123",
"vendorInfo": ComponentVendorInfo,
"workflowState": "abc123"
}
]
}
}
components
Response
Returns a Components
Arguments
| Name | Description |
|---|---|
libraryType - LibraryType
|
Default = GENERAL |
orderBy - [ComponentsOrderByInput]
|
|
search - SearchFields
|
Example
Query
query Components(
$libraryType: LibraryType,
$orderBy: [ComponentsOrderByInput],
$search: SearchFields
) {
components(
libraryType: $libraryType,
orderBy: $orderBy,
search: $search
) {
connection {
edges {
...ComponentEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
}
Variables
{
"libraryType": "GENERAL",
"orderBy": [ComponentsOrderByInput],
"search": SearchFields
}
Response
{
"data": {
"components": {"connection": ComponentConnection}
}
}
componentsByIds
Response
Returns [Component]
Arguments
| Name | Description |
|---|---|
ids - [ID]
|
Example
Query
query ComponentsByIds($ids: [ID]) {
componentsByIds(ids: $ids) {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
integrations {
altium {
...AltiumInfoFragment
}
}
lastModified
lastReleaseRevision {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
releasesCount
restoreVariantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
revisionHistory {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
key
value
}
status
unitOfMeasure
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
vendorId
vendorInfo {
currentVendors
isLinked
originalVendor
previousVendors
}
workflowState
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"componentsByIds": [
{
"alias": "CMP",
"archived": true,
"assemblyParents": [Component],
"category": "abc123",
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"id": 4,
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": false,
"integrations": Integrations,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "abc123",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": true,
"name": "xyz789",
"nextRevisionValue": "abc123",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 987,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": true,
"revisionValue": "xyz789",
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpec],
"status": "DESIGN",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "abc123",
"vendorInfo": ComponentVendorInfo,
"workflowState": "xyz789"
}
]
}
}
family
Example
Query
query Family($family: String) {
family(family: $family) {
cpns {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
familyCategory
value
}
}
Variables
{"family": "xyz789"}
Response
{
"data": {
"family": {
"cpns": [Cpn],
"familyCategory": "abc123",
"value": "xyz789"
}
}
}
imagesByIds
Example
Query
query ImagesByIds($ids: [ID]) {
imagesByIds(ids: $ids) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
id
key
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
mime
mode
name
size
src
variants {
r38_24
r134_84
r185_116
r255_160
}
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"imagesByIds": [
{
"archived": false,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": "4",
"key": "abc123",
"library": Library,
"mime": "GIF",
"mode": "DUMMY",
"name": "xyz789",
"size": 123,
"src": "xyz789",
"variants": ImageVariants
}
]
}
}
libraries
Response
Returns a Libraries
Arguments
| Name | Description |
|---|---|
orderBy - [LibrariesOrderByInput]
|
Example
Query
query Libraries($orderBy: [LibrariesOrderByInput]) {
libraries(orderBy: $orderBy) {
connection {
edges {
...LibraryEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
}
Variables
{"orderBy": [LibrariesOrderByInput]}
Response
{"data": {"libraries": {"connection": LibraryConnection}}}
librariesByIds
Example
Query
query LibrariesByIds($ids: [ID]) {
librariesByIds(ids: $ids) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpnRules {
base {
...CpnRulesFieldsFragment
}
component {
...CpnRulesFieldsFragment
}
product {
...CpnRulesFieldsFragment
}
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"librariesByIds": [
{
"archived": false,
"company": Company,
"cpnRules": CpnRules,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customTileTitle": "abc123",
"description": "abc123",
"id": "4",
"lastModified": "2007-12-03T10:15:30Z",
"name": "xyz789",
"status": "abc123",
"systemGenerated": true,
"type": "GENERAL",
"users": [User]
}
]
}
}
productRevisionsByIds
Response
Returns [ProductRevision]
Arguments
| Name | Description |
|---|---|
ids - [ID]
|
Example
Query
query ProductRevisionsByIds($ids: [ID]) {
productRevisionsByIds(ids: $ids) {
alias
archived
categories
changeOrder {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
effectivity {
endDate
startDate
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
forecasts {
counter
id
key
targetDate
volume
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
lastModified
lastReleaseRevision {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
revisionHistory {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
revisionType
revisionValue
rolledUpCost {
distributor
dpn
manufacturer
mpn
}
rolledUpCostAsPrimary
status
subRevisions {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
team {
engineering {
...TeamStructFragment
}
manufacturing {
...TeamStructFragment
}
procurement {
...TeamStructFragment
}
productManager {
...TeamStructFragment
}
qa {
...TeamStructFragment
}
}
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"productRevisionsByIds": [
{
"alias": "CMP",
"archived": true,
"categories": ["xyz789"],
"changeOrder": ChangeOrder,
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"effectivity": Effectivity,
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": 4,
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": true,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"lastRevision": "abc123",
"lastStatus": "xyz789",
"legacyCpn": "xyz789",
"legacyCpnVariant": "abc123",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "abc123",
"modified": true,
"name": "abc123",
"nextRevisionValue": "abc123",
"notes": "xyz789",
"parent": Product,
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "xyz789",
"revisionHistory": ProductRevision,
"revisionType": "CHANGE_ORDER",
"revisionValue": "abc123",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": false,
"status": "DESIGN",
"subRevisions": [ProductRevision],
"team": ProductTeam,
"variantGroup": VariantGroup
}
]
}
}
products
Response
Returns a Products
Arguments
| Name | Description |
|---|---|
libraryType - LibraryType
|
Default = GENERAL |
orderBy - [ProductsOrderByInput]
|
|
search - SearchFields
|
Example
Query
query Products(
$libraryType: LibraryType,
$orderBy: [ProductsOrderByInput],
$search: SearchFields
) {
products(
libraryType: $libraryType,
orderBy: $orderBy,
search: $search
) {
connection {
edges {
...ProductEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
}
Variables
{
"libraryType": "GENERAL",
"orderBy": [ProductsOrderByInput],
"search": SearchFields
}
Response
{"data": {"products": {"connection": ProductConnection}}}
productsByIds
Example
Query
query ProductsByIds($ids: [ID]) {
productsByIds(ids: $ids) {
alias
archived
categories
changeOrders {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
effectivity {
endDate
startDate
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
forecasts {
counter
id
key
targetDate
volume
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
lastModified
lastReleaseRevision {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
revisionHistory {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
revisionValue
rolledUpCost {
distributor
dpn
manufacturer
mpn
}
rolledUpCostAsPrimary
status
team {
engineering {
...TeamStructFragment
}
manufacturing {
...TeamStructFragment
}
procurement {
...TeamStructFragment
}
productManager {
...TeamStructFragment
}
qa {
...TeamStructFragment
}
}
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"productsByIds": [
{
"alias": "CMP",
"archived": true,
"categories": ["xyz789"],
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"effectivity": Effectivity,
"eid": "abc123",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": "4",
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": true,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "xyz789",
"modified": false,
"name": "xyz789",
"nextRevisionValue": "abc123",
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "abc123",
"revisionHistory": [ProductRevision],
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": true,
"status": "DESIGN",
"team": ProductTeam,
"variantGroup": VariantGroup
}
]
}
}
subdomain
Response
Returns a Subdomain
Example
Query
query Subdomain {
subdomain {
forwardTo
}
}
Response
{
"data": {
"subdomain": {"forwardTo": "xyz789"}
}
}
tokenActiveLibrary
Description
Returns the currently library that is used for requests made with the provided token.
Response
Returns a Library
Example
Query
query TokenActiveLibrary {
tokenActiveLibrary {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpnRules {
base {
...CpnRulesFieldsFragment
}
component {
...CpnRulesFieldsFragment
}
product {
...CpnRulesFieldsFragment
}
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
}
}
Response
{
"data": {
"tokenActiveLibrary": {
"archived": true,
"company": Company,
"cpnRules": CpnRules,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customTileTitle": "xyz789",
"description": "abc123",
"id": 4,
"lastModified": "2007-12-03T10:15:30Z",
"name": "abc123",
"status": "abc123",
"systemGenerated": false,
"type": "GENERAL",
"users": [User]
}
}
}
userById
Example
Query
query UserById($id: ID) {
userById(id: $id) {
activeLibrary {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
archived
avatar {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
created
email
firstName
groups
id
integrations
invite {
accepted
from
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
logins {
id
loginAt
}
onShapeKeys {
accessCode
expiresAt
lastUpdated
refreshToken
}
onboarding {
companyLibraryNotification
completedSteps
currentStep
displaySampleProduct
dummyProductType
onBoardingNotification
personalLibraryNotification
quickStartGuideNotification
status
}
personalLibrary {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
preferences {
favorite {
...FavoriteFragment
}
}
primaryCompany {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
rememberUserDevice {
device
lastUsed
}
role
solidworksAnalytics {
addInVersion
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
osVersion
swxVersion
}
status
styles
timezoneOffset
title
verified
}
}
Variables
{"id": 4}
Response
{
"data": {
"userById": {
"activeLibrary": Library,
"archived": true,
"avatar": Image,
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"firstName": "xyz789",
"groups": ["ENGINEERING"],
"id": 4,
"integrations": {},
"invite": Invite,
"isSetupCompleted": false,
"lastDayActiveAt": "2007-12-03T10:15:30Z",
"lastLogin": "2007-12-03T10:15:30Z",
"lastName": "abc123",
"libraries": [Library],
"logins": [LoginTime],
"onShapeKeys": OnShapeKeys,
"onboarding": Onboarding,
"personalLibrary": Library,
"preferences": Preferences,
"primaryCompany": Company,
"rememberUserDevice": RememberUserDevice,
"role": "ADMINISTRATOR",
"solidworksAnalytics": [SolidworksAnalytics],
"status": "DISABLED",
"styles": "abc123",
"timezoneOffset": 123,
"title": "xyz789",
"verified": false
}
}
}
webhooksByIds
Example
Query
query WebhooksByIds($ids: [ID]) {
webhooksByIds(ids: $ids) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
description
eventTypes
id
includeComponentProductData
lastModified
mode
signingSecret
status
webhookUrl
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"webhooksByIds": [
{
"archived": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "xyz789",
"eventTypes": ["CMP_CREATED"],
"id": "4",
"includeComponentProductData": false,
"lastModified": "2007-12-03T10:15:30Z",
"mode": "DUMMY",
"signingSecret": "xyz789",
"status": "xyz789",
"webhookUrl": "abc123"
}
]
}
}
Mutations
createChangeOrder
Response
Returns a ChangeOrder
Arguments
| Name | Description |
|---|---|
input - CreateChangeOrderInput
|
Example
Query
mutation CreateChangeOrder($input: CreateChangeOrderInput) {
createChangeOrder(input: $input) {
alias
approvalType
approvers {
action
id
invitedAt
performedAt
user {
...UserFragment
}
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
componentRevisions {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
components {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
con {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
erpOptions {
additionalPayloadForNotifications {
...AdditionalPayloadForNotificationsFragment
}
effectivity {
...ChangeOrderErpEffectivityFragment
}
itemType {
...ChangeOrderErpItemTypeFragment
}
}
exportBundleKey
history {
action
comment
created
id
user {
...UserFragment
}
}
id
isParentInclude
lastModified
legacyCon
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
name
productRevisions {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
products {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
resolution
status
transitionOrigin
type
unchangedComponents {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
unchangedProducts {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
}
}
Variables
{"input": CreateChangeOrderInput}
Response
{
"data": {
"createChangeOrder": {
"alias": "xyz789",
"approvalType": "FIRST_IN",
"approvers": [ChangeOrderApprover],
"archived": false,
"coExternalNotifyUserEmails": [
"abc123"
],
"coInternalNotifyUsers": [User],
"company": Company,
"componentRevisions": [ComponentRevision],
"components": [Component],
"con": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "xyz789",
"documentLinks": [DocumentLink],
"erpOptions": ChangeOrderErpOptions,
"exportBundleKey": "xyz789",
"history": [ChangeOrderHistory],
"id": "4",
"isParentInclude": true,
"lastModified": "2007-12-03T10:15:30Z",
"legacyCon": "abc123",
"library": Library,
"name": "abc123",
"productRevisions": [ProductRevision],
"products": [Product],
"resolution": "APPROVED",
"status": "CLOSED",
"transitionOrigin": "DURO",
"type": "DCO",
"unchangedComponents": [Component],
"unchangedProducts": [Product]
}
}
}
createComponent
Response
Returns a Component
Arguments
| Name | Description |
|---|---|
input - CreateComponentInput
|
Example
Query
mutation CreateComponent($input: CreateComponentInput) {
createComponent(input: $input) {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
integrations {
altium {
...AltiumInfoFragment
}
}
lastModified
lastReleaseRevision {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
releasesCount
restoreVariantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
revisionHistory {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
key
value
}
status
unitOfMeasure
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
vendorId
vendorInfo {
currentVendors
isLinked
originalVendor
previousVendors
}
workflowState
}
}
Variables
{"input": CreateComponentInput}
Response
{
"data": {
"createComponent": {
"alias": "CMP",
"archived": false,
"assemblyParents": [Component],
"category": "xyz789",
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "abc123",
"documentLinks": [DocumentLink],
"eid": "abc123",
"flattenedBom": [FlattenedBom],
"id": "4",
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": true,
"integrations": Integrations,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "xyz789",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": false,
"name": "abc123",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 123,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": true,
"revisionValue": "xyz789",
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpec],
"status": "DESIGN",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "xyz789",
"vendorInfo": ComponentVendorInfo,
"workflowState": "xyz789"
}
}
}
createDocuments
Description
Uploads must be form-data requests with the header apollo-require-preflight: true. Example:
curl https://BASE_URL/graphql -H "authorization: Bearer YOUR_TOKEN" -H "apollo-require-preflight:true" \
-F operations='{ "query": "mutation ($input:[CreateDocumentInput]!, $itemId: ID!, $itemType: ModelType!) { createDocuments(input:$input, itemId: $itemId, itemType: $itemType) { id mime name size src status url }}", "variables": {"input": [{"mime": "application/pdf", "name":"duro.pdf", "file":null, "type":"DATASHEET" }], "itemId": "YOUR_COMPONENT_ID", "itemType": "CMP"} }' \
-F map='{ "0": ["variables.input.0.file"] }' \
-F 0=@/path/to/duro.pdfResponse
Returns [Document]
Arguments
| Name | Description |
|---|---|
input - [CreateDocumentInput]
|
|
itemId - ID
|
Component/Product to attach documents to. |
itemType - ModelType
|
Component or Product type |
Example
Query
mutation CreateDocuments(
$input: [CreateDocumentInput],
$itemId: ID,
$itemType: ModelType
) {
createDocuments(
input: $input,
itemId: $itemId,
itemType: $itemType
) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
id
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
mime
mode
name
regenerateDocumentRequest
size
src
status
translationId
url
vendor
visibility
}
}
Variables
{
"input": [CreateDocumentInput],
"itemId": 4,
"itemType": "CMP"
}
Response
{
"data": {
"createDocuments": [
{
"archived": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": "4",
"library": Library,
"mime": "abc123",
"mode": "DUMMY",
"name": "xyz789",
"regenerateDocumentRequest": "xyz789",
"size": 123,
"src": "xyz789",
"status": "COMPLETED",
"translationId": "abc123",
"url": "abc123",
"vendor": "ALTIUM",
"visibility": false
}
]
}
}
createProduct
Response
Returns a Product
Arguments
| Name | Description |
|---|---|
input - CreateProductInput
|
Example
Query
mutation CreateProduct($input: CreateProductInput) {
createProduct(input: $input) {
alias
archived
categories
changeOrders {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
effectivity {
endDate
startDate
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
forecasts {
counter
id
key
targetDate
volume
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
lastModified
lastReleaseRevision {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
revisionHistory {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
revisionValue
rolledUpCost {
distributor
dpn
manufacturer
mpn
}
rolledUpCostAsPrimary
status
team {
engineering {
...TeamStructFragment
}
manufacturing {
...TeamStructFragment
}
procurement {
...TeamStructFragment
}
productManager {
...TeamStructFragment
}
qa {
...TeamStructFragment
}
}
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
}
}
Variables
{"input": CreateProductInput}
Response
{
"data": {
"createProduct": {
"alias": "CMP",
"archived": true,
"categories": ["xyz789"],
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "abc123",
"documentLinks": [DocumentLink],
"effectivity": Effectivity,
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": 4,
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": false,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "abc123",
"modified": false,
"name": "xyz789",
"nextRevisionValue": "abc123",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "xyz789",
"revisionHistory": [ProductRevision],
"revisionValue": "abc123",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": true,
"status": "DESIGN",
"team": ProductTeam,
"variantGroup": VariantGroup
}
}
}
createWebhook
Response
Returns a Webhook
Arguments
| Name | Description |
|---|---|
input - CreateWebhookInput
|
Example
Query
mutation CreateWebhook($input: CreateWebhookInput) {
createWebhook(input: $input) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
description
eventTypes
id
includeComponentProductData
lastModified
mode
signingSecret
status
webhookUrl
}
}
Variables
{"input": CreateWebhookInput}
Response
{
"data": {
"createWebhook": {
"archived": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "xyz789",
"eventTypes": ["CMP_CREATED"],
"id": 4,
"includeComponentProductData": false,
"lastModified": "2007-12-03T10:15:30Z",
"mode": "DUMMY",
"signingSecret": "abc123",
"status": "xyz789",
"webhookUrl": "xyz789"
}
}
}
deleteChangeOrder
Response
Returns a ChangeOrder
Arguments
| Name | Description |
|---|---|
input - DeleteInput
|
Example
Query
mutation DeleteChangeOrder($input: DeleteInput) {
deleteChangeOrder(input: $input) {
alias
approvalType
approvers {
action
id
invitedAt
performedAt
user {
...UserFragment
}
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
componentRevisions {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
components {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
con {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
erpOptions {
additionalPayloadForNotifications {
...AdditionalPayloadForNotificationsFragment
}
effectivity {
...ChangeOrderErpEffectivityFragment
}
itemType {
...ChangeOrderErpItemTypeFragment
}
}
exportBundleKey
history {
action
comment
created
id
user {
...UserFragment
}
}
id
isParentInclude
lastModified
legacyCon
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
name
productRevisions {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
products {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
resolution
status
transitionOrigin
type
unchangedComponents {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
unchangedProducts {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
}
}
Variables
{"input": DeleteInput}
Response
{
"data": {
"deleteChangeOrder": {
"alias": "xyz789",
"approvalType": "FIRST_IN",
"approvers": [ChangeOrderApprover],
"archived": false,
"coExternalNotifyUserEmails": [
"abc123"
],
"coInternalNotifyUsers": [User],
"company": Company,
"componentRevisions": [ComponentRevision],
"components": [Component],
"con": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "abc123",
"documentLinks": [DocumentLink],
"erpOptions": ChangeOrderErpOptions,
"exportBundleKey": "xyz789",
"history": [ChangeOrderHistory],
"id": "4",
"isParentInclude": false,
"lastModified": "2007-12-03T10:15:30Z",
"legacyCon": "abc123",
"library": Library,
"name": "xyz789",
"productRevisions": [ProductRevision],
"products": [Product],
"resolution": "APPROVED",
"status": "CLOSED",
"transitionOrigin": "DURO",
"type": "DCO",
"unchangedComponents": [Component],
"unchangedProducts": [Product]
}
}
}
deleteComponent
Response
Returns a Component
Arguments
| Name | Description |
|---|---|
input - DeleteInput
|
Example
Query
mutation DeleteComponent($input: DeleteInput) {
deleteComponent(input: $input) {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
integrations {
altium {
...AltiumInfoFragment
}
}
lastModified
lastReleaseRevision {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
releasesCount
restoreVariantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
revisionHistory {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
key
value
}
status
unitOfMeasure
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
vendorId
vendorInfo {
currentVendors
isLinked
originalVendor
previousVendors
}
workflowState
}
}
Variables
{"input": DeleteInput}
Response
{
"data": {
"deleteComponent": {
"alias": "CMP",
"archived": false,
"assemblyParents": [Component],
"category": "xyz789",
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"id": "4",
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": true,
"integrations": Integrations,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": true,
"name": "abc123",
"nextRevisionValue": "abc123",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 987,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": true,
"revisionValue": "xyz789",
"rolledUpCostAsPrimary": true,
"specs": [ComponentSpec],
"status": "DESIGN",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "xyz789",
"vendorInfo": ComponentVendorInfo,
"workflowState": "abc123"
}
}
}
deleteDocuments
Response
Returns [Document]
Arguments
| Name | Description |
|---|---|
input - [DeleteInput]
|
|
itemId - ID
|
Component/Product to attach documents to. |
itemType - ModelType
|
Component or Product type |
Example
Query
mutation DeleteDocuments(
$input: [DeleteInput],
$itemId: ID,
$itemType: ModelType
) {
deleteDocuments(
input: $input,
itemId: $itemId,
itemType: $itemType
) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
id
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
mime
mode
name
regenerateDocumentRequest
size
src
status
translationId
url
vendor
visibility
}
}
Variables
{
"input": [DeleteInput],
"itemId": "4",
"itemType": "CMP"
}
Response
{
"data": {
"deleteDocuments": [
{
"archived": false,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": 4,
"library": Library,
"mime": "abc123",
"mode": "DUMMY",
"name": "abc123",
"regenerateDocumentRequest": "abc123",
"size": 987,
"src": "xyz789",
"status": "COMPLETED",
"translationId": "xyz789",
"url": "abc123",
"vendor": "ALTIUM",
"visibility": false
}
]
}
}
deleteProduct
Response
Returns a Product
Arguments
| Name | Description |
|---|---|
input - DeleteInput
|
Example
Query
mutation DeleteProduct($input: DeleteInput) {
deleteProduct(input: $input) {
alias
archived
categories
changeOrders {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
effectivity {
endDate
startDate
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
forecasts {
counter
id
key
targetDate
volume
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
lastModified
lastReleaseRevision {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
revisionHistory {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
revisionValue
rolledUpCost {
distributor
dpn
manufacturer
mpn
}
rolledUpCostAsPrimary
status
team {
engineering {
...TeamStructFragment
}
manufacturing {
...TeamStructFragment
}
procurement {
...TeamStructFragment
}
productManager {
...TeamStructFragment
}
qa {
...TeamStructFragment
}
}
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
}
}
Variables
{"input": DeleteInput}
Response
{
"data": {
"deleteProduct": {
"alias": "CMP",
"archived": true,
"categories": ["abc123"],
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"effectivity": Effectivity,
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": "4",
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": false,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "abc123",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "xyz789",
"modified": true,
"name": "abc123",
"nextRevisionValue": "abc123",
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "xyz789",
"revisionHistory": [ProductRevision],
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": false,
"status": "DESIGN",
"team": ProductTeam,
"variantGroup": VariantGroup
}
}
}
deleteWebhookById
Response
Returns a Webhook
Arguments
| Name | Description |
|---|---|
input - DeleteInput
|
Example
Query
mutation DeleteWebhookById($input: DeleteInput) {
deleteWebhookById(input: $input) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
description
eventTypes
id
includeComponentProductData
lastModified
mode
signingSecret
status
webhookUrl
}
}
Variables
{"input": DeleteInput}
Response
{
"data": {
"deleteWebhookById": {
"archived": false,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "xyz789",
"eventTypes": ["CMP_CREATED"],
"id": "4",
"includeComponentProductData": true,
"lastModified": "2007-12-03T10:15:30Z",
"mode": "DUMMY",
"signingSecret": "abc123",
"status": "xyz789",
"webhookUrl": "xyz789"
}
}
}
deleteWebhookByUrl
Response
Returns [Webhook]
Arguments
| Name | Description |
|---|---|
input - DeleteWebhookByUrlInput
|
Example
Query
mutation DeleteWebhookByUrl($input: DeleteWebhookByUrlInput) {
deleteWebhookByUrl(input: $input) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
description
eventTypes
id
includeComponentProductData
lastModified
mode
signingSecret
status
webhookUrl
}
}
Variables
{"input": DeleteWebhookByUrlInput}
Response
{
"data": {
"deleteWebhookByUrl": [
{
"archived": false,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "abc123",
"eventTypes": ["CMP_CREATED"],
"id": "4",
"includeComponentProductData": true,
"lastModified": "2007-12-03T10:15:30Z",
"mode": "DUMMY",
"signingSecret": "xyz789",
"status": "abc123",
"webhookUrl": "xyz789"
}
]
}
}
updateChangeOrder
Response
Returns a ChangeOrder
Arguments
| Name | Description |
|---|---|
input - UpdateChangeOrderInput
|
|
submit - Boolean
|
Example
Query
mutation UpdateChangeOrder(
$input: UpdateChangeOrderInput,
$submit: Boolean
) {
updateChangeOrder(
input: $input,
submit: $submit
) {
alias
approvalType
approvers {
action
id
invitedAt
performedAt
user {
...UserFragment
}
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
componentRevisions {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
components {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
con {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
erpOptions {
additionalPayloadForNotifications {
...AdditionalPayloadForNotificationsFragment
}
effectivity {
...ChangeOrderErpEffectivityFragment
}
itemType {
...ChangeOrderErpItemTypeFragment
}
}
exportBundleKey
history {
action
comment
created
id
user {
...UserFragment
}
}
id
isParentInclude
lastModified
legacyCon
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
name
productRevisions {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
products {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
resolution
status
transitionOrigin
type
unchangedComponents {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrations {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
unchangedProducts {
alias
archived
categories
changeOrders {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
}
}
Variables
{"input": UpdateChangeOrderInput, "submit": false}
Response
{
"data": {
"updateChangeOrder": {
"alias": "xyz789",
"approvalType": "FIRST_IN",
"approvers": [ChangeOrderApprover],
"archived": false,
"coExternalNotifyUserEmails": [
"xyz789"
],
"coInternalNotifyUsers": [User],
"company": Company,
"componentRevisions": [ComponentRevision],
"components": [Component],
"con": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "xyz789",
"documentLinks": [DocumentLink],
"erpOptions": ChangeOrderErpOptions,
"exportBundleKey": "xyz789",
"history": [ChangeOrderHistory],
"id": 4,
"isParentInclude": true,
"lastModified": "2007-12-03T10:15:30Z",
"legacyCon": "xyz789",
"library": Library,
"name": "abc123",
"productRevisions": [ProductRevision],
"products": [Product],
"resolution": "APPROVED",
"status": "CLOSED",
"transitionOrigin": "DURO",
"type": "DCO",
"unchangedComponents": [Component],
"unchangedProducts": [Product]
}
}
}
updateComponent
Response
Returns a Component
Arguments
| Name | Description |
|---|---|
input - UpdateComponentInput
|
Example
Query
mutation UpdateComponent($input: UpdateComponentInput) {
updateComponent(input: $input) {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
integrations {
altium {
...AltiumInfoFragment
}
}
lastModified
lastReleaseRevision {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
releasesCount
restoreVariantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
revisionHistory {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documents {
...DocumentLinkFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
integrationFields {
...IntegrationsFragment
}
lastModified
lastReleaseRevision {
...ComponentRevisionFragment
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ComponentFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
subRevisions {
...ComponentRevisionFragment
}
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
key
value
}
status
unitOfMeasure
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
vendorId
vendorInfo {
currentVendors
isLinked
originalVendor
previousVendors
}
workflowState
}
}
Variables
{"input": UpdateComponentInput}
Response
{
"data": {
"updateComponent": {
"alias": "CMP",
"archived": false,
"assemblyParents": [Component],
"category": "xyz789",
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"eid": "abc123",
"flattenedBom": [FlattenedBom],
"id": "4",
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": false,
"integrations": Integrations,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "xyz789",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": true,
"name": "xyz789",
"nextRevisionValue": "abc123",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 123,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": false,
"revisionValue": "abc123",
"rolledUpCostAsPrimary": true,
"specs": [ComponentSpec],
"status": "DESIGN",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "abc123",
"vendorInfo": ComponentVendorInfo,
"workflowState": "xyz789"
}
}
}
updateProduct
Response
Returns a Product
Arguments
| Name | Description |
|---|---|
input - UpdateProductInput
|
Example
Query
mutation UpdateProduct($input: UpdateProductInput) {
updateProduct(input: $input) {
alias
archived
categories
changeOrders {
alias
approvalType
approvers {
...ChangeOrderApproverFragment
}
archived
coExternalNotifyUserEmails
coInternalNotifyUsers {
...UserFragment
}
company {
...CompanyFragment
}
componentRevisions {
...ComponentRevisionFragment
}
components {
...ComponentFragment
}
con {
...CpnFragment
}
created
creator {
...UserFragment
}
description
documentLinks {
...DocumentLinkFragment
}
erpOptions {
...ChangeOrderErpOptionsFragment
}
exportBundleKey
history {
...ChangeOrderHistoryFragment
}
id
isParentInclude
lastModified
legacyCon
library {
...LibraryFragment
}
name
productRevisions {
...ProductRevisionFragment
}
products {
...ProductFragment
}
resolution
status
transitionOrigin
type
unchangedComponents {
...ComponentFragment
}
unchangedProducts {
...ProductFragment
}
}
children {
assemblyRevision {
...ComponentRevisionFragment
}
component {
...ComponentFragment
}
isAddedAfterPullRequest
itemNumber
notes
quantity
refDes
type
variants {
...ComponentVariantContainerFragment
}
waste
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
created
creator {
...UserFragment
}
id
integrations
isEnabledCustomCategory
legacyCpnVariantScheme
logo {
...ImageFragment
}
name
onshapeRegisteredCompanies
revisionScheme
settings {
...CompanySettingsFragment
}
specs {
...SpecFragment
}
subdomain
subscriptions {
...PaidSubscriptionFragment
}
users {
...UserFragment
}
website
}
cpn {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
id
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
created
creator {
activeLibrary {
...LibraryFragment
}
archived
avatar {
...ImageFragment
}
created
email
firstName
groups
id
integrations
invite {
...InviteFragment
}
isSetupCompleted
lastDayActiveAt
lastLogin
lastName
libraries {
...LibraryFragment
}
logins {
...LoginTimeFragment
}
onShapeKeys {
...OnShapeKeysFragment
}
onboarding {
...OnboardingFragment
}
personalLibrary {
...LibraryFragment
}
preferences {
...PreferencesFragment
}
primaryCompany {
...CompanyFragment
}
rememberUserDevice {
...RememberUserDeviceFragment
}
role
solidworksAnalytics {
...SolidworksAnalyticsFragment
}
status
styles
timezoneOffset
title
verified
}
customSpecs {
key
specId
value
}
description
documentLinks {
document {
...DocumentFragment
}
specs {
...DocumentSpecFragment
}
}
effectivity {
endDate
startDate
}
eid
flattenedBom {
childRev {
...ComponentRevisionFragment
}
childRevId
component {
...ComponentFragment
}
componentId
level
quantity
}
forecasts {
counter
id
key
targetDate
volume
}
id
imageIds
images {
archived
company {
...CompanyFragment
}
created
creator {
...UserFragment
}
id
key
library {
...LibraryFragment
}
mime
mode
name
size
src
variants {
...ImageVariantsFragment
}
}
incompleteCost
lastModified
lastReleaseRevision {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
archived
company {
...CompanyFragment
}
cpnRules {
...CpnRulesFragment
}
created
creator {
...UserFragment
}
customTileTitle
description
id
lastModified
name
status
systemGenerated
type
users {
...UserFragment
}
}
manufacturers {
datasheet {
...DatasheetFragment
}
description
distributors {
...DistributorFragment
}
leadTimeDays
mpn {
...UrlKeyFragment
}
name
status
warrantyMonths
}
mass
massStatus
mode
modified
name
nextRevisionValue
previousRevisionValue
previousStatus
primarySource {
distributor
dpn
extendedCost
leadTimeDays
manufacturer
minQuantity
mpn
unitPrice
}
procurement
revisionHistory {
alias
archived
categories
changeOrder {
...ChangeOrderFragment
}
children {
...AssemblyChildFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
effectivity {
...EffectivityFragment
}
eid
flattenedBom {
...FlattenedBomFragment
}
forecasts {
...ForecastFragment
}
id
imageIds
images {
...ImageFragment
}
incompleteCost
lastModified
lastReleaseRevision {
...ProductRevisionFragment
}
lastRevision
lastStatus
legacyCpn
legacyCpnVariant
legacyNextRevision
library {
...LibraryFragment
}
manufacturers {
...ManufacturerFragment
}
mass
massStatus
mode
modified
name
nextRevisionValue
notes
parent {
...ProductFragment
}
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
revisionHistory {
...ProductRevisionFragment
}
revisionType
revisionValue
rolledUpCost {
...RolledUpCostFragment
}
rolledUpCostAsPrimary
status
subRevisions {
...ProductRevisionFragment
}
team {
...ProductTeamFragment
}
variantGroup {
...VariantGroupFragment
}
}
revisionValue
rolledUpCost {
distributor
dpn
manufacturer
mpn
}
rolledUpCostAsPrimary
status
team {
engineering {
...TeamStructFragment
}
manufacturing {
...TeamStructFragment
}
procurement {
...TeamStructFragment
}
productManager {
...TeamStructFragment
}
qa {
...TeamStructFragment
}
}
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
}
}
Variables
{"input": UpdateProductInput}
Response
{
"data": {
"updateProduct": {
"alias": "CMP",
"archived": true,
"categories": ["xyz789"],
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"effectivity": Effectivity,
"eid": "abc123",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": 4,
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": true,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"legacyCpn": "xyz789",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "xyz789",
"modified": true,
"name": "abc123",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "xyz789",
"revisionHistory": [ProductRevision],
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": true,
"status": "DESIGN",
"team": ProductTeam,
"variantGroup": VariantGroup
}
}
}
Types
AdditionalPayloadForNotifications
Address
AltiumInfo
Fields
| Field Name | Description |
|---|---|
revision - String
|
|
status - AltiumStatus
|
Example
{"revision": "abc123", "status": "DRAFT"}
AltiumStatus
Description
Altium statuses
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRAFT"
ApiToken
Fields
| Field Name | Description |
|---|---|
token - String
|
Example
{"token": "xyz789"}
ApiTokenType
Description
API token type (TBD)
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TBD"
AssemblyChild
Fields
| Field Name | Description |
|---|---|
assemblyRevision - ComponentRevision
|
|
component - Component
|
|
isAddedAfterPullRequest - Boolean
|
|
itemNumber - Int
|
|
notes - String
|
|
quantity - Float
|
|
refDes - String
|
|
type - ModelType
|
|
variants - [ComponentVariantContainer]
|
|
waste - Float
|
Example
{
"assemblyRevision": ComponentRevision,
"component": Component,
"isAddedAfterPullRequest": false,
"itemNumber": 123,
"notes": "xyz789",
"quantity": 123.45,
"refDes": "xyz789",
"type": "CMP",
"variants": [ComponentVariantContainer],
"waste": 123.45
}
AssemblyChildInput
Example
{
"assemblyRevisionId": "xyz789",
"componentId": "xyz789",
"isAddedAfterPullRequest": false,
"itemNumber": 123,
"notes": "xyz789",
"quantity": 123.45,
"refDes": "xyz789",
"variants": [AssemblyVariantInput],
"waste": 123.45
}
AssemblyParent
AssemblyVariantInput
BlacklistedRevision
Description
Blacklisted revision
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"I"
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Categories
Fields
| Field Name | Description |
|---|---|
connection - CategoryConnection
|
|
Arguments
|
|
Example
{"connection": CategoryConnection}
CategoriesOrderByInput
Fields
| Input Field | Description |
|---|---|
code - SortDirection
|
|
isAllowedInPartAndAssembly - SortDirection
|
|
isDefaultCategory - SortDirection
|
|
name - SortDirection
|
|
shortName - SortDirection
|
|
type - SortDirection
|
|
unitOfMeasure - SortDirection
|
Example
{
"code": "asc",
"isAllowedInPartAndAssembly": "asc",
"isDefaultCategory": "asc",
"name": "asc",
"shortName": "asc",
"type": "asc",
"unitOfMeasure": "asc"
}
Category
Example
{
"archived": true,
"code": "xyz789",
"customSpecs": [Spec],
"id": "4",
"isAllowedInPartAndAssembly": true,
"isDefaultCategory": false,
"name": "abc123",
"shortName": "abc123",
"specs": [Spec],
"tags": ["MCAD"],
"type": "xyz789",
"unitOfMeasure": "AR"
}
CategoryConnection
Fields
| Field Name | Description |
|---|---|
edges - [CategoryEdge]
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types |
pageInfo - PageInfo!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo |
totalCount - Int
|
Example
{
"edges": [CategoryEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CategoryEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor |
node - Category
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Node |
Example
{
"cursor": "xyz789",
"node": Category
}
CategoryTag
Description
Category tag type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"MCAD"
ChangeOrder
Fields
| Field Name | Description |
|---|---|
alias - String
|
|
approvalType - EcoDefaultApproval
|
|
approvers - [ChangeOrderApprover]
|
|
archived - Boolean
|
|
coExternalNotifyUserEmails - [String]
|
|
coInternalNotifyUsers - [User]
|
|
company - Company
|
|
componentRevisions - [ComponentRevision]
|
|
components - [Component]
|
|
con - Cpn
|
|
created - DateTime
|
|
creator - User
|
|
description - String
|
|
documentLinks - [DocumentLink]
|
|
erpOptions - ChangeOrderErpOptions
|
|
exportBundleKey - String
|
|
history - [ChangeOrderHistory]
|
|
id - ID
|
|
isParentInclude - Boolean
|
|
lastModified - DateTime
|
|
legacyCon - String
|
To be deprecated |
library - Library
|
|
name - String
|
|
productRevisions - [ProductRevision]
|
|
products - [Product]
|
|
resolution - ChangeOrderResolution
|
|
status - ChangeOrderStatus
|
|
transitionOrigin - ChangeOrderTransitionOrigin
|
|
type - ChangeOrderType
|
|
unchangedComponents - [Component]
|
|
unchangedProducts - [Product]
|
Example
{
"alias": "xyz789",
"approvalType": "FIRST_IN",
"approvers": [ChangeOrderApprover],
"archived": true,
"coExternalNotifyUserEmails": ["abc123"],
"coInternalNotifyUsers": [User],
"company": Company,
"componentRevisions": [ComponentRevision],
"components": [Component],
"con": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "xyz789",
"documentLinks": [DocumentLink],
"erpOptions": ChangeOrderErpOptions,
"exportBundleKey": "abc123",
"history": [ChangeOrderHistory],
"id": "4",
"isParentInclude": true,
"lastModified": "2007-12-03T10:15:30Z",
"legacyCon": "xyz789",
"library": Library,
"name": "xyz789",
"productRevisions": [ProductRevision],
"products": [Product],
"resolution": "APPROVED",
"status": "CLOSED",
"transitionOrigin": "DURO",
"type": "DCO",
"unchangedComponents": [Component],
"unchangedProducts": [Product]
}
ChangeOrderAction
Description
Change Order Action
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVED"
ChangeOrderApprovalTemplate
Example
{
"approvalType": "FIRST_IN",
"approvers": [User],
"archived": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"externalUsers": ["abc123"],
"id": "4",
"isPublic": true,
"notifiers": [User],
"templateName": "abc123"
}
ChangeOrderApprover
Fields
| Field Name | Description |
|---|---|
action - ChangeOrderAction
|
|
id - ID
|
|
invitedAt - DateTime
|
|
performedAt - DateTime
|
|
user - User
|
Example
{
"action": "APPROVED",
"id": 4,
"invitedAt": "2007-12-03T10:15:30Z",
"performedAt": "2007-12-03T10:15:30Z",
"user": User
}
ChangeOrderConnection
Fields
| Field Name | Description |
|---|---|
edges - [ChangeOrderEdge]
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types |
pageInfo - PageInfo!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo |
totalCount - Int
|
Example
{
"edges": [ChangeOrderEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ChangeOrderEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor |
node - ChangeOrder
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Node |
Example
{
"cursor": "xyz789",
"node": ChangeOrder
}
ChangeOrderErpEffectivity
ChangeOrderErpEffectivityInput
ChangeOrderErpItemType
Fields
| Field Name | Description |
|---|---|
isEnabled - Boolean
|
|
overrideExisting - Boolean
|
|
value - ErpItemType
|
Example
{"isEnabled": false, "overrideExisting": false, "value": "LOT_TRACKED"}
ChangeOrderErpItemTypeInput
Fields
| Input Field | Description |
|---|---|
isEnabled - Boolean
|
|
overrideExisting - Boolean
|
|
value - ErpItemType
|
Example
{"isEnabled": false, "overrideExisting": false, "value": "LOT_TRACKED"}
ChangeOrderErpOptions
Fields
| Field Name | Description |
|---|---|
additionalPayloadForNotifications - AdditionalPayloadForNotifications
|
|
effectivity - ChangeOrderErpEffectivity
|
|
itemType - ChangeOrderErpItemType
|
Example
{
"additionalPayloadForNotifications": AdditionalPayloadForNotifications,
"effectivity": ChangeOrderErpEffectivity,
"itemType": ChangeOrderErpItemType
}
ChangeOrderErpOptionsInput
Fields
| Input Field | Description |
|---|---|
effectivity - ChangeOrderErpEffectivityInput
|
|
itemType - ChangeOrderErpItemTypeInput
|
Example
{
"effectivity": ChangeOrderErpEffectivityInput,
"itemType": ChangeOrderErpItemTypeInput
}
ChangeOrderHistory
Fields
| Field Name | Description |
|---|---|
action - ChangeOrderAction
|
|
comment - String
|
|
created - DateTime
|
|
id - ID
|
|
user - User
|
Example
{
"action": "APPROVED",
"comment": "xyz789",
"created": "2007-12-03T10:15:30Z",
"id": 4,
"user": User
}
ChangeOrderResolution
Description
Change Order Resolution
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVED"
ChangeOrderStatus
Description
Change Order Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLOSED"
ChangeOrderTemplateMapping
Fields
| Field Name | Description |
|---|---|
company - Company
|
|
dcoProduction - ChangeOrderApprovalTemplate
|
|
dcoPrototype - ChangeOrderApprovalTemplate
|
|
ecoProduction - ChangeOrderApprovalTemplate
|
|
ecoPrototype - ChangeOrderApprovalTemplate
|
|
id - ID
|
|
mcoProduction - ChangeOrderApprovalTemplate
|
|
mcoPrototype - ChangeOrderApprovalTemplate
|
Example
{
"company": Company,
"dcoProduction": ChangeOrderApprovalTemplate,
"dcoPrototype": ChangeOrderApprovalTemplate,
"ecoProduction": ChangeOrderApprovalTemplate,
"ecoPrototype": ChangeOrderApprovalTemplate,
"id": "4",
"mcoProduction": ChangeOrderApprovalTemplate,
"mcoPrototype": ChangeOrderApprovalTemplate
}
ChangeOrderTransitionOrigin
Description
Change Order Transition Origin
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DURO"
ChangeOrderType
Description
Change Order Type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DCO"
ChangeOrders
Fields
| Field Name | Description |
|---|---|
connection - ChangeOrderConnection
|
|
Arguments
|
|
Example
{"connection": ChangeOrderConnection}
ChangeOrdersOrderByInput
Fields
| Input Field | Description |
|---|---|
alias - SortDirection
|
|
con - SortDirection
|
|
description - SortDirection
|
|
lastModified - SortDirection
|
|
name - SortDirection
|
|
resolution - SortDirection
|
|
status - SortDirection
|
|
type - SortDirection
|
Example
{
"alias": "asc",
"con": "asc",
"description": "asc",
"lastModified": "asc",
"name": "asc",
"resolution": "asc",
"status": "asc",
"type": "asc"
}
Company
Fields
| Field Name | Description |
|---|---|
address - Address
|
|
archived - Boolean
|
|
categories - [Category]
|
|
created - DateTime
|
|
creator - User
|
|
id - ID
|
|
integrations - JSON
|
|
isEnabledCustomCategory - Boolean
|
|
legacyCpnVariantScheme - String
|
Deprecated |
logo - Image
|
|
name - String
|
|
onshapeRegisteredCompanies - [String]
|
|
revisionScheme - RevisionScheme
|
|
settings - CompanySettings
|
|
specs - [Spec]
|
|
Arguments
|
|
subdomain - String
|
|
subscriptions - [PaidSubscription]
|
|
users - [User]
|
|
Arguments
|
|
website - String
|
|
Example
{
"address": Address,
"archived": false,
"categories": [Category],
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": "4",
"integrations": {},
"isEnabledCustomCategory": false,
"legacyCpnVariantScheme": "abc123",
"logo": Image,
"name": "xyz789",
"onshapeRegisteredCompanies": ["xyz789"],
"revisionScheme": "ALPHA_BETA_AB",
"settings": CompanySettings,
"specs": [Spec],
"subdomain": "xyz789",
"subscriptions": [PaidSubscription],
"users": [User],
"website": "xyz789"
}
CompanySettings
Fields
| Field Name | Description |
|---|---|
allowedDocTypes - [DocumentType]
|
|
allowedUserRoles - [Role]
|
|
buildScheduleScheme - String
|
|
changeOrderTemplateMapping - ChangeOrderTemplateMapping
|
|
configurations - Configurations
|
|
customFields - CustomFields
|
|
customUomLabels - [String]
|
|
defaultBlacklistedRevisions - [BlacklistedRevision]
|
|
defaultCurrency - Currency
|
|
displayRefDesAndItemNumber - Boolean
|
|
ecoAcceptOpen - Boolean
|
|
ecoDefaultApproval - EcoDefaultApproval
|
|
erpItemTypeOptions - [ErpItemType]
|
|
fileStorageLimit - Float
|
|
isAllowedBlankItemNumber - Boolean
|
|
isApplicabilityFieldEnabled - Boolean
|
|
isBuildEnabled - Boolean
|
|
isDcoEnabled - Boolean
|
|
isEcadGeneralSpecsEnabled - Boolean
|
|
isFirstResonanceEnabled - Boolean
|
|
isNexusEnabled - Boolean
|
|
isNotRevisionManaged - Boolean
|
|
isPrimarySourceWarningDisabledInCO - Boolean
|
|
isSSOEnabled - Boolean
|
|
isSerializationEnabled - Boolean
|
|
isSpecValidationEnabled - Boolean
|
|
isValispaceEnabled - Boolean
|
|
massPrecisionValue - Float
|
|
massUnit - MassUnitType
|
|
maxFileSize - Int
|
|
shouldAutoSelectRolledUpCost - Boolean
|
|
shouldUseCpnRevFileNameFormat - Boolean
|
|
unitPricePrecision - Int
|
Example
{
"allowedDocTypes": ["ACCEPTANCE_DATA"],
"allowedUserRoles": ["ADMINISTRATOR"],
"buildScheduleScheme": "abc123",
"changeOrderTemplateMapping": ChangeOrderTemplateMapping,
"configurations": Configurations,
"customFields": CustomFields,
"customUomLabels": ["xyz789"],
"defaultBlacklistedRevisions": ["I"],
"defaultCurrency": "AUD",
"displayRefDesAndItemNumber": true,
"ecoAcceptOpen": true,
"ecoDefaultApproval": "FIRST_IN",
"erpItemTypeOptions": ["LOT_TRACKED"],
"fileStorageLimit": 123.45,
"isAllowedBlankItemNumber": false,
"isApplicabilityFieldEnabled": true,
"isBuildEnabled": true,
"isDcoEnabled": false,
"isEcadGeneralSpecsEnabled": false,
"isFirstResonanceEnabled": true,
"isNexusEnabled": false,
"isNotRevisionManaged": true,
"isPrimarySourceWarningDisabledInCO": true,
"isSSOEnabled": false,
"isSerializationEnabled": false,
"isSpecValidationEnabled": false,
"isValispaceEnabled": false,
"massPrecisionValue": 987.65,
"massUnit": "GRAMS",
"maxFileSize": 123,
"shouldAutoSelectRolledUpCost": false,
"shouldUseCpnRevFileNameFormat": false,
"unitPricePrecision": 123
}
Component
Fields
| Field Name | Description |
|---|---|
alias - ModelType
|
|
archived - Boolean
|
|
assemblyParents - [AssemblyParent]
|
|
category - String
|
|
changeOrders - [ChangeOrder]
|
|
Arguments
|
|
children - [AssemblyChild]
|
|
company - Company
|
|
cpn - Cpn
|
|
created - DateTime
|
|
creator - User
|
|
customSpecs - [CustomSpec]
|
|
description - String
|
|
documentLinks - [DocumentLink]
|
|
eid - String
|
|
flattenedBom - [FlattenedBom]
|
|
id - ID
|
|
imageIds - [String!]
|
|
images - [Image]
|
|
incompleteCost - Boolean
|
|
integrations - Integrations
|
Integration-specific fields |
lastModified - DateTime
|
|
lastReleaseRevision - ComponentRevision
|
|
legacyCpn - String
|
To be deprecated |
legacyCpnVariant - String
|
To be deprecated |
legacyNextRevision - String
|
To be deprecated |
library - Library
|
|
manufacturers - [Manufacturer]
|
|
mass - Float
|
|
massStatus - MassStatus
|
|
mode - EnvironmentMode
|
|
modified - Boolean
|
|
name - String
|
|
nextRevisionValue - String
|
Dynamically calculated next revisionValue |
Arguments
|
|
previousRevisionValue - String
|
|
previousStatus - DesignStatus
|
|
primarySource - PrimarySource
|
|
procurement - ProcurementType
|
|
releasesCount - Int
|
|
restoreVariantGroup - VariantGroup
|
|
revisionHistory - [ComponentRevision]
|
|
revisionManaged - Boolean
|
|
revisionValue - String
|
Revision string value |
rolledUpCostAsPrimary - Boolean
|
|
specs - [ComponentSpec]
|
|
status - DesignStatus
|
|
unitOfMeasure - ComponentUnitMeasure
|
|
variantGroup - VariantGroup
|
|
vendorId - String
|
|
vendorInfo - ComponentVendorInfo
|
|
workflowState - String
|
|
Example
{
"alias": "CMP",
"archived": true,
"assemblyParents": [Component],
"category": "abc123",
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"id": "4",
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": true,
"integrations": Integrations,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "xyz789",
"legacyCpnVariant": "abc123",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": false,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 987,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": true,
"revisionValue": "abc123",
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpec],
"status": "DESIGN",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "abc123",
"vendorInfo": ComponentVendorInfo,
"workflowState": "xyz789"
}
ComponentConnection
Fields
| Field Name | Description |
|---|---|
edges - [ComponentEdge]
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types |
pageInfo - PageInfo!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo |
totalCount - Int
|
Example
{
"edges": [ComponentEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
ComponentEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor |
node - Component
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Node |
Example
{
"cursor": "xyz789",
"node": Component
}
ComponentRevision
Fields
| Field Name | Description |
|---|---|
alias - ModelType
|
|
archived - Boolean
|
|
assemblyParents - [AssemblyParent]
|
|
category - String
|
|
changeOrder - ChangeOrder
|
|
children - [AssemblyChild]
|
|
company - Company
|
|
cpn - Cpn
|
|
created - DateTime
|
|
creator - User
|
|
customSpecs - [CustomSpec]
|
|
description - String
|
|
documents - [DocumentLink]
|
|
eid - String
|
|
flattenedBom - [FlattenedBom]
|
|
id - ID
|
|
imageIds - [String!]
|
|
images - [Image]
|
|
incompleteCost - Boolean
|
|
integrationFields - [Integrations]
|
Integration-specific fields |
lastModified - DateTime
|
|
lastReleaseRevision - ComponentRevision
|
|
legacyCpn - String
|
To be deprecated |
legacyCpnVariant - String
|
To be deprecated |
legacyNextRevision - String
|
To be deprecated |
library - Library
|
|
manufacturers - [Manufacturer]
|
|
mass - Float
|
|
massStatus - MassStatus
|
|
mode - EnvironmentMode
|
|
modified - Boolean
|
|
name - String
|
|
nextRevisionValue - String
|
Dynamically calculated next revisionValue |
Arguments
|
|
notes - String
|
|
parent - Component
|
|
previousRevisionValue - String
|
|
previousStatus - DesignStatus
|
|
primarySource - PrimarySource
|
|
procurement - ProcurementType
|
|
releasesCount - Int
|
|
restoreVariantGroup - VariantGroup
|
|
revisionHistory - [ComponentRevision]
|
|
revisionManaged - Boolean
|
|
revisionType - RevisionType
|
|
revisionValue - String
|
Revision string value |
rolledUpCost - RolledUpCost
|
|
rolledUpCostAsPrimary - Boolean
|
|
specs - [ComponentSpec]
|
|
status - DesignStatus
|
|
subRevisions - [ComponentRevision]
|
|
unitOfMeasure - ComponentUnitMeasure
|
|
variantGroup - VariantGroup
|
|
vendorId - String
|
|
vendorInfo - ComponentVendorInfo
|
|
workflowState - String
|
|
Example
{
"alias": "CMP",
"archived": false,
"assemblyParents": [Component],
"category": "abc123",
"changeOrder": ChangeOrder,
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "abc123",
"documents": [DocumentLink],
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"id": 4,
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": true,
"integrationFields": [Integrations],
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "abc123",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": true,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"notes": "xyz789",
"parent": Component,
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 987,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": true,
"revisionType": "CHANGE_ORDER",
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpec],
"status": "DESIGN",
"subRevisions": [ComponentRevision],
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "xyz789",
"vendorInfo": ComponentVendorInfo,
"workflowState": "abc123"
}
ComponentSpec
ComponentSpecInput
ComponentSpecs
ComponentUnitMeasure
Description
Component unit of measure
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AR"
ComponentVariantContainer
ComponentVendor
Description
Component vendor
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALTIUM"
ComponentVendorInfo
Fields
| Field Name | Description |
|---|---|
currentVendors - [ComponentVendor]
|
|
isLinked - Boolean
|
|
originalVendor - ComponentVendor
|
|
previousVendors - [ComponentVendor]
|
Example
{
"currentVendors": ["ALTIUM"],
"isLinked": true,
"originalVendor": "ALTIUM",
"previousVendors": ["ALTIUM"]
}
ComponentVendorInfoInput
Fields
| Input Field | Description |
|---|---|
currentVendors - [ComponentVendor]
|
|
isLinked - Boolean
|
|
originalVendor - ComponentVendor
|
|
previousVendors - [ComponentVendor]
|
Example
{
"currentVendors": ["ALTIUM"],
"isLinked": false,
"originalVendor": "ALTIUM",
"previousVendors": ["ALTIUM"]
}
Components
Fields
| Field Name | Description |
|---|---|
connection - ComponentConnection
|
|
Arguments
|
|
Example
{"connection": ComponentConnection}
ComponentsOrderByInput
Fields
| Input Field | Description |
|---|---|
category - SortDirection
|
|
created - SortDirection
|
|
description - SortDirection
|
|
eid - SortDirection
|
|
lastModified - SortDirection
|
|
legacyCpn - SortDirection
|
|
mass - SortDirection
|
|
name - SortDirection
|
|
revisionValue - SortDirection
|
|
status - SortDirection
|
Example
{
"category": "asc",
"created": "asc",
"description": "asc",
"eid": "asc",
"lastModified": "asc",
"legacyCpn": "asc",
"mass": "asc",
"name": "asc",
"revisionValue": "asc",
"status": "asc"
}
Configurations
Cpn
Example
{
"archived": false,
"company": Company,
"component": Component,
"counter": "abc123",
"created": "2007-12-03T10:15:30Z",
"creator": User,
"displayValue": "xyz789",
"id": 4,
"legacyCpn": "abc123",
"library": Library,
"prefix": "xyz789",
"suffix": "xyz789",
"type": "CMP",
"variant": "abc123"
}
CpnInput
CpnRules
Fields
| Field Name | Description |
|---|---|
base - CpnRulesFields
|
|
component - CpnRulesFields
|
|
product - CpnRulesFields
|
Example
{
"base": CpnRulesFields,
"component": CpnRulesFields,
"product": CpnRulesFields
}
CpnRulesFields
Fields
| Field Name | Description |
|---|---|
copyToEid - Boolean
|
|
counterDelimiter - String
|
|
counterLength - Int
|
|
counterPassThru - Boolean
|
|
counterStart - String
|
|
familyCounterDelimiter - String
|
|
familyCounterLength - Int
|
|
familyCounterStart - String
|
|
forceVariant - Boolean
|
|
hideVariantStart - Boolean
|
|
prefix - String
|
|
prefixDelimiter - String
|
|
prefixLength - Int
|
|
tempCounterLength - Int
|
|
tempPrefix - String
|
|
useCategoryPrefix - Boolean
|
|
variantLength - Int
|
|
variantStart - String
|
Example
{
"copyToEid": true,
"counterDelimiter": "abc123",
"counterLength": 123,
"counterPassThru": true,
"counterStart": "xyz789",
"familyCounterDelimiter": "abc123",
"familyCounterLength": 987,
"familyCounterStart": "abc123",
"forceVariant": false,
"hideVariantStart": true,
"prefix": "xyz789",
"prefixDelimiter": "abc123",
"prefixLength": 987,
"tempCounterLength": 123,
"tempPrefix": "abc123",
"useCategoryPrefix": true,
"variantLength": 123,
"variantStart": "xyz789"
}
CpnType
Description
CPN type (component, product, change order)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CMP"
CreateChangeOrderInput
Fields
| Input Field | Description |
|---|---|
approvalType - EcoDefaultApproval
|
|
approverIds - [ID]
|
|
archived - Boolean
|
|
coExternalNotifyUserEmails - [String]
|
|
coInternalNotifyUserIds - [ID]
|
|
componentIds - [ID]
|
|
description - String
|
|
documentLinks - [DocumentLinkInput]
|
|
erpOptions - ChangeOrderErpOptionsInput
|
|
isParentInclude - Boolean
|
|
name - String!
|
|
productIds - [ID]
|
|
type - ChangeOrderType
|
Example
{
"approvalType": "FIRST_IN",
"approverIds": ["4"],
"archived": false,
"coExternalNotifyUserEmails": ["xyz789"],
"coInternalNotifyUserIds": ["4"],
"componentIds": [4],
"description": "xyz789",
"documentLinks": [DocumentLinkInput],
"erpOptions": ChangeOrderErpOptionsInput,
"isParentInclude": false,
"name": "xyz789",
"productIds": [4],
"type": "DCO"
}
CreateComponentInput
Fields
| Input Field | Description |
|---|---|
archived - Boolean
|
|
category - String
|
|
children - [AssemblyChildInput]
|
|
cpn - CpnInput
|
|
customSpecs - [CustomSpecInput]
|
|
description - String
|
|
documentLinks - [DocumentLinkInput]
|
|
eid - String
|
|
imageIds - [ID]
|
|
libraryId - ID
|
|
manufacturers - [ManufacturerInput]
|
|
mass - Float
|
|
mode - EnvironmentMode
|
|
name - String!
|
|
procurement - ProcurementType
|
|
revisionManaged - Boolean
|
|
revisionValue - String
|
|
rolledUpCost - RolledUpCostInput
|
|
rolledUpCostAsPrimary - Boolean
|
|
specs - [ComponentSpecInput]
|
|
status - DesignStatus
|
|
suffix - String
|
|
unitOfMeasure - ComponentUnitMeasure
|
|
variantRootId - ID
|
The root component that this is a variant of. |
vendorId - String
|
|
vendorInfo - ComponentVendorInfoInput
|
Example
{
"archived": false,
"category": "abc123",
"children": [AssemblyChildInput],
"cpn": CpnInput,
"customSpecs": [CustomSpecInput],
"description": "abc123",
"documentLinks": [DocumentLinkInput],
"eid": "xyz789",
"imageIds": [4],
"libraryId": 4,
"manufacturers": [ManufacturerInput],
"mass": 123.45,
"mode": "DUMMY",
"name": "abc123",
"procurement": "BUY",
"revisionManaged": true,
"revisionValue": "abc123",
"rolledUpCost": RolledUpCostInput,
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpecInput],
"status": "DESIGN",
"suffix": "xyz789",
"unitOfMeasure": "AR",
"variantRootId": 4,
"vendorId": "abc123",
"vendorInfo": ComponentVendorInfoInput
}
CreateDocumentInput
Fields
| Input Field | Description |
|---|---|
file - Upload
|
|
mime - String!
|
|
mode - EnvironmentMode
|
|
name - String!
|
|
regenerateDocumentRequest - String
|
|
src - String
|
|
translationId - String
|
|
type - DocumentType!
|
|
vendor - ComponentVendor
|
|
visibility - Boolean
|
Example
{
"file": Upload,
"mime": "xyz789",
"mode": "DUMMY",
"name": "abc123",
"regenerateDocumentRequest": "xyz789",
"src": "xyz789",
"translationId": "abc123",
"type": "ACCEPTANCE_DATA",
"vendor": "ALTIUM",
"visibility": false
}
CreateProductInput
Fields
| Input Field | Description |
|---|---|
archived - Boolean
|
|
categories - [String]
|
|
children - [AssemblyChildInput]
|
|
cpn - CpnInput
|
|
customSpecs - [CustomSpecInput]
|
|
description - String
|
|
documentLinks - [DocumentLinkInput]
|
|
effectivity - EffectivityInput
|
|
eid - String
|
|
forecasts - [ForecastInput]
|
|
imageIds - [ID]
|
|
libraryId - ID
|
|
manufacturers - [ManufacturerInput]
|
|
mass - Float
|
|
mode - EnvironmentMode
|
|
name - String!
|
|
primarySource - PrimarySourceInput!
|
|
procurement - ProcurementType
|
|
revisionValue - String
|
|
rolledUpCost - RolledUpCostInput
|
|
rolledUpCostAsPrimary - Boolean
|
|
status - DesignStatus
|
|
team - ProductTeamsInput!
|
|
variantRootId - ID
|
Example
{
"archived": false,
"categories": ["xyz789"],
"children": [AssemblyChildInput],
"cpn": CpnInput,
"customSpecs": [CustomSpecInput],
"description": "xyz789",
"documentLinks": [DocumentLinkInput],
"effectivity": EffectivityInput,
"eid": "xyz789",
"forecasts": [ForecastInput],
"imageIds": ["4"],
"libraryId": "4",
"manufacturers": [ManufacturerInput],
"mass": 987.65,
"mode": "DUMMY",
"name": "xyz789",
"primarySource": PrimarySourceInput,
"procurement": "BUY",
"revisionValue": "abc123",
"rolledUpCost": RolledUpCostInput,
"rolledUpCostAsPrimary": false,
"status": "DESIGN",
"team": ProductTeamsInput,
"variantRootId": 4
}
CreateWebhookInput
Example
{
"description": "abc123",
"eventTypes": ["CMP_CREATED"],
"includeComponentProductData": true,
"mode": "abc123",
"status": "xyz789",
"webhookUrl": "xyz789"
}
Currency
Description
Currency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUD"
CustomFields
CustomSpec
CustomSpecInput
Datasheet
Fields
| Field Name | Description |
|---|---|
src - String!
|
Example
{"src": "abc123"}
DatasheetInput
Fields
| Input Field | Description |
|---|---|
src - String!
|
Example
{"src": "xyz789"}
DateTime
Description
DateTime type serialized as Unix time
Example
"2007-12-03T10:15:30Z"
DeleteInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteWebhookByUrlInput
Fields
| Input Field | Description |
|---|---|
webhookUrl - String!
|
Example
{"webhookUrl": "abc123"}
DesignStatus
Description
Status of component/product
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DESIGN"
Distributor
DistributorInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
dpn - UrlKeyInput!
|
|
name - String!
|
|
package - PackageInput!
|
|
quotes - [QuoteInput]
|
Example
{
"description": "xyz789",
"dpn": UrlKeyInput,
"name": "xyz789",
"package": PackageInput,
"quotes": [QuoteInput]
}
Document
Fields
| Field Name | Description |
|---|---|
archived - Boolean
|
|
company - Company
|
|
created - DateTime
|
|
creator - User
|
|
id - ID
|
|
library - Library
|
|
mime - String
|
|
mode - EnvironmentMode
|
|
name - String
|
|
regenerateDocumentRequest - String
|
|
size - Int
|
|
src - String
|
|
status - DocumentStatus
|
|
translationId - String
|
|
url - String
|
|
vendor - ComponentVendor
|
|
visibility - Boolean
|
Example
{
"archived": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": "4",
"library": Library,
"mime": "abc123",
"mode": "DUMMY",
"name": "xyz789",
"regenerateDocumentRequest": "abc123",
"size": 123,
"src": "xyz789",
"status": "COMPLETED",
"translationId": "abc123",
"url": "xyz789",
"vendor": "ALTIUM",
"visibility": false
}
DocumentLink
Fields
| Field Name | Description |
|---|---|
document - Document
|
|
specs - DocumentSpec
|
Example
{
"document": Document,
"specs": DocumentSpec
}
DocumentLinkInput
Fields
| Input Field | Description |
|---|---|
documentId - ID
|
|
specs - DocumentSpecInput
|
Example
{"documentId": 4, "specs": DocumentSpecInput}
DocumentSpec
Fields
| Field Name | Description |
|---|---|
lastModified - DateTime
|
|
revision - String
|
|
status - DesignStatus
|
|
type - DocumentType
|
Example
{
"lastModified": "2007-12-03T10:15:30Z",
"revision": "xyz789",
"status": "DESIGN",
"type": "ACCEPTANCE_DATA"
}
DocumentSpecInput
Fields
| Input Field | Description |
|---|---|
revision - String
|
|
status - DesignStatus
|
|
type - DocumentType
|
Example
{
"revision": "abc123",
"status": "DESIGN",
"type": "ACCEPTANCE_DATA"
}
DocumentStatus
Description
Document status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
DocumentType
Description
Document type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTANCE_DATA"
DummyProductType
Description
Test products
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRONE"
EcoDefaultApproval
Description
ECO default approval type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FIRST_IN"
Effectivity
EffectivityInput
EnvironmentMode
Description
Mode / Environment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DUMMY"
ErpItemType
Description
ERP item type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LOT_TRACKED"
Family
Favorite
Fields
| Field Name | Description |
|---|---|
components - [Component]
|
|
products - [Product]
|
Example
{
"components": [Component],
"products": [Product]
}
FlattenedBom
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
Forecast
ForecastInput
Group
Description
Type of library
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENGINEERING"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
Image
Example
{
"archived": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": 4,
"key": "abc123",
"library": Library,
"mime": "GIF",
"mode": "DUMMY",
"name": "xyz789",
"size": 123,
"src": "xyz789",
"variants": ImageVariants
}
ImageVariants
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
Integrations
Fields
| Field Name | Description |
|---|---|
altium - AltiumInfo
|
Example
{"altium": AltiumInfo}
Invite
JSON
Description
Unstructured JSON
Example
{}
LeadTimeInput
Fields
| Input Field | Description |
|---|---|
units - LeadTimeUnits!
|
|
value - Int!
|
Example
{"units": "DAY", "value": 123}
LeadTimeUnits
Description
Lead time units
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DAY"
Libraries
Fields
| Field Name | Description |
|---|---|
connection - LibraryConnection
|
|
Arguments
|
|
Example
{"connection": LibraryConnection}
LibrariesOrderByInput
Fields
| Input Field | Description |
|---|---|
created - SortDirection
|
|
description - SortDirection
|
|
lastModified - SortDirection
|
|
name - SortDirection
|
|
systemGenerated - SortDirection
|
|
type - SortDirection
|
Example
{
"created": "asc",
"description": "asc",
"lastModified": "asc",
"name": "asc",
"systemGenerated": "asc",
"type": "asc"
}
Library
Example
{
"archived": true,
"company": Company,
"cpnRules": CpnRules,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customTileTitle": "abc123",
"description": "abc123",
"id": "4",
"lastModified": "2007-12-03T10:15:30Z",
"name": "xyz789",
"status": "abc123",
"systemGenerated": true,
"type": "GENERAL",
"users": [User]
}
LibraryConnection
Fields
| Field Name | Description |
|---|---|
edges - [LibraryEdge]
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types |
pageInfo - PageInfo!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo |
totalCount - Int
|
Example
{
"edges": [LibraryEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
LibraryEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor |
node - Library
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Node |
Example
{
"cursor": "xyz789",
"node": Library
}
LibraryType
Description
Type of library
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GENERAL"
LoginTime
MIME
Description
MIME type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"GIF"
Manufacturer
Fields
| Field Name | Description |
|---|---|
datasheet - Datasheet
|
|
description - String
|
|
distributors - [Distributor]
|
|
leadTimeDays - Int
|
|
mpn - UrlKey
|
|
name - String
|
|
status - ManufacturerStatus
|
|
warrantyMonths - Int
|
Example
{
"datasheet": Datasheet,
"description": "xyz789",
"distributors": [Distributor],
"leadTimeDays": 123,
"mpn": UrlKey,
"name": "xyz789",
"status": "DESIGN",
"warrantyMonths": 123
}
ManufacturerInput
Fields
| Input Field | Description |
|---|---|
datasheet - DatasheetInput!
|
|
description - String!
|
|
distributors - [DistributorInput]
|
|
leadTime - LeadTimeInput!
|
|
mpn - UrlKeyInput!
|
|
name - String!
|
|
status - ManufacturerStatus
|
|
warranty - WarrantyInput!
|
Example
{
"datasheet": DatasheetInput,
"description": "xyz789",
"distributors": [DistributorInput],
"leadTime": LeadTimeInput,
"mpn": UrlKeyInput,
"name": "xyz789",
"status": "DESIGN",
"warranty": WarrantyInput
}
ManufacturerStatus
Description
Manufacturer status
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DESIGN"
MassStatus
Description
Product mass status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSEMBLY"
MassUnitType
Description
Mass Units
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GRAMS"
ModelType
Description
Model type (changeOrder, component, product)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CMP"
OnShapeKeys
Onboarding
Fields
| Field Name | Description |
|---|---|
companyLibraryNotification - Boolean
|
|
completedSteps - [String]
|
|
currentStep - String
|
|
displaySampleProduct - Boolean
|
|
dummyProductType - DummyProductType
|
|
onBoardingNotification - Boolean
|
|
personalLibraryNotification - Boolean
|
|
quickStartGuideNotification - Boolean
|
|
status - OnboardingStatus
|
Example
{
"companyLibraryNotification": false,
"completedSteps": ["xyz789"],
"currentStep": "xyz789",
"displaySampleProduct": true,
"dummyProductType": "DRONE",
"onBoardingNotification": true,
"personalLibraryNotification": true,
"quickStartGuideNotification": false,
"status": "COMPLETED"
}
OnboardingStatus
Description
Onboarding Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPLETED"
Package
Fields
| Field Name | Description |
|---|---|
quantity - Int
|
|
type - PackageType
|
Example
{"quantity": 987, "type": "AMMO_PACK"}
PackageInput
Fields
| Input Field | Description |
|---|---|
quantity - Int!
|
|
type - PackageType!
|
Example
{"quantity": 987, "type": "AMMO_PACK"}
PackageType
Description
Package Type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMMO_PACK"
PageInfo
Description
PageInfo cursor, as defined in https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
The cursor corresponding to the last nodes in edges. Null if the connection is empty. |
hasNextPage - Boolean!
|
Used to indicate whether more edges exist following the set defined by the clients arguments. |
hasPreviousPage - Boolean!
|
Used to indicate whether more edges exist prior to the set defined by the clients arguments. |
startCursor - String
|
The cursor corresponding to the first nodes in edges. Null if the connection is empty. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
PaidSubscription
Example
{
"active": false,
"created": "2007-12-03T10:15:30Z",
"duration": "xyz789",
"maxRoUsers": 987,
"maxUsers": 123,
"package": "xyz789",
"paidDate": "2007-12-03T10:15:30Z"
}
Preferences
Fields
| Field Name | Description |
|---|---|
favorite - Favorite
|
Example
{"favorite": Favorite}
PrimarySource
Example
{
"distributor": "abc123",
"dpn": "xyz789",
"extendedCost": 987.65,
"leadTimeDays": 123,
"manufacturer": "xyz789",
"minQuantity": 987.65,
"mpn": "xyz789",
"unitPrice": 987.65
}
PrimarySourceInput
Example
{
"distributor": "abc123",
"dpn": "abc123",
"extendedCost": 123.45,
"leadTimeDays": 987,
"manufacturer": "xyz789",
"minQuantity": 123.45,
"mpn": "xyz789",
"unitPrice": 123.45
}
ProcurementType
Description
Procurement type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BUY"
Product
Fields
| Field Name | Description |
|---|---|
alias - ModelType
|
|
archived - Boolean
|
|
categories - [String]
|
|
changeOrders - [ChangeOrder]
|
|
Arguments
|
|
children - [AssemblyChild]
|
|
company - Company
|
|
cpn - Cpn
|
|
created - DateTime
|
|
creator - User
|
|
customSpecs - [CustomSpec]
|
|
description - String
|
|
documentLinks - [DocumentLink]
|
|
effectivity - Effectivity
|
|
eid - String
|
|
flattenedBom - [FlattenedBom]
|
|
forecasts - [Forecast]
|
|
id - ID
|
|
imageIds - [String!]
|
|
images - [Image]
|
|
incompleteCost - Boolean
|
|
lastModified - DateTime
|
|
lastReleaseRevision - ProductRevision
|
|
legacyCpn - String
|
To be deprecated |
legacyCpnVariant - String
|
To be deprecated |
legacyNextRevision - String
|
To be deprecated |
library - Library
|
|
manufacturers - [Manufacturer]
|
|
mass - Float
|
|
massStatus - MassStatus
|
|
mode - String
|
|
modified - Boolean
|
|
name - String
|
|
nextRevisionValue - String
|
Dynamically calculated next revisionValue |
Arguments
|
|
previousRevisionValue - String
|
|
previousStatus - DesignStatus
|
|
primarySource - PrimarySource
|
|
procurement - String
|
|
revisionHistory - [ProductRevision]
|
|
revisionValue - String
|
Revision string value |
rolledUpCost - RolledUpCost
|
|
rolledUpCostAsPrimary - Boolean
|
|
status - DesignStatus
|
|
team - ProductTeam!
|
|
variantGroup - VariantGroup
|
|
Example
{
"alias": "CMP",
"archived": false,
"categories": ["abc123"],
"changeOrders": [ChangeOrder],
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"effectivity": Effectivity,
"eid": "abc123",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": 4,
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": true,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "abc123",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "xyz789",
"modified": true,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "abc123",
"revisionHistory": [ProductRevision],
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": true,
"status": "DESIGN",
"team": ProductTeam,
"variantGroup": VariantGroup
}
ProductConnection
Fields
| Field Name | Description |
|---|---|
edges - [ProductEdge]
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types |
pageInfo - PageInfo!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo |
totalCount - Int
|
Example
{
"edges": [ProductEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ProductEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor |
node - Product
|
https://facebook.github.io/relay/graphql/connections.htm#sec-Node |
Example
{
"cursor": "xyz789",
"node": Product
}
ProductRevision
Fields
| Field Name | Description |
|---|---|
alias - ModelType
|
|
archived - Boolean
|
|
categories - [String]
|
|
changeOrder - ChangeOrder
|
|
children - [AssemblyChild]
|
|
company - Company
|
|
cpn - Cpn
|
|
created - DateTime
|
|
creator - User
|
|
customSpecs - [CustomSpec]
|
|
description - String
|
|
documentLinks - [DocumentLink]
|
|
effectivity - Effectivity
|
|
eid - String
|
|
flattenedBom - [FlattenedBom]
|
|
forecasts - [Forecast]
|
|
id - ID
|
|
imageIds - [String!]
|
|
images - [Image]
|
|
incompleteCost - Boolean
|
|
lastModified - DateTime
|
|
lastReleaseRevision - ProductRevision
|
|
lastRevision - String
|
|
lastStatus - String
|
|
legacyCpn - String
|
To be deprecated |
legacyCpnVariant - String
|
To be deprecated |
legacyNextRevision - String
|
To be deprecated |
library - Library
|
|
manufacturers - [Manufacturer]
|
|
mass - Float
|
|
massStatus - MassStatus
|
|
mode - String
|
|
modified - Boolean
|
|
name - String
|
|
nextRevisionValue - String
|
Dynamically calculated next revisionValue |
Arguments
|
|
notes - String
|
|
parent - Product
|
|
previousRevisionValue - String
|
|
previousStatus - DesignStatus
|
|
primarySource - PrimarySource
|
|
procurement - String
|
|
revisionHistory - ProductRevision
|
|
revisionType - RevisionType
|
|
revisionValue - String
|
Revision string value |
rolledUpCost - RolledUpCost
|
|
rolledUpCostAsPrimary - Boolean
|
|
status - DesignStatus
|
|
subRevisions - [ProductRevision]
|
|
team - ProductTeam
|
|
variantGroup - VariantGroup
|
|
Example
{
"alias": "CMP",
"archived": false,
"categories": ["abc123"],
"changeOrder": ChangeOrder,
"children": [AssemblyChild],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "abc123",
"documentLinks": [DocumentLink],
"effectivity": Effectivity,
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": "4",
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": true,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"lastRevision": "xyz789",
"lastStatus": "abc123",
"legacyCpn": "xyz789",
"legacyCpnVariant": "abc123",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "xyz789",
"modified": true,
"name": "abc123",
"nextRevisionValue": "abc123",
"notes": "xyz789",
"parent": Product,
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "abc123",
"revisionHistory": ProductRevision,
"revisionType": "CHANGE_ORDER",
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": true,
"status": "DESIGN",
"subRevisions": [ProductRevision],
"team": ProductTeam,
"variantGroup": VariantGroup
}
ProductTeam
Fields
| Field Name | Description |
|---|---|
engineering - TeamStruct
|
|
manufacturing - TeamStruct
|
|
procurement - TeamStruct
|
|
productManager - TeamStruct
|
|
qa - TeamStruct
|
Example
{
"engineering": TeamStruct,
"manufacturing": TeamStruct,
"procurement": TeamStruct,
"productManager": TeamStruct,
"qa": TeamStruct
}
ProductTeamsInput
Fields
| Input Field | Description |
|---|---|
engineering - TeamStructInput!
|
|
manufacturing - TeamStructInput!
|
|
procurement - TeamStructInput!
|
|
productManager - TeamStructInput!
|
|
qa - TeamStructInput!
|
Example
{
"engineering": TeamStructInput,
"manufacturing": TeamStructInput,
"procurement": TeamStructInput,
"productManager": TeamStructInput,
"qa": TeamStructInput
}
Products
Fields
| Field Name | Description |
|---|---|
connection - ProductConnection
|
|
Arguments
|
|
Example
{"connection": ProductConnection}
ProductsOrderByInput
Fields
| Input Field | Description |
|---|---|
created - SortDirection
|
|
description - SortDirection
|
|
eid - SortDirection
|
|
lastModified - SortDirection
|
|
legacyCpn - SortDirection
|
|
mass - SortDirection
|
|
name - SortDirection
|
|
revSchemeType - SortDirection
|
|
revisionValue - SortDirection
|
|
status - SortDirection
|
|
website - SortDirection
|
Example
{
"created": "asc",
"description": "asc",
"eid": "asc",
"lastModified": "asc",
"legacyCpn": "asc",
"mass": "asc",
"name": "asc",
"revSchemeType": "asc",
"revisionValue": "asc",
"status": "asc",
"website": "asc"
}
Quote
QuoteInput
Fields
| Input Field | Description |
|---|---|
isPrimary - Boolean
|
|
leadTime - LeadTimeInput!
|
|
maxQuantity - Float
|
|
minQuantity - Float
|
|
unitPrice - Float
|
Example
{
"isPrimary": true,
"leadTime": LeadTimeInput,
"maxQuantity": 987.65,
"minQuantity": 987.65,
"unitPrice": 123.45
}
RememberUserDevice
RevisionScheme
Description
Revision scheme
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALPHA_BETA_AB"
RevisionSection
Description
Revision section
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DOCUMENT"
RevisionType
Description
Revision type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHANGE_ORDER"
Role
Description
Type of Role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADMINISTRATOR"
RolledUpCost
RolledUpCostInput
SearchFields
Fields
| Input Field | Description |
|---|---|
catGroup - String
|
|
catGroupList - [String!]
|
|
category - String
|
|
categoryList - [String!]
|
|
cpn - String
|
|
cpnList - [String!]
|
|
customSpecs - String
|
|
customSpecsList - [String!]
|
|
customSpecsValueList - [ComponentSpecs!]
|
|
description - String
|
|
descriptionList - [String!]
|
|
dist_desc - String
|
|
dist_desc_list - [String!]
|
|
distributor - String
|
|
distributorList - [String!]
|
|
dpn - String
|
|
dpnList - [String!]
|
|
eid - String
|
|
eidList - [String!]
|
|
family - String
|
|
familyList - [String!]
|
|
favorite - Boolean
|
|
favoriteList - [Boolean!]
|
|
global - String
|
|
globalList - [String!]
|
|
manufacturer - String
|
|
manufacturerList - [String!]
|
|
mfr_desc - String
|
|
mfr_desc_list - [String!]
|
|
modified - Boolean
|
|
modifiedList - [Boolean!]
|
|
mpn - String
|
|
mpnList - [String!]
|
|
name - String
|
|
nameList - [String!]
|
|
procurement - String
|
|
procurementList - [String!]
|
|
revisionValue - String
|
|
revisionValueList - [String!]
|
|
specValueList - [ComponentSpecs!]
|
|
specs - String
|
|
specsList - [String!]
|
|
status - String
|
|
statusList - [String!]
|
|
vendor - String
|
|
vendorList - [String!]
|
Example
{
"catGroup": "abc123",
"catGroupList": ["abc123"],
"category": "xyz789",
"categoryList": ["xyz789"],
"cpn": "xyz789",
"cpnList": ["xyz789"],
"customSpecs": "abc123",
"customSpecsList": ["xyz789"],
"customSpecsValueList": [ComponentSpecs],
"description": "xyz789",
"descriptionList": ["xyz789"],
"dist_desc": "abc123",
"dist_desc_list": ["xyz789"],
"distributor": "xyz789",
"distributorList": ["xyz789"],
"dpn": "abc123",
"dpnList": ["xyz789"],
"eid": "abc123",
"eidList": ["abc123"],
"family": "xyz789",
"familyList": ["abc123"],
"favorite": false,
"favoriteList": [false],
"global": "abc123",
"globalList": ["abc123"],
"manufacturer": "xyz789",
"manufacturerList": ["xyz789"],
"mfr_desc": "xyz789",
"mfr_desc_list": ["xyz789"],
"modified": false,
"modifiedList": [false],
"mpn": "xyz789",
"mpnList": ["abc123"],
"name": "abc123",
"nameList": ["abc123"],
"procurement": "abc123",
"procurementList": ["abc123"],
"revisionValue": "abc123",
"revisionValueList": ["abc123"],
"specValueList": [ComponentSpecs],
"specs": "abc123",
"specsList": ["xyz789"],
"status": "xyz789",
"statusList": ["xyz789"],
"vendor": "xyz789",
"vendorList": ["xyz789"]
}
SolidworksAnalytics
Example
{
"addInVersion": "abc123",
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": "4",
"osVersion": "abc123",
"swxVersion": "xyz789"
}
SortDirection
Description
Sort direction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"asc"
Spec
Fields
| Field Name | Description |
|---|---|
allowedValues - [String]
|
Values for multi-select. Use with isDropDown |
company - Company
|
|
defaultValue - String
|
|
id - ID
|
|
isDropDown - Boolean
|
Indicates multi-value select. Use with allowedValues |
isPcb - Boolean
|
Only applies within categories |
isRequired - Boolean
|
Only applies within categories |
name - String
|
|
type - SpecType
|
Example
{
"allowedValues": ["abc123"],
"company": Company,
"defaultValue": "xyz789",
"id": 4,
"isDropDown": true,
"isPcb": false,
"isRequired": false,
"name": "abc123",
"type": "CMP"
}
SpecType
Description
Spec type (component, product)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CMP"
Status
Description
Type of Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DISABLED"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
Subdomain
Fields
| Field Name | Description |
|---|---|
forwardTo - String
|
Example
{"forwardTo": "xyz789"}
TeamStruct
TeamStructInput
UpdateChangeOrderInput
Fields
| Input Field | Description |
|---|---|
description - String
|
|
erpOptions - ChangeOrderErpOptionsInput
|
|
id - ID!
|
|
name - String
|
Example
{
"description": "abc123",
"erpOptions": ChangeOrderErpOptionsInput,
"id": 4,
"name": "xyz789"
}
UpdateComponentInput
Fields
| Input Field | Description |
|---|---|
archived - Boolean
|
|
category - String
|
|
children - [AssemblyChildInput]
|
|
cpn - CpnInput
|
|
customSpecs - [CustomSpecInput]
|
|
description - String
|
|
documentLinks - [DocumentLinkInput]
|
|
eid - String
|
|
id - ID
|
|
imageIds - [ID]
|
|
libraryId - ID
|
|
manufacturers - [ManufacturerInput]
|
|
mass - Float
|
|
mode - EnvironmentMode
|
|
name - String
|
Name may be used either as a lookup field or to update name |
overrideDesignStatus - Boolean
|
Override design status check for revision creation. This is not a data field. |
procurement - ProcurementType
|
|
revert - Boolean
|
Signals reverting to previous revision. This is not a data field. |
revisionManaged - Boolean
|
|
revisionValue - String
|
|
section - RevisionSection
|
Revision to increment. This is not a data field. Default = MAJOR |
skipRevision - Boolean
|
Skip revision & variant. To be deprecated. |
specs - [ComponentSpecInput]
|
|
status - DesignStatus
|
|
suffix - String
|
|
unitOfMeasure - ComponentUnitMeasure
|
|
variantRootId - ID
|
ID of component that this should be a variant of. To unlink variant, pass in null |
vendorId - String
|
|
vendorInfo - ComponentVendorInfoInput
|
Example
{
"archived": true,
"category": "abc123",
"children": [AssemblyChildInput],
"cpn": CpnInput,
"customSpecs": [CustomSpecInput],
"description": "xyz789",
"documentLinks": [DocumentLinkInput],
"eid": "abc123",
"id": 4,
"imageIds": ["4"],
"libraryId": 4,
"manufacturers": [ManufacturerInput],
"mass": 123.45,
"mode": "DUMMY",
"name": "xyz789",
"overrideDesignStatus": true,
"procurement": "BUY",
"revert": false,
"revisionManaged": false,
"revisionValue": "xyz789",
"section": "DOCUMENT",
"skipRevision": true,
"specs": [ComponentSpecInput],
"status": "DESIGN",
"suffix": "xyz789",
"unitOfMeasure": "AR",
"variantRootId": "4",
"vendorId": "xyz789",
"vendorInfo": ComponentVendorInfoInput
}
UpdateProductInput
Fields
| Input Field | Description |
|---|---|
archived - Boolean
|
|
categories - [String]
|
|
children - [AssemblyChildInput]
|
|
cpn - CpnInput
|
|
customSpecs - [CustomSpecInput]
|
|
description - String
|
|
documentLinks - [DocumentLinkInput]
|
|
eid - String
|
|
forecasts - [ForecastInput]
|
|
id - ID
|
|
imageIds - [ID]
|
|
libraryId - ID
|
|
manufacturers - [ManufacturerInput]
|
|
mass - Float
|
|
mode - EnvironmentMode
|
|
name - String
|
Name may be used either as a lookup field or to update name |
overrideDesignStatus - Boolean
|
Override design status check for revision creation. This is not a data field. |
primarySource - PrimarySourceInput
|
|
procurement - ProcurementType
|
|
revert - Boolean
|
Signals reverting to previous revision. This is not a data field. |
revisionValue - String
|
|
rolledUpCost - RolledUpCostInput
|
|
rolledUpCostAsPrimary - Boolean
|
|
section - RevisionSection
|
Revision to increment. This is not a data field. Default = MAJOR |
skipRevision - Boolean
|
Skip revision & variant. To be deprecated. |
status - DesignStatus
|
|
team - ProductTeamsInput
|
|
variantRootId - ID
|
ID of product that this should be a variant of. To unlink variant, pass in null |
Example
{
"archived": true,
"categories": ["xyz789"],
"children": [AssemblyChildInput],
"cpn": CpnInput,
"customSpecs": [CustomSpecInput],
"description": "abc123",
"documentLinks": [DocumentLinkInput],
"eid": "abc123",
"forecasts": [ForecastInput],
"id": "4",
"imageIds": [4],
"libraryId": 4,
"manufacturers": [ManufacturerInput],
"mass": 987.65,
"mode": "DUMMY",
"name": "xyz789",
"overrideDesignStatus": true,
"primarySource": PrimarySourceInput,
"procurement": "BUY",
"revert": false,
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCostInput,
"rolledUpCostAsPrimary": true,
"section": "DOCUMENT",
"skipRevision": true,
"status": "DESIGN",
"team": ProductTeamsInput,
"variantRootId": "4"
}
Upload
Description
The Upload scalar type represents a file upload.
Example
Upload
UrlKey
UrlKeyInput
User
Fields
| Field Name | Description |
|---|---|
activeLibrary - Library
|
|
archived - Boolean
|
|
avatar - Image
|
|
created - DateTime
|
|
email - String
|
|
firstName - String
|
|
groups - [Group]
|
|
id - ID
|
|
integrations - JSON
|
|
invite - Invite
|
|
isSetupCompleted - Boolean
|
|
lastDayActiveAt - DateTime
|
|
lastLogin - DateTime
|
|
lastName - String
|
|
libraries - [Library]
|
|
logins - [LoginTime]
|
|
onShapeKeys - OnShapeKeys
|
|
onboarding - Onboarding
|
|
personalLibrary - Library
|
|
preferences - Preferences
|
|
primaryCompany - Company
|
|
rememberUserDevice - RememberUserDevice
|
|
role - Role
|
|
solidworksAnalytics - [SolidworksAnalytics]
|
|
status - Status
|
|
styles - String
|
|
timezoneOffset - Int
|
|
title - String
|
|
verified - Boolean
|
Example
{
"activeLibrary": Library,
"archived": false,
"avatar": Image,
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"firstName": "xyz789",
"groups": ["ENGINEERING"],
"id": 4,
"integrations": {},
"invite": Invite,
"isSetupCompleted": false,
"lastDayActiveAt": "2007-12-03T10:15:30Z",
"lastLogin": "2007-12-03T10:15:30Z",
"lastName": "abc123",
"libraries": [Library],
"logins": [LoginTime],
"onShapeKeys": OnShapeKeys,
"onboarding": Onboarding,
"personalLibrary": Library,
"preferences": Preferences,
"primaryCompany": Company,
"rememberUserDevice": RememberUserDevice,
"role": "ADMINISTRATOR",
"solidworksAnalytics": [SolidworksAnalytics],
"status": "DISABLED",
"styles": "xyz789",
"timezoneOffset": 123,
"title": "abc123",
"verified": false
}
VariantGroup
Fields
| Field Name | Description |
|---|---|
archived - Boolean
|
|
categoryName - String
|
Used by products to validate that all componentVariants belong to the same category. |
company - Company
|
|
componentVariants - [Component]
|
Variant group may contain either components or products, not both. |
id - ID
|
|
library - Library
|
|
productVariants - [Product]
|
Variant group may contain either components or products, not both. |
type - ModelType
|
Example
{
"archived": false,
"categoryName": "xyz789",
"company": Company,
"componentVariants": [Component],
"id": 4,
"library": Library,
"productVariants": [Product],
"type": "CMP"
}
WarrantyInput
Fields
| Input Field | Description |
|---|---|
units - WarrantyUnits!
|
|
value - Int!
|
Example
{"units": "MONTH", "value": 987}
WarrantyUnits
Description
Warranty in months
Values
| Enum Value | Description |
|---|---|
|
|
Example
"MONTH"
Webhook
Fields
| Field Name | Description |
|---|---|
archived - Boolean
|
|
company - Company
|
|
created - DateTime
|
|
creator - User
|
|
description - String
|
|
eventTypes - [WebhookEventTypes]
|
|
id - ID
|
|
includeComponentProductData - Boolean
|
|
lastModified - DateTime
|
|
mode - EnvironmentMode
|
|
signingSecret - String
|
|
status - String
|
|
webhookUrl - String!
|
Example
{
"archived": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "xyz789",
"eventTypes": ["CMP_CREATED"],
"id": "4",
"includeComponentProductData": false,
"lastModified": "2007-12-03T10:15:30Z",
"mode": "DUMMY",
"signingSecret": "xyz789",
"status": "abc123",
"webhookUrl": "abc123"
}
WebhookEventTypes
Description
Allowed event types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CMP_CREATED"