Request

Response

    Update Property Definition Collection

    This topic provides instructions on how to update the property definition collection.

    You will use the following query in this topic:

    TypeOperationDescription
    mutation updatePropertyDefinitionCollection Updates a Property Definition Collection.

    Step 1 - Update Property Definition Collection

    The following steps demonstrate how you can run the updatePropertyDefinitionCollection query to update the property definition collection. For example, we will be updating the description of a property collection.

    1. Enter the following query in the Query Pane of the Manufacturing Data Model Explorer.

      Query

      mutation UpdatePropertyDefinitionCollection($propertyDefinitionCollectionId: ID!, $description: String!) {
            updatePropertyDefinitionCollection(
                input: {propertyDefinitionCollectionId: $propertyDefinitionCollectionId, description: $description}
            ) {
                propertyDefinitionCollection {
                    id
                    name
                    description
                }
            }
        }
      
      Show More
    2. In the Query Variables Pane, enter the propertyDefinitionCollectionId and description for which the description needs to be updated. To know how to obtain the propertyDefinitionCollectionId, refer to Create Property Definition Collection topic.

      Query Variables

      {
        "propertyDefinitionCollectionId": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5ET0NTX1BST1BfREVGX0NPTExFQ1RJT04",
        "description": "updated description"
      }
      

    1. Click Play. The response will display the updated description of a property definition collection.

      Response

      {
        "data": {
            "updatePropertyDefinitionCollection": {
                "propertyDefinitionCollection": {
                    "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5ET0NTX1BST1BfREVGX0NPTExFQ1RJT04",
                    "name": "DOCS_PROP_DEF_COLLECTION",
                    "description": "updated description"
                }
            }
        }
      }
      
      Show More