API to update group parameter

Help and How-To

Hi Experts

I wonder if there is any API that i can use to create/update group parameters in sisense?

ramansingh89

Posted 2 years ago·Last reply 2 years ago

10 comments

DRay

·2 years ago

Hello ramansingh89 ,

I wanted to follow up to see if the solution offered by JeremyFriedel worked for you.

If so, please click the 'Accept as Solution' button so that other users with the same questions can find the answer faster. If not, please let us know so that we can continue to help.

Thank you.

DRay

·2 years ago

Hello ramansingh89,

Thank you for your question. Can you let us know specifically what parameters you are wanting to update?

Thank you.

ramansingh89

OP2 years ago

Hi DRay so we have setup this user parameter and would like to find out if there is an API I can use to programmatically update the group values of that parameter?

DRay

·2 years ago

Hi ramansingh89,

I'm not clear on what you mean by 'update the group values of that parameter", but I can point you to our API documentation. We have a couple of endpoints for groups, https://sisense.dev/guides/restApi/v0/?platform=linux&spec=L2023.11#/groups and https://sisense.dev/guides/restApi/v1/?platform=linux&spec=L2023.11#/groups

Please review those and let us know if there is any more information you need.'

Thank you.

ramansingh89

OP2 years ago

Hi DRay

I have added a screenshot below. We have a parameter called DWS_NAME and I would like to understand if there is any API I can use to add groups to this parameter. Eg: I want to add group "Client A" and its value should be "XXY"

DRay

·2 years ago

Hi ramansingh89,

Thank you for the clarification. Can you look at this endpoint and let us know if that's what you're looking for? https://sisense.dev/guides/restApi/v1/?platform=linux&spec=L2023.11#/parameters/createUserParameter

ramansingh89

OP2 years ago

Hi DRay

I wonder what should be the value in API response. This is the example I see on the API docs

[
{
"op": "update",
"path": "/users/61f16367832227001b55e9eb",
"value": {
"value": "administrator",
"priority": 5
}
}
]

I wonder what should be value under these keys: op, path, priority

Jeremy Friedel

·2 years ago

Hi @ramansingh89,

The parameters shown in the documentation are contextId, contextType, value and priority:

  <span class="">"contextId"</span><span>: </span><span>"5f02edfab456d2002c1b29dc"</span><span>,</span>      <span class="">"contextType"</span><span>: </span><span>"users"</span><span>,</span>      <span class="">"value"</span><span>: </span><span>"user.email@sisense.com"</span><span>,</span>      <span class="">"priority"</span><span>: </span><span>0</span>

The path value does not occur in this specific documentation.

The contextType is set to either "users" or "groups"

Value is a email.

Priority is in integer, starting at 0.