Mutations
archivePropertyDefinition
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 Mutation:
mutation ArchivePropertyDefinition($input: archivePropertyDefinitionInput!){
archivePropertyDefinition(input: $input) {
# ArchivePropertyDefinitionPayload Fields
}
}
Arguments
| input* archivePropertyDefinitionInput non-null | The inputs needed to archive a property definition. |
* Required
Possible Returns
| Value Type | Description |
|---|---|
| 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": "cHJvcGRlZn5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5wcm9wX2RlZl9jb2xfMTc2ODg4MjUxNzkxOH5wYXJhbWV0ZXJzLkFDTjRFdmRITE1UWml3N25ma0hVcFBqc0E0VmZaYW5UOmQzYjY3YTc3ZGVjZjQ0NDA5ZDNhMGM2MzJkOTZjYTc1LTEuMC4w"
}
Response:
{
"data": {
"archivePropertyDefinition": {
"propertyDefinition": {
"id": "cHJvcGRlZn5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5wcm9wX2RlZl9jb2xfMTc2ODg4MjUxNzkxOH5wYXJhbWV0ZXJzLkFDTjRFdmRITE1UWml3N25ma0hVcFBqc0E0VmZaYW5UOmQzYjY3YTc3ZGVjZjQ0NDA5ZDNhMGM2MzJkOTZjYTc1LTEuMC4w",
"name": "Background Color 1768882702196",
"specification": "STRING",
"isHidden": false,
"isReadOnly": false,
"isArchived": true,
"description": "bg color",
"propertyBehavior": "STANDARD",
"units": null
}
}
}
}
Show More