Request

Response

    Mutations

    updatePropertyDefinitionCollection

    mutation

    Updates a property definition collection.

    Note: You can authenticate using a two-legged token. To use a three-legged token, you must have ‘Owner’ or ‘Editor’ access to the APS App.

    Template for Query:

    mutation UpdatePropertyDefinitionCollection($input: updatePropertyDefinitionCollectionInput!){
      updatePropertyDefinitionCollection(input: $input) {
        #UpdatePropertyDefinitionCollection Fields
      }
    }
    

    Arguments

    input*The inputs needed to update a property definition collection.
    * Required

    Possible Returns

    Value TypeDescription
    UpdatePropertyDefinitionCollectionPayload Response of update property definition collection operation.


    Examples

    Example 1

    Update a Property Definition Collection.

    Query:

     mutation UpdatePropertyDefinitionCollection($propertyDefinitionCollectionId: ID!, $description: String!) {
           updatePropertyDefinitionCollection(
               input: {propertyDefinitionCollectionId: $propertyDefinitionCollectionId, description: $description}
           ) {
               propertyDefinitionCollection {
                   id
                   name
                   description
               }
           }
    }
    
    Show More

    Query Variables:

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

    Response:

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