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": "abc123"}}}
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": "xyz789",
"unitOfMeasure": "AR"
}
]
}
}
changeOrderApprovalTemplates
Description
Fetch CO approval templates that are authored by the user or public in the company
Response
Returns [ChangeOrderApprovalTemplate]
Example
Query
query ChangeOrderApprovalTemplates {
changeOrderApprovalTemplates {
approvalType
approvers {
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
}
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
cpnType
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
}
externalUsers
id
isPublic
lastUsed
notifiers {
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
}
templateName
}
}
Response
{
"data": {
"changeOrderApprovalTemplates": [
{
"approvalType": "FIRST_IN",
"approvers": [User],
"archived": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"externalUsers": ["xyz789"],
"id": "4",
"isPublic": true,
"lastUsed": 987.65,
"notifiers": [User],
"templateName": "abc123"
}
]
}
}
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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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": [
"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": 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
}
cpnType
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],
"cpnType": "abc123",
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": 4,
"integrations": {},
"isEnabledCustomCategory": true,
"legacyCpnVariantScheme": "abc123",
"logo": Image,
"name": "abc123",
"onshapeRegisteredCompanies": [
"abc123"
],
"revisionScheme": "ALPHA_BETA_AB",
"settings": CompanySettings,
"specs": [Spec],
"subdomain": "xyz789",
"subscriptions": [PaidSubscription],
"users": [User],
"website": "abc123"
}
]
}
}
companyCategories
Response
Returns [Category]
Example
Query
query CompanyCategories(
$fetchAll: Boolean,
$id: ID
) {
companyCategories(
fetchAll: $fetchAll,
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
{"fetchAll": false, "id": 4}
Response
{
"data": {
"companyCategories": [
{
"archived": false,
"code": "abc123",
"customSpecs": [Spec],
"id": 4,
"isAllowedInPartAndAssembly": false,
"isDefaultCategory": true,
"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
}
cpnType
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
family
id
isFreeFormOverride
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": false,
"assemblyParents": [Component],
"category": "xyz789",
"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": false,
"integrationFields": [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": true,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"notes": "xyz789",
"parent": Component,
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 987,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": false,
"revisionType": "CHANGE_ORDER",
"revisionValue": "abc123",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpec],
"status": "DESIGN",
"subRevisions": [ComponentRevision],
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "abc123",
"vendorInfo": ComponentVendorInfo,
"workflowState": "xyz789"
}
]
}
}
componentTreeById
Response
Returns a ComponentWithLevel
Arguments
| Name | Description |
|---|---|
depth - Int
|
Default = null |
filter - ComponentTreeFilter
|
|
id - ID
|
Example
Query
query ComponentTreeById(
$depth: Int,
$filter: ComponentTreeFilter,
$id: ID
) {
componentTreeById(
depth: $depth,
filter: $filter,
id: $id
) {
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 {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...ComponentWithLevelFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
family
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
path
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
treeId
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
path
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
treeId
unitOfMeasure
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
vendorId
vendorInfo {
currentVendors
isLinked
originalVendor
previousVendors
}
workflowState
}
}
Variables
{"depth": null, "filter": "children", "id": 4}
Response
{
"data": {
"componentTreeById": {
"alias": "CMP",
"archived": false,
"assemblyParents": [Component],
"category": "xyz789",
"changeOrders": [ChangeOrder],
"children": [ComponentWithLevel],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"eid": "abc123",
"family": "xyz789",
"flattenedBom": [FlattenedBom],
"id": 4,
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": false,
"integrations": Integrations,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": true,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"path": ["abc123"],
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 123,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": false,
"revisionValue": "abc123",
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpec],
"status": "DESIGN",
"treeId": "xyz789",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "xyz789",
"vendorInfo": ComponentVendorInfo,
"workflowState": "xyz789"
}
}
}
componentTreeByIds
Response
Returns [ComponentWithLevel]
Arguments
| Name | Description |
|---|---|
depth - Int
|
Default = null |
filter - ComponentTreeFilter
|
|
ids - [ID]
|
Example
Query
query ComponentTreeByIds(
$depth: Int,
$filter: ComponentTreeFilter,
$ids: [ID]
) {
componentTreeByIds(
depth: $depth,
filter: $filter,
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 {
alias
archived
assemblyParents {
... on Component {
...ComponentFragment
}
... on Product {
...ProductFragment
}
}
category
changeOrders {
...ChangeOrderFragment
}
children {
...ComponentWithLevelFragment
}
company {
...CompanyFragment
}
cpn {
...CpnFragment
}
created
creator {
...UserFragment
}
customSpecs {
...CustomSpecFragment
}
description
documentLinks {
...DocumentLinkFragment
}
eid
family
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
path
previousRevisionValue
previousStatus
primarySource {
...PrimarySourceFragment
}
procurement
releasesCount
restoreVariantGroup {
...VariantGroupFragment
}
revisionHistory {
...ComponentRevisionFragment
}
revisionManaged
revisionValue
rolledUpCostAsPrimary
specs {
...ComponentSpecFragment
}
status
treeId
unitOfMeasure
variantGroup {
...VariantGroupFragment
}
vendorId
vendorInfo {
...ComponentVendorInfoFragment
}
workflowState
}
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
path
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
treeId
unitOfMeasure
variantGroup {
archived
categoryName
company {
...CompanyFragment
}
componentVariants {
...ComponentFragment
}
id
library {
...LibraryFragment
}
productVariants {
...ProductFragment
}
type
}
vendorId
vendorInfo {
currentVendors
isLinked
originalVendor
previousVendors
}
workflowState
}
}
Variables
{
"depth": null,
"filter": "children",
"ids": ["4"]
}
Response
{
"data": {
"componentTreeByIds": [
{
"alias": "CMP",
"archived": true,
"assemblyParents": [Component],
"category": "xyz789",
"changeOrders": [ChangeOrder],
"children": [ComponentWithLevel],
"company": Company,
"cpn": Cpn,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customSpecs": [CustomSpec],
"description": "xyz789",
"documentLinks": [DocumentLink],
"eid": "xyz789",
"family": "abc123",
"flattenedBom": [FlattenedBom],
"id": 4,
"imageIds": ["abc123"],
"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": 123.45,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": false,
"name": "abc123",
"nextRevisionValue": "xyz789",
"path": ["abc123"],
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 123,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": false,
"revisionValue": "abc123",
"rolledUpCostAsPrimary": false,
"specs": [ComponentSpec],
"status": "DESIGN",
"treeId": "abc123",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "xyz789",
"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
}
cpnType
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
family
id
isFreeFormOverride
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": 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": ["xyz789"],
"images": [Image],
"incompleteCost": false,
"integrations": Integrations,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": false,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "xyz789",
"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": "abc123",
"vendorInfo": ComponentVendorInfo,
"workflowState": "abc123"
}
]
}
}
family
Example
Query
query Family($family: String) {
family(family: $family) {
cpns {
archived
company {
...CompanyFragment
}
component {
...ComponentFragment
}
counter
created
creator {
...UserFragment
}
displayValue
family
id
isFreeFormOverride
legacyCpn
library {
...LibraryFragment
}
prefix
suffix
type
variant
}
familyCategory
value
}
}
Variables
{"family": "xyz789"}
Response
{
"data": {
"family": {
"cpns": [Cpn],
"familyCategory": "xyz789",
"value": "abc123"
}
}
}
imagesByIds
Example
Query
query ImagesByIds($ids: [ID]) {
imagesByIds(ids: $ids) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
cpnType
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": "xyz789",
"library": Library,
"mime": "GIF",
"mode": "DUMMY",
"name": "abc123",
"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
}
cpnType
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
}
isAllowedFreeFormOverride
isAllowedTwoVariableSuffixEdit
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": "xyz789",
"description": "abc123",
"id": "4",
"lastModified": "2007-12-03T10:15:30Z",
"name": "abc123",
"status": "xyz789",
"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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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
family
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
family
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": "abc123",
"documentLinks": [DocumentLink],
"effectivity": Effectivity,
"eid": "abc123",
"family": "xyz789",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": "4",
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": false,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"lastRevision": "xyz789",
"lastStatus": "abc123",
"legacyCpn": "abc123",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "abc123",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "abc123",
"modified": true,
"name": "abc123",
"nextRevisionValue": "abc123",
"notes": "abc123",
"parent": Product,
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "xyz789",
"revisionHistory": ProductRevision,
"revisionType": "CHANGE_ORDER",
"revisionValue": "abc123",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": true,
"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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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": false,
"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": "abc123",
"family": "xyz789",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": "4",
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": false,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"legacyCpn": "xyz789",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "abc123",
"modified": false,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "abc123",
"revisionHistory": [ProductRevision],
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": false,
"status": "DESIGN",
"team": ProductTeam,
"variantGroup": VariantGroup
}
]
}
}
subdomain
Use company.subdomain instead. This will be removed in a future release.
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
}
cpnType
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
}
isAllowedFreeFormOverride
isAllowedTwoVariableSuffixEdit
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": false,
"company": Company,
"cpnRules": CpnRules,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"customTileTitle": "xyz789",
"description": "xyz789",
"id": "4",
"lastModified": "2007-12-03T10:15:30Z",
"name": "xyz789",
"status": "xyz789",
"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
}
cpnType
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": "abc123",
"firstName": "xyz789",
"groups": ["ENGINEERING"],
"id": 4,
"integrations": {},
"invite": Invite,
"isSetupCompleted": true,
"lastDayActiveAt": "2007-12-03T10:15:30Z",
"lastLogin": "2007-12-03T10:15:30Z",
"lastName": "xyz789",
"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": "xyz789",
"verified": true
}
}
}
webhooksByIds
Example
Query
query WebhooksByIds($ids: [ID]) {
webhooksByIds(ids: $ids) {
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
cpnType
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": "abc123",
"eventTypes": ["CMP_CREATED"],
"id": "4",
"includeComponentProductData": true,
"lastModified": "2007-12-03T10:15:30Z",
"mode": "DUMMY",
"signingSecret": "abc123",
"status": "xyz789",
"webhookUrl": "xyz789"
}
]
}
}
Mutations
archiveChangeOrderApprovalTemplate
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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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": "abc123",
"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": "xyz789",
"history": [ChangeOrderHistory],
"id": 4,
"isParentInclude": false,
"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]
}
}
}
createChangeOrderApprovalTemplate
Response
Returns a ChangeOrderApprovalTemplate
Arguments
| Name | Description |
|---|---|
input - CreateChangeOrderApprovalTemplateInput
|
Example
Query
mutation CreateChangeOrderApprovalTemplate($input: CreateChangeOrderApprovalTemplateInput) {
createChangeOrderApprovalTemplate(input: $input) {
approvalType
approvers {
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
}
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
cpnType
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
}
externalUsers
id
isPublic
lastUsed
notifiers {
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
}
templateName
}
}
Variables
{"input": CreateChangeOrderApprovalTemplateInput}
Response
{
"data": {
"createChangeOrderApprovalTemplate": {
"approvalType": "FIRST_IN",
"approvers": [User],
"archived": false,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"externalUsers": ["xyz789"],
"id": "4",
"isPublic": false,
"lastUsed": 987.65,
"notifiers": [User],
"templateName": "abc123"
}
}
}
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
}
cpnType
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
family
id
isFreeFormOverride
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": "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": "xyz789",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 123,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": false,
"revisionValue": "xyz789",
"rolledUpCostAsPrimary": true,
"specs": [ComponentSpec],
"status": "DESIGN",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "abc123",
"vendorInfo": ComponentVendorInfo,
"workflowState": "abc123"
}
}
}
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
}
cpnType
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": false,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": 4,
"library": Library,
"mime": "xyz789",
"mode": "DUMMY",
"name": "abc123",
"regenerateDocumentRequest": "xyz789",
"size": 987,
"src": "abc123",
"status": "COMPLETED",
"translationId": "xyz789",
"url": "xyz789",
"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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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": ["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",
"family": "xyz789",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": "4",
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": true,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 123.45,
"massStatus": "ASSEMBLY",
"mode": "abc123",
"modified": true,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "abc123",
"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
}
cpnType
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": false,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"description": "abc123",
"eventTypes": ["CMP_CREATED"],
"id": "4",
"includeComponentProductData": false,
"lastModified": "2007-12-03T10:15:30Z",
"mode": "DUMMY",
"signingSecret": "xyz789",
"status": "abc123",
"webhookUrl": "abc123"
}
}
}
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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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": "abc123",
"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]
}
}
}
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
}
cpnType
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
family
id
isFreeFormOverride
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": "abc123",
"documentLinks": [DocumentLink],
"eid": "xyz789",
"flattenedBom": [FlattenedBom],
"id": "4",
"imageIds": ["abc123"],
"images": [Image],
"incompleteCost": true,
"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": "abc123",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "xyz789",
"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": "xyz789",
"vendorInfo": ComponentVendorInfo,
"workflowState": "xyz789"
}
}
}
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
}
cpnType
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": true,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"id": 4,
"library": Library,
"mime": "abc123",
"mode": "DUMMY",
"name": "abc123",
"regenerateDocumentRequest": "xyz789",
"size": 987,
"src": "abc123",
"status": "COMPLETED",
"translationId": "abc123",
"url": "xyz789",
"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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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": ["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",
"family": "abc123",
"flattenedBom": [FlattenedBom],
"forecasts": [Forecast],
"id": "4",
"imageIds": ["xyz789"],
"images": [Image],
"incompleteCost": false,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ProductRevision,
"legacyCpn": "abc123",
"legacyCpnVariant": "xyz789",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "xyz789",
"modified": false,
"name": "abc123",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "xyz789",
"revisionHistory": [ProductRevision],
"revisionValue": "xyz789",
"rolledUpCost": RolledUpCost,
"rolledUpCostAsPrimary": true,
"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
}
cpnType
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": true,
"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
}
cpnType
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": "abc123",
"status": "abc123",
"webhookUrl": "abc123"
}
]
}
}
updateCategories
Response
Returns [Category]
Arguments
| Name | Description |
|---|---|
companyId - ID
|
|
input - [CreateCategoryInput]
|
Example
Query
mutation UpdateCategories(
$companyId: ID,
$input: [CreateCategoryInput]
) {
updateCategories(
companyId: $companyId,
input: $input
) {
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
{
"companyId": "4",
"input": [CreateCategoryInput]
}
Response
{
"data": {
"updateCategories": [
{
"archived": false,
"code": "xyz789",
"customSpecs": [Spec],
"id": 4,
"isAllowedInPartAndAssembly": false,
"isDefaultCategory": true,
"name": "xyz789",
"shortName": "abc123",
"specs": [Spec],
"tags": ["MCAD"],
"type": "abc123",
"unitOfMeasure": "AR"
}
]
}
}
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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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": true}
Response
{
"data": {
"updateChangeOrder": {
"alias": "abc123",
"approvalType": "FIRST_IN",
"approvers": [ChangeOrderApprover],
"archived": true,
"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": "abc123",
"history": [ChangeOrderHistory],
"id": 4,
"isParentInclude": false,
"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]
}
}
}
updateChangeOrderApprovalTemplate
Response
Returns a ChangeOrderApprovalTemplate
Arguments
| Name | Description |
|---|---|
input - UpdateChangeOrderApprovalTemplateInput
|
Example
Query
mutation UpdateChangeOrderApprovalTemplate($input: UpdateChangeOrderApprovalTemplateInput) {
updateChangeOrderApprovalTemplate(input: $input) {
approvalType
approvers {
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
}
archived
company {
address {
...AddressFragment
}
archived
categories {
...CategoryFragment
}
cpnType
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
}
externalUsers
id
isPublic
lastUsed
notifiers {
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
}
templateName
}
}
Variables
{"input": UpdateChangeOrderApprovalTemplateInput}
Response
{
"data": {
"updateChangeOrderApprovalTemplate": {
"approvalType": "FIRST_IN",
"approvers": [User],
"archived": false,
"company": Company,
"created": "2007-12-03T10:15:30Z",
"creator": User,
"externalUsers": ["xyz789"],
"id": "4",
"isPublic": true,
"lastUsed": 987.65,
"notifiers": [User],
"templateName": "xyz789"
}
}
}
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
}
cpnType
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
family
id
isFreeFormOverride
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": "abc123",
"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": false,
"integrations": Integrations,
"lastModified": "2007-12-03T10:15:30Z",
"lastReleaseRevision": ComponentRevision,
"legacyCpn": "xyz789",
"legacyCpnVariant": "abc123",
"legacyNextRevision": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "DUMMY",
"modified": false,
"name": "xyz789",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "abc123",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "BUY",
"releasesCount": 123,
"restoreVariantGroup": VariantGroup,
"revisionHistory": [ComponentRevision],
"revisionManaged": true,
"revisionValue": "xyz789",
"rolledUpCostAsPrimary": true,
"specs": [ComponentSpec],
"status": "DESIGN",
"unitOfMeasure": "AR",
"variantGroup": VariantGroup,
"vendorId": "abc123",
"vendorInfo": ComponentVendorInfo,
"workflowState": "abc123"
}
}
}
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
}
cpnType
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
family
id
isFreeFormOverride
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
family
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
family
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
family
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": false,
"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",
"family": "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": "xyz789",
"library": Library,
"manufacturers": [Manufacturer],
"mass": 987.65,
"massStatus": "ASSEMBLY",
"mode": "abc123",
"modified": true,
"name": "abc123",
"nextRevisionValue": "xyz789",
"previousRevisionValue": "xyz789",
"previousStatus": "DESIGN",
"primarySource": PrimarySource,
"procurement": "abc123",
"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
|