/api/space/user-management/user-preference-states

The following operations are supported on this resource:

  • GET - This API is used to get user preferences
  • POST - This API is used to update user DomainFullAccessMode
GET /user-preference-states Version 3

This API is used to get user preferences.

Sample Usage

GET /user-preference-states?state-name=<state-name>&is-decode=<is-decode>


  • Parameters:
    Name Type URI Type Description Required
    state-name String Query State Name Y
    is-decode Boolean Query Is Decode N
  • Sample Output XML:
    <user-preference-state-response uri="/api/space/user-management/user-preference-states">
         <id>Integer</id>
         <state-name>String</state-name>
         <state-value>String</state-value>
    </user-preference-state-response>

  • Sample Output JSON:
    {
      "update-user-preference-state-response": {
         "@uri":"/api/space/user-management/user-preference-states" ,
         "id": "Integer",
         "state-name": "String",
         "state-value": "String"
       }
    }

  • Access Control

    The following capabilities are required to access this API: DefaultRead

    POST /user-preference-states Version 3

    This API is used to update user DomainFullAccessMode.

    Sample Usage

    POST /user-preference-states


  • Sample Input XML:
    <update-user-preference-state>
         <user-preference-state>
               <state-name>String</state-name>
               <state-value>String</state-value>
         </user-preference-state>
         <is-encode>Boolean</is-encode>
    </update-user-preference-state>

  • Sample Output XML:
    <update-user-preference-state-response uri="/api/space/user-management/user-preference-states">
         <id>Integer</id>
         <state-name>String</state-name>
         <state-value>String</state-value>
    </update-user-preference-state-response>

  • Sample Input JSON:
    {
      "update-user-preference-state": {
         "user-preference-state": {
           "state-name": "String",
           "state-value": "String"
           },
         "is-encode": "Boolean"
       }
    }

  • Sample Output JSON:
    {
      "update-user-preference-state-response": {
         "@uri":"/api/space/user-management/user-preference-states" ,
         "id": "Integer",
         "state-name": "String",
         "state-value": "String"
       }
    }

  • Access Control

    The following capabilities are required to access this API: DefaultRead