Request

Response

    Mutations

    updateComponentDescription

    mutation

    Updates the description of a component.

    Template for Mutation:

    mutation UpdateComponentDescription($input: updateComponentDescriptionInput!){
      updateComponentDescription(input: $input) {
        # Component Fields
      }
    }
    

    Arguments

    input*Input object for updating the component description.
    * Required

    Possible Returns

    Value TypeDescription
    Component An object representing an item in the bill of materials (BOM). It can be a part, an assembly, a sub-assembly or an end product which is the very top-level with no parent above it.


    Examples

    Example 1

    Updated the component description.

    Query:

     mutation UpdateComponentDescription($input: UpdateComponentDescriptionInput!){
     updateComponentDescription(input: $input) {
       id
       description{
           name
           value
       }
     }
    }
    
    Show More

    Query Variables:

    {
     "input" : {
       "componentId":"cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
       "description":"Cup component"
     }
    }
    

    Response:

    {
       "data": {
           "updateComponentDescription": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
               "description": {
                   "name": "description",
                   "value": "Cup component"
               }
           }
       }
    }
    
    Show More