Request

Response

    Mutations

    bulkRemoveComponentFromBOM

    mutation

    Removes components from BOM structure in bulk under specified parent components.

    Template for Mutation:

    mutation BulkRemoveComponentFromBOM($input: [BulkRemoveComponentFromBOMInput!]!){
      bulkRemoveComponentFromBOM(input: $input) {
        # BulkRemoveComponentFromBOMPayload Fields
      }
    }
    

    Arguments

    input*Input array for removing multiple components from BOM.
    * Required

    Possible Returns

    Value TypeDescription
    BulkRemoveComponentFromBOMPayload Return payload for bulk remove component from BOM operation.


    Examples

    Example 1

    RFTP: Excludes Child1 and Child2 from the RFTP Parent BOM in a single bulk request. Each item uses inputKey to map responses. Returns status REMOVED or EXCLUDED per child.

    Query:

     mutation BulkRemoveComponentFromBOM($input: [BulkRemoveComponentFromBOMInput!]!) {
     bulkRemoveComponentFromBOM(input: $input) {
       results {
         inputKey
         status
         error {
           code
           message
         }
       }
     }
    }
    
    Show More

    Query Variables:

    {
     "input": [
       {
         "parentComponentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35DUG1iYzFQbVdMakpKazNwbjdyYXVVX2FnYQ",
         "childComponentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35YelJGd05LZE9NTGcxZHl6SEJqSzlOX2FnYQ",
         "inputKey": "child1"
       },
       {
         "parentComponentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35DUG1iYzFQbVdMakpKazNwbjdyYXVVX2FnYQ",
         "childComponentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ345aHU1TVRZdXRaOHNsNHRTTlBORlZWX2FnYQ",
         "inputKey": "child2"
       }
     ]
    }
    
    Show More

    Response:

    {
       "data": {
           "bulkRemoveComponentFromBOM": {
               "results": [
                   {
                       "inputKey": "child1",
                       "status": "EXCLUDED",
                       "error": null
                   },
                   {
                       "inputKey": "child2",
                       "status": null,
                       "error": {
                           "code": "BAD_REQUEST",
                           "message": "Cannot remove a reference-only component from the BOM."
                       }
                   }
               ]
           }
       }
    }
    
    Show More