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.

Contact

Contact

support@durolabs.co

Terms of Service

https://durolabs.co/terms

API Endpoints
# Production:
https://<BASE_URL>/graphql
Headers
# Refer to the Quick Start guide to obtain a token. Contact support for the BASE_URL.
apiToken: <YOUR_TOKEN_HERE>

Queries

apiToken

Response

Returns an ApiToken

Arguments
Name Description
type - ApiTokenType

Example

Query
query ApiToken($type: ApiTokenType) {
  apiToken(type: $type) {
    token
  }
}
Variables
{"type": "TBD"}
Response
{"data": {"apiToken": {"token": "xyz789"}}}

categories

Response

Returns a Categories

Arguments
Name Description
orderBy - [CategoriesOrderByInput]

Example

Query
query Categories($orderBy: [CategoriesOrderByInput]) {
  categories(orderBy: $orderBy) {
    connection {
      edges {
        ...CategoryEdgeFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
    }
  }
}
Variables
{"orderBy": [CategoriesOrderByInput]}
Response
{
  "data": {
    "categories": {"connection": CategoryConnection}
  }
}

categoriesByIds

Response

Returns [Category]

Arguments
Name Description
ids - [ID]

Example

Query
query CategoriesByIds($ids: [ID]) {
  categoriesByIds(ids: $ids) {
    archived
    code
    customSpecs {
      allowedValues
      company {
        ...CompanyFragment
      }
      defaultValue
      id
      isDropDown
      isPcb
      isRequired
      name
      type
    }
    id
    isAllowedInPartAndAssembly
    isDefaultCategory
    name
    shortName
    specs {
      allowedValues
      company {
        ...CompanyFragment
      }
      defaultValue
      id
      isDropDown
      isPcb
      isRequired
      name
      type
    }
    tags
    type
    unitOfMeasure
  }
}
Variables
{"ids": ["4"]}
Response
{
  "data": {
    "categoriesByIds": [
      {
        "archived": true,
        "code": "abc123",
        "customSpecs": [Spec],
        "id": "4",
        "isAllowedInPartAndAssembly": true,
        "isDefaultCategory": true,
        "name": "abc123",
        "shortName": "abc123",
        "specs": [Spec],
        "tags": ["MCAD"],
        "type": "xyz789",
        "unitOfMeasure": "AR"
      }
    ]
  }
}

changeOrders

Response

Returns a ChangeOrders

Arguments
Name Description
orderBy - [ChangeOrdersOrderByInput]

Example

Query
query ChangeOrders($orderBy: [ChangeOrdersOrderByInput]) {
  changeOrders(orderBy: $orderBy) {
    connection {
      edges {
        ...ChangeOrderEdgeFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
    }
  }
}
Variables
{"orderBy": [ChangeOrdersOrderByInput]}
Response
{
  "data": {
    "changeOrders": {"connection": ChangeOrderConnection}
  }
}

changeOrdersByIds

Response

Returns [ChangeOrder]

Arguments
Name Description
ids - [ID]
includeArchived - Boolean Default = false

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": true,
        "lastModified": "2007-12-03T10:15:30Z",
        "legacyCon": "xyz789",
        "library": Library,
        "name": "xyz789",
        "productRevisions": [ProductRevision],
        "products": [Product],
        "resolution": "APPROVED",
        "status": "CLOSED",
        "transitionOrigin": "DURO",
        "type": "DCO",
        "unchangedComponents": [Component],
        "unchangedProducts": [Product]
      }
    ]
  }
}

companiesByIds

Response

Returns [Company]

Arguments
Name Description
ids - [ID]

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": "xyz789",
        "logo": Image,
        "name": "xyz789",
        "onshapeRegisteredCompanies": [
          "xyz789"
        ],
        "revisionScheme": "ALPHA_BETA_AB",
        "settings": CompanySettings,
        "specs": [Spec],
        "subdomain": "xyz789",
        "subscriptions": [PaidSubscription],
        "users": [User],
        "website": "abc123"
      }
    ]
  }
}

companyCategories

Response

Returns [Category]

Arguments
Name Description
id - ID

Example

Query
query CompanyCategories($id: ID) {
  companyCategories(id: $id) {
    archived
    code
    customSpecs {
      allowedValues
      company {
        ...CompanyFragment
      }
      defaultValue
      id
      isDropDown
      isPcb
      isRequired
      name
      type
    }
    id
    isAllowedInPartAndAssembly
    isDefaultCategory
    name
    shortName
    specs {
      allowedValues
      company {
        ...CompanyFragment
      }
      defaultValue
      id
      isDropDown
      isPcb
      isRequired
      name
      type
    }
    tags
    type
    unitOfMeasure
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "companyCategories": [
      {
        "archived": true,
        "code": "abc123",
        "customSpecs": [Spec],
        "id": 4,
        "isAllowedInPartAndAssembly": true,
        "isDefaultCategory": true,
        "name": "abc123",
        "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": "abc123",
        "changeOrder": ChangeOrder,
        "children": [AssemblyChild],
        "company": Company,
        "cpn": Cpn,
        "created": "2007-12-03T10:15:30Z",
        "creator": User,
        "customSpecs": [CustomSpec],
        "description": "abc123",
        "documents": [DocumentLink],
        "eid": "abc123",
        "flattenedBom": [FlattenedBom],
        "id": 4,
        "imageIds": ["abc123"],
        "images": [Image],
        "incompleteCost": false,
        "integrationFields": [Integrations],
        "lastModified": "2007-12-03T10:15:30Z",
        "lastReleaseRevision": ComponentRevision,
        "legacyCpn": "abc123",
        "legacyCpnVariant": "xyz789",
        "legacyNextRevision": "xyz789",
        "library": Library,
        "manufacturers": [Manufacturer],
        "mass": 123.45,
        "massStatus": "ASSEMBLY",
        "mode": "DUMMY",
        "modified": false,
        "name": "xyz789",
        "nextRevisionValue": "abc123",
        "notes": "xyz789",
        "parent": Component,
        "previousRevisionValue": "abc123",
        "previousStatus": "DESIGN",
        "primarySource": PrimarySource,
        "procurement": "BUY",
        "releasesCount": 123,
        "restoreVariantGroup": VariantGroup,
        "revisionHistory": [ComponentRevision],
        "revisionManaged": false,
        "revisionType": "CHANGE_ORDER",
        "revisionValue": "abc123",
        "rolledUpCost": RolledUpCost,
        "rolledUpCostAsPrimary": true,
        "specs": [ComponentSpec],
        "status": "DESIGN",
        "subRevisions": [ComponentRevision],
        "unitOfMeasure": "AR",
        "variantGroup": VariantGroup,
        "vendorId": "abc123",
        "vendorInfo": ComponentVendorInfo,
        "workflowState": "abc123"
      }
    ]
  }
}

components

Response

Returns a Components

Arguments
Name Description
libraryType - LibraryType Default = GENERAL
orderBy - [ComponentsOrderByInput]
search - SearchFields

Example

Query
query Components(
  $libraryType: LibraryType,
  $orderBy: [ComponentsOrderByInput],
  $search: SearchFields
) {
  components(
    libraryType: $libraryType,
    orderBy: $orderBy,
    search: $search
  ) {
    connection {
      edges {
        ...ComponentEdgeFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
    }
  }
}
Variables
{
  "libraryType": "GENERAL",
  "orderBy": [ComponentsOrderByInput],
  "search": SearchFields
}
Response
{
  "data": {
    "components": {"connection": ComponentConnection}
  }
}

componentsByIds

Response

Returns [Component]

Arguments
Name Description
ids - [ID]

Example

Query
query ComponentsByIds($ids: [ID]) {
  componentsByIds(ids: $ids) {
    alias
    archived
    assemblyParents {
      ... on Component {
        ...ComponentFragment
      }
      ... on Product {
        ...ProductFragment
      }
    }
    category
    changeOrders {
      alias
      approvalType
      approvers {
        ...ChangeOrderApproverFragment
      }
      archived
      coExternalNotifyUserEmails
      coInternalNotifyUsers {
        ...UserFragment
      }
      company {
        ...CompanyFragment
      }
      componentRevisions {
        ...ComponentRevisionFragment
      }
      components {
        ...ComponentFragment
      }
      con {
        ...CpnFragment
      }
      created
      creator {
        ...UserFragment
      }
      description
      documentLinks {
        ...DocumentLinkFragment
      }
      erpOptions {
        ...ChangeOrderErpOptionsFragment
      }
      exportBundleKey
      history {
        ...ChangeOrderHistoryFragment
      }
      id
      isParentInclude
      lastModified
      legacyCon
      library {
        ...LibraryFragment
      }
      name
      productRevisions {
        ...ProductRevisionFragment
      }
      products {
        ...ProductFragment
      }
      resolution
      status
      transitionOrigin
      type
      unchangedComponents {
        ...ComponentFragment
      }
      unchangedProducts {
        ...ProductFragment
      }
    }
    children {
      assemblyRevision {
        ...ComponentRevisionFragment
      }
      component {
        ...ComponentFragment
      }
      isAddedAfterPullRequest
      itemNumber
      notes
      quantity
      refDes
      type
      variants {
        ...ComponentVariantContainerFragment
      }
      waste
    }
    company {
      address {
        ...AddressFragment
      }
      archived
      categories {
        ...CategoryFragment
      }
      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": "abc123",
        "documentLinks": [DocumentLink],
        "eid": "abc123",
        "flattenedBom": [FlattenedBom],
        "id": 4,
        "imageIds": ["abc123"],
        "images": [Image],
        "incompleteCost": true,
        "integrations": Integrations,
        "lastModified": "2007-12-03T10:15:30Z",
        "lastReleaseRevision": ComponentRevision,
        "legacyCpn": "xyz789",
        "legacyCpnVariant": "abc123",
        "legacyNextRevision": "abc123",
        "library": Library,
        "manufacturers": [Manufacturer],
        "mass": 123.45,
        "massStatus": "ASSEMBLY",
        "mode": "DUMMY",
        "modified": true,
        "name": "xyz789",
        "nextRevisionValue": "xyz789",
        "previousRevisionValue": "xyz789",
        "previousStatus": "DESIGN",
        "primarySource": PrimarySource,
        "procurement": "BUY",
        "releasesCount": 123,
        "restoreVariantGroup": VariantGroup,
        "revisionHistory": [ComponentRevision],
        "revisionManaged": true,
        "revisionValue": "abc123",
        "rolledUpCostAsPrimary": true,
        "specs": [ComponentSpec],
        "status": "DESIGN",
        "unitOfMeasure": "AR",
        "variantGroup": VariantGroup,
        "vendorId": "abc123",
        "vendorInfo": ComponentVendorInfo,
        "workflowState": "xyz789"
      }
    ]
  }
}

family

Response

Returns a Family

Arguments
Name Description
family - String

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": "xyz789"
    }
  }
}

imagesByIds

Response

Returns [Image]

Arguments
Name Description
ids - [ID]

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": true,
        "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

Response

Returns [Library]

Arguments
Name Description
ids - [ID]

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
      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": true,
        "company": Company,
        "cpnRules": CpnRules,
        "created": "2007-12-03T10:15:30Z",
        "creator": User,
        "customTileTitle": "abc123",
        "description": "abc123",
        "id": 4,
        "lastModified": "2007-12-03T10:15:30Z",
        "name": "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": false,
        "categories": ["abc123"],
        "changeOrder": ChangeOrder,
        "children": [AssemblyChild],
        "company": Company,
        "cpn": Cpn,
        "created": "2007-12-03T10:15:30Z",
        "creator": User,
        "customSpecs": [CustomSpec],
        "description": "abc123",
        "documentLinks": [DocumentLink],
        "effectivity": Effectivity,
        "eid": "xyz789",
        "family": "xyz789",
        "flattenedBom": [FlattenedBom],
        "forecasts": [Forecast],
        "id": 4,
        "imageIds": ["abc123"],
        "images": [Image],
        "incompleteCost": false,
        "lastModified": "2007-12-03T10:15:30Z",
        "lastReleaseRevision": ProductRevision,
        "lastRevision": "xyz789",
        "lastStatus": "xyz789",
        "legacyCpn": "abc123",
        "legacyCpnVariant": "abc123",
        "legacyNextRevision": "abc123",
        "library": Library,
        "manufacturers": [Manufacturer],
        "mass": 123.45,
        "massStatus": "ASSEMBLY",
        "mode": "xyz789",
        "modified": false,
        "name": "abc123",
        "nextRevisionValue": "abc123",
        "notes": "abc123",
        "parent": Product,
        "previousRevisionValue": "xyz789",
        "previousStatus": "DESIGN",
        "primarySource": PrimarySource,
        "procurement": "abc123",
        "revisionHistory": ProductRevision,
        "revisionType": "CHANGE_ORDER",
        "revisionValue": "abc123",
        "rolledUpCost": RolledUpCost,
        "rolledUpCostAsPrimary": false,
        "status": "DESIGN",
        "subRevisions": [ProductRevision],
        "team": ProductTeam,
        "variantGroup": VariantGroup
      }
    ]
  }
}

products

Response

Returns a Products

Arguments
Name Description
libraryType - LibraryType Default = GENERAL
orderBy - [ProductsOrderByInput]
search - SearchFields

Example

Query
query Products(
  $libraryType: LibraryType,
  $orderBy: [ProductsOrderByInput],
  $search: SearchFields
) {
  products(
    libraryType: $libraryType,
    orderBy: $orderBy,
    search: $search
  ) {
    connection {
      edges {
        ...ProductEdgeFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
    }
  }
}
Variables
{
  "libraryType": "GENERAL",
  "orderBy": [ProductsOrderByInput],
  "search": SearchFields
}
Response
{"data": {"products": {"connection": ProductConnection}}}

productsByIds

Response

Returns [Product]

Arguments
Name Description
ids - [ID]

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": true,
        "categories": ["abc123"],
        "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": "xyz789",
        "flattenedBom": [FlattenedBom],
        "forecasts": [Forecast],
        "id": "4",
        "imageIds": ["xyz789"],
        "images": [Image],
        "incompleteCost": true,
        "lastModified": "2007-12-03T10:15:30Z",
        "lastReleaseRevision": ProductRevision,
        "legacyCpn": "abc123",
        "legacyCpnVariant": "xyz789",
        "legacyNextRevision": "xyz789",
        "library": Library,
        "manufacturers": [Manufacturer],
        "mass": 987.65,
        "massStatus": "ASSEMBLY",
        "mode": "abc123",
        "modified": false,
        "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
      }
    ]
  }
}

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": "abc123"}
  }
}

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
      product {
        ...CpnRulesFieldsFragment
      }
    }
    created
    creator {
      activeLibrary {
        ...LibraryFragment
      }
      archived
      avatar {
        ...ImageFragment
      }
      created
      email
      firstName
      groups
      id
      integrations
      invite {
        ...InviteFragment
      }
      isSetupCompleted
      lastDayActiveAt
      lastLogin
      lastName
      libraries {
        ...LibraryFragment
      }
      logins {
        ...LoginTimeFragment
      }
      onShapeKeys {
        ...OnShapeKeysFragment
      }
      onboarding {
        ...OnboardingFragment
      }
      personalLibrary {
        ...LibraryFragment
      }
      preferences {
        ...PreferencesFragment
      }
      primaryCompany {
        ...CompanyFragment
      }
      rememberUserDevice {
        ...RememberUserDeviceFragment
      }
      role
      solidworksAnalytics {
        ...SolidworksAnalyticsFragment
      }
      status
      styles
      timezoneOffset
      title
      verified
    }
    customTileTitle
    description
    id
    lastModified
    name
    status
    systemGenerated
    type
    users {
      activeLibrary {
        ...LibraryFragment
      }
      archived
      avatar {
        ...ImageFragment
      }
      created
      email
      firstName
      groups
      id
      integrations
      invite {
        ...InviteFragment
      }
      isSetupCompleted
      lastDayActiveAt
      lastLogin
      lastName
      libraries {
        ...LibraryFragment
      }
      logins {
        ...LoginTimeFragment
      }
      onShapeKeys {
        ...OnShapeKeysFragment
      }
      onboarding {
        ...OnboardingFragment
      }
      personalLibrary {
        ...LibraryFragment
      }
      preferences {
        ...PreferencesFragment
      }
      primaryCompany {
        ...CompanyFragment
      }
      rememberUserDevice {
        ...RememberUserDeviceFragment
      }
      role
      solidworksAnalytics {
        ...SolidworksAnalyticsFragment
      }
      status
      styles
      timezoneOffset
      title
      verified
    }
  }
}
Response
{
  "data": {
    "tokenActiveLibrary": {
      "archived": true,
      "company": Company,
      "cpnRules": CpnRules,
      "created": "2007-12-03T10:15:30Z",
      "creator": User,
      "customTileTitle": "xyz789",
      "description": "abc123",
      "id": "4",
      "lastModified": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "status": "abc123",
      "systemGenerated": false,
      "type": "GENERAL",
      "users": [User]
    }
  }
}

userById

Response

Returns a User

Arguments
Name Description
id - ID

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": false,
      "avatar": Image,
      "created": "2007-12-03T10:15:30Z",
      "email": "xyz789",
      "firstName": "xyz789",
      "groups": ["ENGINEERING"],
      "id": 4,
      "integrations": {},
      "invite": Invite,
      "isSetupCompleted": false,
      "lastDayActiveAt": "2007-12-03T10:15:30Z",
      "lastLogin": "2007-12-03T10:15:30Z",
      "lastName": "abc123",
      "libraries": [Library],
      "logins": [LoginTime],
      "onShapeKeys": OnShapeKeys,
      "onboarding": Onboarding,
      "personalLibrary": Library,
      "preferences": Preferences,
      "primaryCompany": Company,
      "rememberUserDevice": RememberUserDevice,
      "role": "ADMINISTRATOR",
      "solidworksAnalytics": [SolidworksAnalytics],
      "status": "DISABLED",
      "styles": "abc123",
      "timezoneOffset": 987,
      "title": "abc123",
      "verified": false
    }
  }
}

webhooksByIds

Response

Returns [Webhook]

Arguments
Name Description
ids - [ID]

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": 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": "xyz789",
        "webhookUrl": "xyz789"
      }
    ]
  }
}

Mutations

createChangeOrder

Response

Returns a ChangeOrder

Arguments
Name Description
input - CreateChangeOrderInput

Example

Query
mutation CreateChangeOrder($input: CreateChangeOrderInput) {
  createChangeOrder(input: $input) {
    alias
    approvalType
    approvers {
      action
      id
      invitedAt
      performedAt
      user {
        ...UserFragment
      }
    }
    archived
    coExternalNotifyUserEmails
    coInternalNotifyUsers {
      activeLibrary {
        ...LibraryFragment
      }
      archived
      avatar {
        ...ImageFragment
      }
      created
      email
      firstName
      groups
      id
      integrations
      invite {
        ...InviteFragment
      }
      isSetupCompleted
      lastDayActiveAt
      lastLogin
      lastName
      libraries {
        ...LibraryFragment
      }
      logins {
        ...LoginTimeFragment
      }
      onShapeKeys {
        ...OnShapeKeysFragment
      }
      onboarding {
        ...OnboardingFragment
      }
      personalLibrary {
        ...LibraryFragment
      }
      preferences {
        ...PreferencesFragment
      }
      primaryCompany {
        ...CompanyFragment
      }
      rememberUserDevice {
        ...RememberUserDeviceFragment
      }
      role
      solidworksAnalytics {
        ...SolidworksAnalyticsFragment
      }
      status
      styles
      timezoneOffset
      title
      verified
    }
    company {
      address {
        ...AddressFragment
      }
      archived
      categories {
        ...CategoryFragment
      }
      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": [
        "xyz789"
      ],
      "coInternalNotifyUsers": [User],
      "company": Company,
      "componentRevisions": [ComponentRevision],
      "components": [Component],
      "con": Cpn,
      "created": "2007-12-03T10:15:30Z",
      "creator": User,
      "description": "xyz789",
      "documentLinks": [DocumentLink],
      "erpOptions": ChangeOrderErpOptions,
      "exportBundleKey": "xyz789",
      "history": [ChangeOrderHistory],
      "id": "4",
      "isParentInclude": true,
      "lastModified": "2007-12-03T10:15:30Z",
      "legacyCon": "xyz789",
      "library": Library,
      "name": "abc123",
      "productRevisions": [ProductRevision],
      "products": [Product],
      "resolution": "APPROVED",
      "status": "CLOSED",
      "transitionOrigin": "DURO",
      "type": "DCO",
      "unchangedComponents": [Component],
      "unchangedProducts": [Product]
    }
  }
}

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": ["abc123"],
      "images": [Image],
      "incompleteCost": true,
      "integrations": Integrations,
      "lastModified": "2007-12-03T10:15:30Z",
      "lastReleaseRevision": ComponentRevision,
      "legacyCpn": "xyz789",
      "legacyCpnVariant": "xyz789",
      "legacyNextRevision": "abc123",
      "library": Library,
      "manufacturers": [Manufacturer],
      "mass": 123.45,
      "massStatus": "ASSEMBLY",
      "mode": "DUMMY",
      "modified": false,
      "name": "abc123",
      "nextRevisionValue": "abc123",
      "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": "xyz789",
      "vendorInfo": ComponentVendorInfo,
      "workflowState": "xyz789"
    }
  }
}

createDocuments

Description

Uploads must be form-data requests with the header apollo-require-preflight: true. Example:

curl https://BASE_URL/graphql -H "authorization: Bearer YOUR_TOKEN" -H "apollo-require-preflight:true" \
-F operations='{ "query": "mutation ($input:[CreateDocumentInput]!, $itemId: ID!, $itemType: ModelType!) { createDocuments(input:$input, itemId: $itemId, itemType: $itemType) { id mime name size src status url }}", "variables": {"input": [{"mime": "application/pdf", "name":"duro.pdf", "file":null, "type":"DATASHEET" }], "itemId": "YOUR_COMPONENT_ID", "itemType": "CMP"} }' \
-F map='{ "0": ["variables.input.0.file"] }' \
-F 0=@/path/to/duro.pdf
Response

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": "abc123",
        "mode": "DUMMY",
        "name": "abc123",
        "regenerateDocumentRequest": "abc123",
        "size": 987,
        "src": "xyz789",
        "status": "COMPLETED",
        "translationId": "abc123",
        "url": "xyz789",
        "vendor": "ALTIUM",
        "visibility": true
      }
    ]
  }
}

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": ["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": ["xyz789"],
      "images": [Image],
      "incompleteCost": true,
      "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": "abc123",
      "revisionHistory": [ProductRevision],
      "revisionValue": "xyz789",
      "rolledUpCost": RolledUpCost,
      "rolledUpCostAsPrimary": false,
      "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": true,
      "lastModified": "2007-12-03T10:15:30Z",
      "mode": "DUMMY",
      "signingSecret": "abc123",
      "status": "xyz789",
      "webhookUrl": "xyz789"
    }
  }
}

deleteChangeOrder

Response

Returns a ChangeOrder

Arguments
Name Description
input - DeleteInput

Example

Query
mutation DeleteChangeOrder($input: DeleteInput) {
  deleteChangeOrder(input: $input) {
    alias
    approvalType
    approvers {
      action
      id
      invitedAt
      performedAt
      user {
        ...UserFragment
      }
    }
    archived
    coExternalNotifyUserEmails
    coInternalNotifyUsers {
      activeLibrary {
        ...LibraryFragment
      }
      archived
      avatar {
        ...ImageFragment
      }
      created
      email
      firstName
      groups
      id
      integrations
      invite {
        ...InviteFragment
      }
      isSetupCompleted
      lastDayActiveAt
      lastLogin
      lastName
      libraries {
        ...LibraryFragment
      }
      logins {
        ...LoginTimeFragment
      }
      onShapeKeys {
        ...OnShapeKeysFragment
      }
      onboarding {
        ...OnboardingFragment
      }
      personalLibrary {
        ...LibraryFragment
      }
      preferences {
        ...PreferencesFragment
      }
      primaryCompany {
        ...CompanyFragment
      }
      rememberUserDevice {
        ...RememberUserDeviceFragment
      }
      role
      solidworksAnalytics {
        ...SolidworksAnalyticsFragment
      }
      status
      styles
      timezoneOffset
      title
      verified
    }
    company {
      address {
        ...AddressFragment
      }
      archived
      categories {
        ...CategoryFragment
      }
      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": "abc123",
      "approvalType": "FIRST_IN",
      "approvers": [ChangeOrderApprover],
      "archived": false,
      "coExternalNotifyUserEmails": [
        "xyz789"
      ],
      "coInternalNotifyUsers": [User],
      "company": Company,
      "componentRevisions": [ComponentRevision],
      "components": [Component],
      "con": Cpn,
      "created": "2007-12-03T10:15:30Z",
      "creator": User,
      "description": "abc123",
      "documentLinks": [DocumentLink],
      "erpOptions": ChangeOrderErpOptions,
      "exportBundleKey": "xyz789",
      "history": [ChangeOrderHistory],
      "id": "4",
      "isParentInclude": true,
      "lastModified": "2007-12-03T10:15:30Z",
      "legacyCon": "abc123",
      "library": Library,
      "name": "abc123",
      "productRevisions": [ProductRevision],
      "products": [Product],
      "resolution": "APPROVED",
      "status": "CLOSED",
      "transitionOrigin": "DURO",
      "type": "DCO",
      "unchangedComponents": [Component],
      "unchangedProducts": [Product]
    }
  }
}

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": "abc123",
      "changeOrders": [ChangeOrder],
      "children": [AssemblyChild],
      "company": Company,
      "cpn": Cpn,
      "created": "2007-12-03T10:15:30Z",
      "creator": User,
      "customSpecs": [CustomSpec],
      "description": "xyz789",
      "documentLinks": [DocumentLink],
      "eid": "abc123",
      "flattenedBom": [FlattenedBom],
      "id": 4,
      "imageIds": ["abc123"],
      "images": [Image],
      "incompleteCost": true,
      "integrations": Integrations,
      "lastModified": "2007-12-03T10:15:30Z",
      "lastReleaseRevision": ComponentRevision,
      "legacyCpn": "xyz789",
      "legacyCpnVariant": "xyz789",
      "legacyNextRevision": "abc123",
      "library": Library,
      "manufacturers": [Manufacturer],
      "mass": 987.65,
      "massStatus": "ASSEMBLY",
      "mode": "DUMMY",
      "modified": true,
      "name": "abc123",
      "nextRevisionValue": "abc123",
      "previousRevisionValue": "xyz789",
      "previousStatus": "DESIGN",
      "primarySource": PrimarySource,
      "procurement": "BUY",
      "releasesCount": 987,
      "restoreVariantGroup": VariantGroup,
      "revisionHistory": [ComponentRevision],
      "revisionManaged": false,
      "revisionValue": "xyz789",
      "rolledUpCostAsPrimary": true,
      "specs": [ComponentSpec],
      "status": "DESIGN",
      "unitOfMeasure": "AR",
      "variantGroup": VariantGroup,
      "vendorId": "xyz789",
      "vendorInfo": ComponentVendorInfo,
      "workflowState": "abc123"
    }
  }
}

deleteDocuments

Response

Returns [Document]

Arguments
Name Description
input - [DeleteInput]
itemId - ID Component/Product to attach documents to.
itemType - ModelType Component or Product type

Example

Query
mutation DeleteDocuments(
  $input: [DeleteInput],
  $itemId: ID,
  $itemType: ModelType
) {
  deleteDocuments(
    input: $input,
    itemId: $itemId,
    itemType: $itemType
  ) {
    archived
    company {
      address {
        ...AddressFragment
      }
      archived
      categories {
        ...CategoryFragment
      }
      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": "xyz789",
        "mode": "DUMMY",
        "name": "xyz789",
        "regenerateDocumentRequest": "xyz789",
        "size": 123,
        "src": "xyz789",
        "status": "COMPLETED",
        "translationId": "xyz789",
        "url": "abc123",
        "vendor": "ALTIUM",
        "visibility": false
      }
    ]
  }
}

deleteProduct

Response

Returns a Product

Arguments
Name Description
input - DeleteInput

Example

Query
mutation DeleteProduct($input: DeleteInput) {
  deleteProduct(input: $input) {
    alias
    archived
    categories
    changeOrders {
      alias
      approvalType
      approvers {
        ...ChangeOrderApproverFragment
      }
      archived
      coExternalNotifyUserEmails
      coInternalNotifyUsers {
        ...UserFragment
      }
      company {
        ...CompanyFragment
      }
      componentRevisions {
        ...ComponentRevisionFragment
      }
      components {
        ...ComponentFragment
      }
      con {
        ...CpnFragment
      }
      created
      creator {
        ...UserFragment
      }
      description
      documentLinks {
        ...DocumentLinkFragment
      }
      erpOptions {
        ...ChangeOrderErpOptionsFragment
      }
      exportBundleKey
      history {
        ...ChangeOrderHistoryFragment
      }
      id
      isParentInclude
      lastModified
      legacyCon
      library {
        ...LibraryFragment
      }
      name
      productRevisions {
        ...ProductRevisionFragment
      }
      products {
        ...ProductFragment
      }
      resolution
      status
      transitionOrigin
      type
      unchangedComponents {
        ...ComponentFragment
      }
      unchangedProducts {
        ...ProductFragment
      }
    }
    children {
      assemblyRevision {
        ...ComponentRevisionFragment
      }
      component {
        ...ComponentFragment
      }
      isAddedAfterPullRequest
      itemNumber
      notes
      quantity
      refDes
      type
      variants {
        ...ComponentVariantContainerFragment
      }
      waste
    }
    company {
      address {
        ...AddressFragment
      }
      archived
      categories {
        ...CategoryFragment
      }
      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": ["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": "abc123",
      "flattenedBom": [FlattenedBom],
      "forecasts": [Forecast],
      "id": 4,
      "imageIds": ["xyz789"],
      "images": [Image],
      "incompleteCost": false,
      "lastModified": "2007-12-03T10:15:30Z",
      "lastReleaseRevision": ProductRevision,
      "legacyCpn": "xyz789",
      "legacyCpnVariant": "abc123",
      "legacyNextRevision": "abc123",
      "library": Library,
      "manufacturers": [Manufacturer],
      "mass": 987.65,
      "massStatus": "ASSEMBLY",
      "mode": "xyz789",
      "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
    }
  }
}

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": false,
      "company": Company,
      "created": "2007-12-03T10:15:30Z",
      "creator": User,
      "description": "xyz789",
      "eventTypes": ["CMP_CREATED"],
      "id": "4",
      "includeComponentProductData": true,
      "lastModified": "2007-12-03T10:15:30Z",
      "mode": "DUMMY",
      "signingSecret": "abc123",
      "status": "abc123",
      "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": 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"
      }
    ]
  }
}

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": false}
Response
{
  "data": {
    "updateChangeOrder": {
      "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": "abc123",
      "history": [ChangeOrderHistory],
      "id": 4,
      "isParentInclude": false,
      "lastModified": "2007-12-03T10:15:30Z",
      "legacyCon": "abc123",
      "library": Library,
      "name": "abc123",
      "productRevisions": [ProductRevision],
      "products": [Product],
      "resolution": "APPROVED",
      "status": "CLOSED",
      "transitionOrigin": "DURO",
      "type": "DCO",
      "unchangedComponents": [Component],
      "unchangedProducts": [Product]
    }
  }
}

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": true,
      "integrations": Integrations,
      "lastModified": "2007-12-03T10:15:30Z",
      "lastReleaseRevision": ComponentRevision,
      "legacyCpn": "abc123",
      "legacyCpnVariant": "abc123",
      "legacyNextRevision": "xyz789",
      "library": Library,
      "manufacturers": [Manufacturer],
      "mass": 123.45,
      "massStatus": "ASSEMBLY",
      "mode": "DUMMY",
      "modified": false,
      "name": "abc123",
      "nextRevisionValue": "abc123",
      "previousRevisionValue": "abc123",
      "previousStatus": "DESIGN",
      "primarySource": PrimarySource,
      "procurement": "BUY",
      "releasesCount": 123,
      "restoreVariantGroup": VariantGroup,
      "revisionHistory": [ComponentRevision],
      "revisionManaged": true,
      "revisionValue": "abc123",
      "rolledUpCostAsPrimary": true,
      "specs": [ComponentSpec],
      "status": "DESIGN",
      "unitOfMeasure": "AR",
      "variantGroup": VariantGroup,
      "vendorId": "abc123",
      "vendorInfo": ComponentVendorInfo,
      "workflowState": "xyz789"
    }
  }
}

updateProduct

Response

Returns a Product

Arguments
Name Description
input - UpdateProductInput

Example

Query
mutation UpdateProduct($input: UpdateProductInput) {
  updateProduct(input: $input) {
    alias
    archived
    categories
    changeOrders {
      alias
      approvalType
      approvers {
        ...ChangeOrderApproverFragment
      }
      archived
      coExternalNotifyUserEmails
      coInternalNotifyUsers {
        ...UserFragment
      }
      company {
        ...CompanyFragment
      }
      componentRevisions {
        ...ComponentRevisionFragment
      }
      components {
        ...ComponentFragment
      }
      con {
        ...CpnFragment
      }
      created
      creator {
        ...UserFragment
      }
      description
      documentLinks {
        ...DocumentLinkFragment
      }
      erpOptions {
        ...ChangeOrderErpOptionsFragment
      }
      exportBundleKey
      history {
        ...ChangeOrderHistoryFragment
      }
      id
      isParentInclude
      lastModified
      legacyCon
      library {
        ...LibraryFragment
      }
      name
      productRevisions {
        ...ProductRevisionFragment
      }
      products {
        ...ProductFragment
      }
      resolution
      status
      transitionOrigin
      type
      unchangedComponents {
        ...ComponentFragment
      }
      unchangedProducts {
        ...ProductFragment
      }
    }
    children {
      assemblyRevision {
        ...ComponentRevisionFragment
      }
      component {
        ...ComponentFragment
      }
      isAddedAfterPullRequest
      itemNumber
      notes
      quantity
      refDes
      type
      variants {
        ...ComponentVariantContainerFragment
      }
      waste
    }
    company {
      address {
        ...AddressFragment
      }
      archived
      categories {
        ...CategoryFragment
      }
      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": true,
      "lastModified": "2007-12-03T10:15:30Z",
      "lastReleaseRevision": ProductRevision,
      "legacyCpn": "xyz789",
      "legacyCpnVariant": "xyz789",
      "legacyNextRevision": "abc123",
      "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": "abc123",
      "rolledUpCost": RolledUpCost,
      "rolledUpCostAsPrimary": true,
      "status": "DESIGN",
      "team": ProductTeam,
      "variantGroup": VariantGroup
    }
  }
}

Types

AdditionalPayloadForNotifications

Fields
Field Name Description
childComponent - Boolean
parentAssemblies - Boolean
Example
{"childComponent": false, "parentAssemblies": false}

Address

Fields
Field Name Description
city - String
country - String
state - String
street - String
suite - String
zip - String
Example
{
  "city": "abc123",
  "country": "xyz789",
  "state": "xyz789",
  "street": "abc123",
  "suite": "abc123",
  "zip": "xyz789"
}

AltiumInfo

Fields
Field Name Description
revision - String
status - AltiumStatus
Example
{"revision": "xyz789", "status": "DRAFT"}

AltiumStatus

Description

Altium statuses

Values
Enum Value Description

DRAFT

OBSOLETE

PRODUCTION

PROTOTYPE

Example
"DRAFT"

ApiToken

Fields
Field Name Description
token - String
Example
{"token": "abc123"}

ApiTokenType

Description

API token type (TBD)

Values
Enum Value Description

TBD

Example
"TBD"

AssemblyChild

Fields
Field Name Description
assemblyRevision - ComponentRevision
component - Component
isAddedAfterPullRequest - Boolean
itemNumber - Int
notes - String
quantity - Float
refDes - String
type - ModelType
variants - [ComponentVariantContainer]
waste - Float
Example
{
  "assemblyRevision": ComponentRevision,
  "component": Component,
  "isAddedAfterPullRequest": true,
  "itemNumber": 987,
  "notes": "xyz789",
  "quantity": 123.45,
  "refDes": "xyz789",
  "type": "CMP",
  "variants": [ComponentVariantContainer],
  "waste": 987.65
}

AssemblyChildInput

Fields
Input Field Description
assemblyRevisionId - String
componentId - String
isAddedAfterPullRequest - Boolean
itemNumber - Int
notes - String
quantity - Float!
refDes - String
variants - [AssemblyVariantInput]
waste - Float
Example
{
  "assemblyRevisionId": "xyz789",
  "componentId": "abc123",
  "isAddedAfterPullRequest": true,
  "itemNumber": 123,
  "notes": "xyz789",
  "quantity": 123.45,
  "refDes": "abc123",
  "variants": [AssemblyVariantInput],
  "waste": 987.65
}

AssemblyParent

Types
Union Types

Component

Product

Example
Component

AssemblyVariantInput

Fields
Input Field Description
isPermitted - Boolean!
isPrimary - Boolean
variantId - ID!
Example
{
  "isPermitted": true,
  "isPrimary": false,
  "variantId": "4"
}

BlacklistedRevision

Description

Blacklisted revision

Values
Enum Value Description

I

O

Q

S

X

Z

Example
"I"

Boolean

Description

The Boolean scalar type represents true or false.

Categories

Fields
Field Name Description
connection - CategoryConnection
Arguments
after - String

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

before - String

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

companyId - ID
createdSince - DateTime
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

updatedSince - DateTime
userId - ID
Example
{"connection": CategoryConnection}

CategoriesOrderByInput

Fields
Input Field Description
code - SortDirection
isAllowedInPartAndAssembly - SortDirection
isDefaultCategory - SortDirection
name - SortDirection
shortName - SortDirection
type - SortDirection
unitOfMeasure - SortDirection
Example
{
  "code": "asc",
  "isAllowedInPartAndAssembly": "asc",
  "isDefaultCategory": "asc",
  "name": "asc",
  "shortName": "asc",
  "type": "asc",
  "unitOfMeasure": "asc"
}

Category

Fields
Field Name Description
archived - Boolean
code - String
customSpecs - [Spec]
id - ID
isAllowedInPartAndAssembly - Boolean
isDefaultCategory - Boolean
name - String
shortName - String
specs - [Spec]
tags - [CategoryTag]
type - String
unitOfMeasure - ComponentUnitMeasure
Example
{
  "archived": false,
  "code": "xyz789",
  "customSpecs": [Spec],
  "id": "4",
  "isAllowedInPartAndAssembly": true,
  "isDefaultCategory": true,
  "name": "abc123",
  "shortName": "abc123",
  "specs": [Spec],
  "tags": ["MCAD"],
  "type": "abc123",
  "unitOfMeasure": "AR"
}

CategoryConnection

Example
{
  "edges": [CategoryEdge],
  "pageInfo": PageInfo,
  "totalCount": 987
}

CategoryEdge

Example
{
  "cursor": "xyz789",
  "node": Category
}

CategoryTag

Description

Category tag type

Values
Enum Value Description

MCAD

Example
"MCAD"

ChangeOrder

Fields
Field Name Description
alias - String
approvalType - EcoDefaultApproval
approvers - [ChangeOrderApprover]
archived - Boolean
coExternalNotifyUserEmails - [String]
coInternalNotifyUsers - [User]
company - Company
componentRevisions - [ComponentRevision]
components - [Component]
con - Cpn
created - DateTime
creator - User
description - String
documentLinks - [DocumentLink]
erpOptions - ChangeOrderErpOptions
exportBundleKey - String
history - [ChangeOrderHistory]
id - ID
isParentInclude - Boolean
lastModified - DateTime
legacyCon - String To be deprecated
library - Library
name - String
productRevisions - [ProductRevision]
products - [Product]
resolution - ChangeOrderResolution
status - ChangeOrderStatus
transitionOrigin - ChangeOrderTransitionOrigin
type - ChangeOrderType
unchangedComponents - [Component]
unchangedProducts - [Product]
Example
{
  "alias": "xyz789",
  "approvalType": "FIRST_IN",
  "approvers": [ChangeOrderApprover],
  "archived": false,
  "coExternalNotifyUserEmails": ["xyz789"],
  "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": "xyz789",
  "productRevisions": [ProductRevision],
  "products": [Product],
  "resolution": "APPROVED",
  "status": "CLOSED",
  "transitionOrigin": "DURO",
  "type": "DCO",
  "unchangedComponents": [Component],
  "unchangedProducts": [Product]
}

ChangeOrderAction

Description

Change Order Action

Values
Enum Value Description

APPROVED

CLOSED

CREATED

EDITED

NONE

REJECTED

RESENT

SUBMITTED

VIEWED

Example
"APPROVED"

ChangeOrderApprovalTemplate

Fields
Field Name Description
approvalType - EcoDefaultApproval
approvers - [User]
archived - Boolean
company - Company
created - DateTime
creator - User
externalUsers - [String]
id - ID
isPublic - Boolean
notifiers - [User]
templateName - String
Example
{
  "approvalType": "FIRST_IN",
  "approvers": [User],
  "archived": true,
  "company": Company,
  "created": "2007-12-03T10:15:30Z",
  "creator": User,
  "externalUsers": ["xyz789"],
  "id": 4,
  "isPublic": false,
  "notifiers": [User],
  "templateName": "xyz789"
}

ChangeOrderApprover

Fields
Field Name Description
action - ChangeOrderAction
id - ID
invitedAt - DateTime
performedAt - DateTime
user - User
Example
{
  "action": "APPROVED",
  "id": 4,
  "invitedAt": "2007-12-03T10:15:30Z",
  "performedAt": "2007-12-03T10:15:30Z",
  "user": User
}

ChangeOrderConnection

Example
{
  "edges": [ChangeOrderEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

ChangeOrderEdge

Example
{
  "cursor": "abc123",
  "node": ChangeOrder
}

ChangeOrderErpEffectivity

Fields
Field Name Description
endDate - DateTime
isEnabled - Boolean
overrideExisting - Boolean
startDate - DateTime
Example
{
  "endDate": "2007-12-03T10:15:30Z",
  "isEnabled": false,
  "overrideExisting": true,
  "startDate": "2007-12-03T10:15:30Z"
}

ChangeOrderErpEffectivityInput

Fields
Input Field Description
endDate - DateTime
isEnabled - Boolean
overrideExisting - Boolean
startDate - DateTime
Example
{
  "endDate": "2007-12-03T10:15:30Z",
  "isEnabled": true,
  "overrideExisting": true,
  "startDate": "2007-12-03T10:15:30Z"
}

ChangeOrderErpItemType

Fields
Field Name Description
isEnabled - Boolean
overrideExisting - Boolean
value - ErpItemType
Example
{"isEnabled": true, "overrideExisting": true, "value": "LOT_TRACKED"}

ChangeOrderErpItemTypeInput

Fields
Input Field Description
isEnabled - Boolean
overrideExisting - Boolean
value - ErpItemType
Example
{"isEnabled": false, "overrideExisting": false, "value": "LOT_TRACKED"}

ChangeOrderErpOptions

Fields
Field Name Description
additionalPayloadForNotifications - AdditionalPayloadForNotifications
effectivity - ChangeOrderErpEffectivity
itemType - ChangeOrderErpItemType
Example
{
  "additionalPayloadForNotifications": AdditionalPayloadForNotifications,
  "effectivity": ChangeOrderErpEffectivity,
  "itemType": ChangeOrderErpItemType
}

ChangeOrderErpOptionsInput

Fields
Input Field Description
effectivity - ChangeOrderErpEffectivityInput
itemType - ChangeOrderErpItemTypeInput
Example
{
  "effectivity": ChangeOrderErpEffectivityInput,
  "itemType": ChangeOrderErpItemTypeInput
}

ChangeOrderHistory

Fields
Field Name Description
action - ChangeOrderAction
comment - String
created - DateTime
id - ID
user - User
Example
{
  "action": "APPROVED",
  "comment": "xyz789",
  "created": "2007-12-03T10:15:30Z",
  "id": 4,
  "user": User
}

ChangeOrderResolution

Description

Change Order Resolution

Values
Enum Value Description

APPROVED

FINALIZING

NONE

REJECTED

UNRESOLVED

Example
"APPROVED"

ChangeOrderStatus

Description

Change Order Status

Values
Enum Value Description

CLOSED

DRAFT

OPEN

Example
"CLOSED"

ChangeOrderTemplateMapping

Fields
Field Name Description
company - Company
dcoProduction - ChangeOrderApprovalTemplate
dcoPrototype - ChangeOrderApprovalTemplate
ecoProduction - ChangeOrderApprovalTemplate
ecoPrototype - ChangeOrderApprovalTemplate
id - ID
mcoProduction - ChangeOrderApprovalTemplate
mcoPrototype - ChangeOrderApprovalTemplate
Example
{
  "company": Company,
  "dcoProduction": ChangeOrderApprovalTemplate,
  "dcoPrototype": ChangeOrderApprovalTemplate,
  "ecoProduction": ChangeOrderApprovalTemplate,
  "ecoPrototype": ChangeOrderApprovalTemplate,
  "id": 4,
  "mcoProduction": ChangeOrderApprovalTemplate,
  "mcoPrototype": ChangeOrderApprovalTemplate
}

ChangeOrderTransitionOrigin

Description

Change Order Transition Origin

Values
Enum Value Description

DURO

ONSHAPE

Example
"DURO"

ChangeOrderType

Description

Change Order Type

Values
Enum Value Description

DCO

ECO

MCO

Example
"DCO"

ChangeOrders

Fields
Field Name Description
connection - ChangeOrderConnection
Arguments
after - String

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

before - String

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

companyId - ID
createdSince - DateTime
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

updatedSince - DateTime
userId - ID
Example
{"connection": ChangeOrderConnection}

ChangeOrdersOrderByInput

Fields
Input Field Description
alias - SortDirection
con - SortDirection
description - SortDirection
lastModified - SortDirection
name - SortDirection
resolution - SortDirection
status - SortDirection
type - SortDirection
Example
{
  "alias": "asc",
  "con": "asc",
  "description": "asc",
  "lastModified": "asc",
  "name": "asc",
  "resolution": "asc",
  "status": "asc",
  "type": "asc"
}

Company

Fields
Field Name Description
address - Address
archived - Boolean
categories - [Category]
cpnType - String
created - DateTime
creator - User
id - ID
integrations - JSON
isEnabledCustomCategory - Boolean
legacyCpnVariantScheme - String Deprecated
logo - Image
name - String
onshapeRegisteredCompanies - [String]
revisionScheme - RevisionScheme
settings - CompanySettings
specs - [Spec]
Arguments
status - Status
subdomain - String
subscriptions - [PaidSubscription]
users - [User]
Arguments
status - Status
website - String
Example
{
  "address": Address,
  "archived": true,
  "categories": [Category],
  "cpnType": "abc123",
  "created": "2007-12-03T10:15:30Z",
  "creator": User,
  "id": "4",
  "integrations": {},
  "isEnabledCustomCategory": false,
  "legacyCpnVariantScheme": "xyz789",
  "logo": Image,
  "name": "abc123",
  "onshapeRegisteredCompanies": ["xyz789"],
  "revisionScheme": "ALPHA_BETA_AB",
  "settings": CompanySettings,
  "specs": [Spec],
  "subdomain": "abc123",
  "subscriptions": [PaidSubscription],
  "users": [User],
  "website": "xyz789"
}

CompanySettings

Fields
Field Name Description
allowedDocTypes - [DocumentType]
allowedUserRoles - [Role]
buildScheduleScheme - String
changeOrderTemplateMapping - ChangeOrderTemplateMapping
configurations - Configurations
customFields - CustomFields
customUomLabels - [String]
defaultBlacklistedRevisions - [BlacklistedRevision]
defaultCurrency - Currency
displayRefDesAndItemNumber - Boolean
ecoAcceptOpen - Boolean
ecoDefaultApproval - EcoDefaultApproval
erpItemTypeOptions - [ErpItemType]
fileStorageLimit - Float
isAllowedBlankItemNumber - Boolean
isApplicabilityFieldEnabled - Boolean
isBuildEnabled - Boolean
isDcoEnabled - Boolean
isEcadGeneralSpecsEnabled - Boolean
isFirstResonanceEnabled - Boolean
isNexusEnabled - Boolean
isNotRevisionManaged - Boolean
isPrimarySourceWarningDisabledInCO - Boolean
isSSOEnabled - Boolean
isSerializationEnabled - Boolean
isSpecValidationEnabled - Boolean
isValispaceEnabled - Boolean
massPrecisionValue - Float
massUnit - MassUnitType
maxFileSize - Int
shouldAutoSelectRolledUpCost - Boolean
shouldUseCpnRevFileNameFormat - Boolean
unitPricePrecision - Int
Example
{
  "allowedDocTypes": ["ACCEPTANCE_DATA"],
  "allowedUserRoles": ["ADMINISTRATOR"],
  "buildScheduleScheme": "abc123",
  "changeOrderTemplateMapping": ChangeOrderTemplateMapping,
  "configurations": Configurations,
  "customFields": CustomFields,
  "customUomLabels": ["abc123"],
  "defaultBlacklistedRevisions": ["I"],
  "defaultCurrency": "AUD",
  "displayRefDesAndItemNumber": true,
  "ecoAcceptOpen": false,
  "ecoDefaultApproval": "FIRST_IN",
  "erpItemTypeOptions": ["LOT_TRACKED"],
  "fileStorageLimit": 987.65,
  "isAllowedBlankItemNumber": false,
  "isApplicabilityFieldEnabled": true,
  "isBuildEnabled": false,
  "isDcoEnabled": true,
  "isEcadGeneralSpecsEnabled": true,
  "isFirstResonanceEnabled": false,
  "isNexusEnabled": true,
  "isNotRevisionManaged": false,
  "isPrimarySourceWarningDisabledInCO": false,
  "isSSOEnabled": true,
  "isSerializationEnabled": true,
  "isSpecValidationEnabled": false,
  "isValispaceEnabled": true,
  "massPrecision