createPropertyDefinition
Creates 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 CreatePropertyDefinition($input: createPropertyDefinitionInput!){
createPropertyDefinition(input: $input) {
#CreatePropertyDefinition Fields
}
}
Template for Query Variables:
{
"input" : "<SOME-CREATEPROPERTYDEFINITION-INPUT-TYPE-SCALAR-VALUE>"
}
Arguments
input* createPropertyDefinitionInput non-null | The inputs needed to create a property definition. |
Possible Returns
Value Type | Description |
---|---|
CreatePropertyDefinitionPayload | Response of create property definition operation. |
Examples
Example 1
This mutation creates a new Property Definition of type DYNAMIC_AT_VERSION and return the newly created property definition.
Query:
mutation CreateDynamicAtVersionPropertyDefinition($input: CreatePropertyDefinitionInput!) {
createPropertyDefinition(input: $input) {
propertyDefinition {
id
name
specification
isHidden
isReadOnly
shouldCopy
isArchived
description
propertyBehavior
units {
id
name
}
}
}
}
Query Variables:
{
"input": {
"propertyDefinitionCollectionId": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcyNTg4MDczNDY5NQ",
"name": "material length",
"specification": "FLOAT",
"description": "description",
"propertyBehavior": "DYNAMIC_AT_VERSION",
"shouldCopy": true
}
}
Response:
{
"data": {
"createPropertyDefinition": {
"propertyDefinition": {
"id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcyNTg4MDczNDY5NX5wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjI1ZmYyYzc0OWRmNTRjZTFiMTEwODA3ODk2YmEyMzM2LTEuMC4w",
"name": "material length",
"specification": "FLOAT",
"isHidden": false,
"isReadOnly": false,
"shouldCopy": true,
"isArchived": false,
"description": "description",
"propertyBehavior": "DYNAMIC_AT_VERSION",
"units": null
}
}
}
}
Example 2
This mutation creates a new Property Definition of type DYNAMIC and return the newly created property definition.
Query:
mutation CreateDynamicPropertyDefinition($input: CreatePropertyDefinitionInput!) {
createPropertyDefinition(input: $input) {
propertyDefinition {
id
name
specification
isHidden
isReadOnly
shouldCopy
isArchived
description
propertyBehavior
units {
id
name
}
}
}
}
Query Variables:
{
"input": {
"propertyDefinitionCollectionId": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcyNTg4MDczNDY5NQ",
"name": "supplier cost",
"specification": "INTEGER",
"description": "description",
"propertyBehavior": "DYNAMIC",
"shouldCopy": true
}
}
Response:
{
"data": {
"createPropertyDefinition": {
"propertyDefinition": {
"id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcyNTg4MDczNDY5NX5wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOmI1Y2E4NTQ0Y2U5MzRhNTRiMDczMjgzZTJkMzgwNjAzLTEuMC4w",
"name": "supplier cost",
"specification": "INTEGER",
"isHidden": false,
"isReadOnly": false,
"shouldCopy": true,
"isArchived": false,
"description": "description",
"propertyBehavior": "DYNAMIC",
"units": null
}
}
}
}
Example 3
This mutation creates a new Property Definition of type STANDARD and return the newly created property definition.
Query:
mutation CreateStandardPropertyDefinition($input: CreatePropertyDefinitionInput!) {
createPropertyDefinition(input: $input) {
propertyDefinition {
id
name
specification
isHidden
isReadOnly
shouldCopy
isArchived
description
propertyBehavior
units {
id
name
}
}
}
}
Query Variables:
{
"input": {
"propertyDefinitionCollectionId": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcyNTg4MDczNDY5NQ",
"name": "Surface Texture",
"specification": "STRING",
"description": "description",
"propertyBehavior": "STANDARD",
"shouldCopy": true
}
}
Response:
{
"data": {
"createPropertyDefinition": {
"propertyDefinition": {
"id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcyNTg4MDczNDY5NX5wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjkzMmY2YzRmZTVkZTRiZDA5ZmMzZTRiYjljYzFiM2JiLTEuMC4w",
"name": "Surface Texture",
"specification": "STRING",
"isHidden": false,
"isReadOnly": false,
"shouldCopy": true,
"isArchived": false,
"description": "description",
"propertyBehavior": "STANDARD",
"units": null
}
}
}
}
Example 4
This mutation creates a new Property Definition of type TIMELESS and returns the newly created property definition.
Query:
mutation CreateTimelessPropertyDefinition($input: CreatePropertyDefinitionInput!) {
createPropertyDefinition(input: $input) {
propertyDefinition {
id
name
specification
isHidden
isReadOnly
shouldCopy
isArchived
description
propertyBehavior
units {
id
name
}
}
}
}
Query Variables:
{
"input": {
"propertyDefinitionCollectionId": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcyNTg4MDczNDY5NQ",
"name": "ERP ID",
"specification": "STRING",
"description": "description",
"propertyBehavior": "TIMELESS",
"shouldCopy": true
}
}
Response:
{
"data": {
"createPropertyDefinition": {
"propertyDefinition": {
"id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcyNTg4MDczNDY5NX5wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOmQ1MTI2YjAzMTA0OTRiYmQ5OGUyZmZhNThhNWQ2ZGIzLTEuMC4w",
"name": "ERP ID",
"specification": "STRING",
"isHidden": false,
"isReadOnly": false,
"shouldCopy": true,
"isArchived": false,
"description": "description",
"propertyBehavior": "TIMELESS",
"units": null
}
}
}
}