Custom Property: Update

LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

PUT

Path

/qrs/CustomPropertyDefinition/{id}

Description

Update a custom property.

To prevent conflicts when updating entities:

  1. Retrieve the entity that you want to update.

  2. Modify the specific properties that you want to change.
  3. Perform an update, including the entire entity in the body of the request.

You must always include the entity ID and modifiedDate when performing an update. The entity ID of the body and of the URL must match.

Body

{ "id": "4ddfbcb0-a41b-4906-9f6d-bb81297502e3", "createdDate": "2017-01-06T15:42:53.575Z", "modifiedDate": "2017-01-06T15:42:53.575Z", "modifiedByUserName": "INTERNAL\\sa_repository", "name": "Country", "valueType": "Text", "choiceValues": [ "Denmark", "Iceland", "Switzerland", "France" ], "objectTypes": [], "privileges": null, "impactSecurityAccess": false, "schemaPath": "CustomPropertyDefinition" }

Return value

{ "id": "4ddfbcb0-a41b-4906-9f6d-bb81297502e3" "createdDate": "2017-01-06T15:42:53.575Z", "modifiedDate": "2017-01-06T16:54:21.040Z", "modifiedByUserName": "INTERNAL\\sa_repository", "name": "Country", "valueType": "Text", "choiceValues": [ "Denmark", "Iceland", "Switzerland", "France" ], "objectTypes": [], "privileges": null, "impactSecurityAccess": false, "schemaPath": "CustomPropertyDefinition" }

Optional parameters

-

Did this information help you?

Can you tell us why it did not help you and how we can improve it?

Thanks for helping us improve!