Request

Response

    Mutations

    setProperties

    mutation

    Sets properties of a given target.

    Note: This bulk mutation has a max input size limit of 30.

    Template for Query:

    mutation SetProperties($input: setPropertiesInput!){
      setProperties(input: $input) {
        #SetProperties Fields
      }
    }
    

    Arguments

    input*The inputs needed to set a property.
    * Required

    Possible Returns

    Value TypeDescription
    SetPropertiesPayload Return payload on set properties operation.


    Examples

    Example 1

    This mutation updates the values of Properties on the given Extendable that share the same PropertyDefinition.

    Query:

     mutation SetStandardProperties($input: SetPropertiesInput!) {
           setProperties(input: $input) {
               targetId
               properties {
                   value
                   displayValue
                   definition {
                       id
                       name
                       specification
                       isHidden
                       isReadOnly
                       isArchived
                       description
                       propertyBehavior
                       units {
                           id
                           name
                       }
                   }
               }
           }
    }
    
    Show More

    Query Variables:

    {
       "input": {
           "targetId" : "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ34zMlBTQ2daMXJLY2V3SHlCN1dkbEZyX2FnYX4wSFZNa3lRZVlrd3p0TFZheUF6S0dp",
           "propertyInputs": [
               {
                   "propertyDefinitionId" : "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOmFkNzkzNTI0ZWNkZDQ2MzE5Zjc3NzZjM2YwN2I1Y2IwLTEuMC4w",
                   "value": "Green"
               }
           ]
       }
    }
    
    Show More

    Response:

    {
       "data": {
           "setProperties": {
               "targetId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ34zMlBTQ2daMXJLY2V3SHlCN1dkbEZyX2FnYX5hTVVYdUlRYk5VaWlDdWp5aUR4Vk1o",
               "properties": [
                   {
                       "value": "Green",
                       "displayValue": "Green",
                       "definition": {
                           "id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOmFkNzkzNTI0ZWNkZDQ2MzE5Zjc3NzZjM2YwN2I1Y2IwLTEuMC4w",
                           "name": "Surface Texture",
                           "specification": "STRING",
                           "isHidden": false,
                           "isReadOnly": false,
                           "isArchived": false,
                           "description": "description",
                           "propertyBehavior": "STANDARD",
                           "units": null
                       }
                   }
               ]
           }
       }
    }
    
    Show More

    Example 2

    This mutation updates values for the given PropertyDefinitions of ‘DYNAMIC’ and ‘DYNAMIC_AT_VERSION’ behavior on the given Extendable.

    Query:

     mutation SetDynamicProperties($input: SetPropertiesInput!) {
           setProperties(input: $input) {
               targetId
               properties {
                   value
                   displayValue
                   definition {
                       id
                       name
                       specification
                       isHidden
                       isReadOnly
                       isArchived
                       description
                       propertyBehavior
                       units {
                           id
                           name
                       }
                   }
               }
           }
    }
    
    Show More

    Query Variables:

    {
       "input": {
           "targetId" : "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35TcFFEOFlTdEZqNTN1SEY2R1RJTWFYX2FnYX45Y3BrZVFuNGZFdDhLbExkY1N0RHEz",
           "propertyInputs": [
               {
                   "propertyDefinitionId" : "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjUzNGU2MDI0OWEwZDRjYzBhZGQ5YWU2ZmIyZjY1NzlhLTEuMC4w",
                   "value": 10.12
               },
               {
                   "propertyDefinitionId" : "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjU4ODExNjVkYTFjYTQxYTZhZDEwZTRiY2MyZWNkOTU2LTEuMC4w",
                   "value": 10
               }
           ]
       }
    }
    
    Show More

    Response:

    {
       "data": {
           "setProperties": {
               "targetId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35TcFFEOFlTdEZqNTN1SEY2R1RJTWFYX2FnYX45Y3BrZVFuNGZFdDhLbExkY1N0RHEz",
               "properties": [
                   {
                       "value": 10.12,
                       "displayValue": "10.12",
                       "definition": {
                           "id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjUzNGU2MDI0OWEwZDRjYzBhZGQ5YWU2ZmIyZjY1NzlhLTEuMC4w",
                           "name": "material length",
                           "specification": "FLOAT",
                           "isHidden": false,
                           "isReadOnly": false,
                           "isArchived": false,
                           "description": "description",
                           "propertyBehavior": "DYNAMIC_AT_VERSION",
                           "units": null
                       }
                   },
                   {
                       "value": 10,
                       "displayValue": "10",
                       "definition": {
                           "id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjU4ODExNjVkYTFjYTQxYTZhZDEwZTRiY2MyZWNkOTU2LTEuMC4w",
                           "name": "supplier cost",
                           "specification": "INTEGER",
                           "isHidden": false,
                           "isReadOnly": false,
                           "isArchived": false,
                           "description": "description",
                           "propertyBehavior": "DYNAMIC",
                           "units": null
                       }
                   }
               ]
           }
       }
    }
    
    Show More

    Example 3

    This mutation updates values for the given PropertyDefinitions of ‘TIMELESS’ and ‘STANDARD’ behavior on the given componentId.

    Query:

     mutation SetTimelessProperties($input: SetPropertiesInput!) {
           setProperties(input: $input) {
               targetId
               properties {
                   value
               }
           }
    }
    
    Show More

    Query Variables:

    {
       "input": {
           "targetId" : "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35OWXU4a2duSVdtNGNnUVd3MmljMFl0X2FnYQ",
           "propertyInputs": [
               {
                   "propertyDefinitionId" : "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOmJiN2JlZDVkOTFhMTQxY2I5YmY0Nzc4OTA0MTMwYWVmLTEuMC4w",
                   "value": "10D123E001"
               }
           ]
       }
    }
    
    Show More

    Response:

    {
       "data": {
           "setProperties": {
               "targetId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35OWXU4a2duSVdtNGNnUVd3MmljMFl0X2FnYQ",
               "properties": [
                   {
                       "value": "10D123E001"
                   }
               ]
           }
       }
    }
    
    Show More

    Example 4

    This mutation clears values for the given PropertyDefinitions on the given targetIds.

    Query:

     mutation ClearProperties($input: SetPropertiesInput!) {
           setProperties(input: $input) {
               targetId
               properties {
                   value
               }
           }
    }
    
    Show More

    Query Variables:

    {
       "input": {
           "targetId" : "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35OWXU4a2duSVdtNGNnUVd3MmljMFl0X2FnYQ",
           "propertyInputs": [
               {
                   "propertyDefinitionId" : "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOmJiN2JlZDVkOTFhMTQxY2I5YmY0Nzc4OTA0MTMwYWVmLTEuMC4w",
                   "shouldClear": true
               }
           ]
       }
    }
    
    Show More

    Response:

    {
       "data": {
           "setProperties": {
               "targetId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35OWXU4a2duSVdtNGNnUVd3MmljMFl0X2FnYQ",
               "properties": [
                   {
                       "value": null
                   }
               ]
           }
       }
    }
    
    Show More