perk
11 years agoAdept
What is restadmin?
We have these this line of code in our endpoints for zendesk integration:
<#assign username = restadmin("/settings/name/custom_zendesk.username").value />
What is restadmin? What does it contain?
We have these this line of code in our endpoints for zendesk integration:
<#assign username = restadmin("/settings/name/custom_zendesk.username").value />
What is restadmin? What does it contain?
Please keep in mind that the response for the list of settings is paginated, so you'll need to page through it using the "page" parameter. You can also adjust the "page_size" up to 1000 in order to get more results per page.
Regarding the custom setting value you mentioned, it will only show up for a user if it was configured as user setting. If instead it's a node (community, category, board, etc) setting, you will need to make the call for the proper node. For example:
/restapi/vc/settings?page_size=1000
Alright, I am able to retrieve http://[mycommunity]/restapi/vc/users/self/settings/name/custom_zendesk.username but how do I retrieve all the custom_zendesk values available?
Retrieving http://[mycommunity]/restapi/vc/users/self/settings/ doesn't show any custom_zendesk values. Neither does http://[mycommunity]/restapi/vc/users/self/settings/name
I tried on my lithium instance and I received the following error:
This XML file does not appear to have any style information associated with it.
The document tree is shown below.
<response status="error"><error code="501"><message>
Unknown path element at node 'community.users'.
</message></error></response>
Any help will be appreciated.
perk wrote:
When i am making this request:
http://community.lithium.com/community-name/restapi/vc/users/id/[id]/settings
I am getting:
error 404: this page could not be found
If you believe you are seeing this message in error, please contact communityhelp@lithium.com
and note this message and page URL.
How should I access this page?
It's just an example of the call structure. You need to substitute your community values for the domain and ID, then append the rest to it. E.g.: http://yourcommunity.com/restapi/vc/users/user_ID_goes_here/settings
When i am making this request:
http://community.lithium.com/community-name/restapi/vc/users/id/[id]/settings
I am getting:
error 404: this page could not be found
If you believe you are seeing this message in error, please contact communityhelp@lithium.com
and note this message and page URL.
How should I access this page?
perk wrote:
Thanks! How may I know what other variables exist in /settings/name/ ? Is there a list I can access somewhere?
You can use the user settings call to get a list of potential options. Please note the call from your example is a custom field, but those should show up in the list as well.
perk wrote:
Thanks! Is there a way to see all the possible values I can retrieve in
this restadmin object?
It's just about anything, but a note of caution to be very careful when using restadmin. It's basically making calls as an administrator, so you can easily expose unwanted information to users if not careful. Wjhen you want to make the cal as a normal use, use "rest".