Request

Response

    Mutations

    createPropertyDefinitionCollection

    mutation

    Creates 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 Mutation:

    mutation CreatePropertyDefinitionCollection($input: createPropertyDefinitionCollectionInput){
      createPropertyDefinitionCollection(input: $input) {
        # CreatePropertyDefinitionCollectionPayload Fields
      }
    }
    

    Arguments

    inputThe inputs needed to create a property definition collection.

    Possible Returns

    Value TypeDescription
    CreatePropertyDefinitionCollectionPayload Return payload on property definition collection creation.


    Examples

    Example 1

    Create a Property Definition Collection.

    Query:

     mutation CreatePropertyDefinitionCollection($propDefCollectionName: String!, $description: String) {
           createPropertyDefinitionCollection(
               input: { name: $propDefCollectionName, description: $description }
           ) {
               propertyDefinitionCollection {
                   id
                   name
                   description
               }
           }
    }
    
    Show More

    Query Variables:

    {
       "propDefCollectionName": "prop_def_col_1793373325467",
       "description": "Property definition collection description"
    }
    

    Response:

    {
       "data": {
           "createPropertyDefinitionCollection": {
               "propertyDefinitionCollection": {
                   "id": "cHJvcGRlZmNvbH5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5wcm9wX2RlZl9jb2xfMTc5MzM3MzMyNTQ2Nw",
                   "name": "prop_def_col_1793373325467",
                   "description": "Property definition collection description"
               }
           }
       }
    }
    
    Show More