PreferenceResource

The following resources are applicable:

GET /preference/scPreferenceRoot

Retrieves the value for the root node in Preference tree. This service does not take any input parameters from the Preference UI. It returns the string that should be displayed as the top node in Preference tree.

Response Codes

code condition
200 Returned if request was successfully executed.
500 Returned if request was NOT successfully executed.

Response Body

media type data type
application/vnd.ptc.sc+json object (JSON)

GET /preference/{categoryName}/{isMultilevel}

Get all the Preferences for a category. This service takes SCItem containing Internal Name of category from the Preference UI as attributes.

Request Parameters

name type description default
categoryName path String represents category name n/a
isMultilevel path boolean flag indicating tree traversal should be single level or multilevel n/a

Response Codes

code condition
200 Returned if preference were successfully retrieved..
500 Returned if preference were NOT successfully retrieved.

Response Body

media type data type
application/vnd.ptc.sc+json object (JSON)

POST /preference/{preferenceInternalName}

Update Preference Value This service takes SCItem containing Internal Name of category from the Preference UI as attributes.

Request Parameters

name type description default
preferenceInternalName path String represents Preference Internal Name name n/a

Request Body

media type data type description
application/vnd.ptc.sc+json SCItem (JSON) SCItem item containing value to be updated

Response Codes

code condition
200 Returned if preference were successfully updated..
500 Returned if preference were NOT successfully retrieved.

Response Body

media type data type
application/vnd.ptc.sc+json object (JSON)