Request

Response

    Mutations

    createPropertyDefinitions

    mutation

    Creates multiple property definitions in 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. This bulk mutation has a max input limit of 30.

    Template for Query:

    mutation CreatePropertyDefinitions($input: createPropertyDefinitionsInput!){
      createPropertyDefinitions(input: $input) {
        #CreatePropertyDefinitions Fields
      }
    }
    

    Arguments

    input*The inputs needed to create property definitions.
    * Required

    Possible Returns

    Value TypeDescription
    CreatePropertyDefinitionsPayload Response of create property definitions operation.


    Examples

    Example 1

    This mutation creates property definitions based on the given inputs.

    Query:

     mutation CreatePropertyDefinitions($input: CreatePropertyDefinitionsInput!) {
           createPropertyDefinitions(input: $input) {
               propertyDefinitions {
                   id
                   name
                   propertyBehavior
                   specification
                   description
                   isHidden
                   isArchived
                   units {
                       id
                   }
               }
       }
    }
    
    Show More

    Query Variables:

    {
     "input": {
       "propertyDefinitionCollectionId": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5ET0NTX1BST1BfREVGX0NPTExFQ1RJT04",
       "propertyDefinitionsInput": [
           {
               "name": "Background Color 1725880757350",
               "specification": "STRING",
               "propertyBehavior": "STANDARD",
               "description": "bg color",
               "isHidden": false
           },
           {
               "name": "Border Color 1725880757350",
               "specification": "STRING",
               "propertyBehavior": "STANDARD",
               "description": "border color",
               "isReadOnly": false
           }
       ]
     }
    }
    
    Show More

    Response:

    {
       "data": {
           "createPropertyDefinitions": {
               "propertyDefinitions": [
                   {
                       "id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5ET0NTX1BST1BfREVGX0NPTExFQ1RJT05-cGFyYW1ldGVycy5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcjo5YjkwNjExNjBjZTI0NWVhODE0MTJjZmIzNDBkOGExMy0xLjAuMA",
                       "name": "Border Color 1725880757350",
                       "propertyBehavior": "STANDARD",
                       "specification": "STRING",
                       "description": "border color",
                       "isHidden": false,
                       "isArchived": false,
                       "units": null
                   },
                   {
                       "id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5ET0NTX1BST1BfREVGX0NPTExFQ1RJT05-cGFyYW1ldGVycy5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcjpjMTUwNTQ2ODlkZWM0Y2YzYWQ3OTg5OWQzYmE5MzFmMC0xLjAuMA",
                       "name": "Background Color 1725880757350",
                       "propertyBehavior": "STANDARD",
                       "specification": "STRING",
                       "description": "bg color",
                       "isHidden": false,
                       "isArchived": false,
                       "units": null
                   }
               ]
           }
       }
    }
    
    Show More