CreateProperty - Elastic Desktop Service - Alibaba Cloud Documentation Center

Creates a user property.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PropertyKey	string	Yes	The property name.	department
PropertyValues	array	No	The values of the property. You can specify up to 50 values for a property.
	string	No	The value of the property.	HR

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CreateResult	object	The result of creating the property.
PropertyId	long	The ID of the property.	390
PropertyKey	string	The name of the property.	department
SavePropertyValueModel	object	The result of creating the property value.
SavePropertyValues	object []	Details of the property values that were created.
PropertyValueId	long	The ID of the property value.	978
PropertyValue	string	The value of the property.	HR
FailedPropertyValues	object []	The property values that failed to be created.
PropertyId	long	The ID of the property value.	390
PropertyValue	string	The value of the property.	HR
ErrorCode	string	The error code.	ExistedPropertyValue
ErrorMessage	string	The error message.	The property value is used by another property.

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "CreateResult": {
    "PropertyId": 390,
    "PropertyKey": "department",
    "SavePropertyValueModel": {
      "SavePropertyValues": [
        {
          "PropertyValueId": 978,
          "PropertyValue": "HR"
        }
      ],
      "FailedPropertyValues": [
        {
          "PropertyId": 390,
          "PropertyValue": "HR",
          "ErrorCode": "ExistedPropertyValue",
          "ErrorMessage": "The property value is used by another property."
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.