Request

Response

    Mutations

    archivePropertyDefinition

    mutation

    Archives a property definition.

    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 ArchivePropertyDefinition($input: archivePropertyDefinitionInput!){
      archivePropertyDefinition(input: $input) {
        #ArchivePropertyDefinition Fields
      }
    }
    

    Arguments

    input*The inputs needed to archive a property definition.
    * Required

    Possible Returns

    Value TypeDescription
    ArchivePropertyDefinitionPayload Response of archive property definition operation.


    Examples

    Example 1

    This mutation archives a Property Definition based on it’s id and returns the archived property definition.

    Query:

     mutation ArchivePropertyDefinition($propertyDefinitionId: ID!) {
           archivePropertyDefinition(
               input: {propertyDefinitionId: $propertyDefinitionId}
           ) {
               propertyDefinition {
                   id
                   name
                   specification
                   isHidden
                   isReadOnly
                   isArchived
                   description
                   propertyBehavior
                   units {
                       id
                       name
                   }
               }
           }
    }
    
    Show More

    Query Variables:

    {
       "propertyDefinitionId": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5ET0NTX1BST1BfREVGX0NPTExFQ1RJT05-cGFyYW1ldGVycy5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcjoxYmZmNjY4Yzk4YTk0MmM1OGFhMzg3OTMwNzJkZDUyNy0xLjAuMA"
    }
    

    Response:

    {
       "data": {
           "archivePropertyDefinition": {
               "propertyDefinition": {
                   "id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5ET0NTX1BST1BfREVGX0NPTExFQ1RJT05-cGFyYW1ldGVycy5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcjoxYmZmNjY4Yzk4YTk0MmM1OGFhMzg3OTMwNzJkZDUyNy0xLjAuMA",
                   "name": "Border Color 1707377111732",
                   "specification": "STRING",
                   "isHidden": false,
                   "isReadOnly": false,
                   "isArchived": true,
                   "description": "border color",
                   "propertyBehavior": "STANDARD",
                   "units": null
               }
           }
       }
    }
    
    Show More