topic Re: QRS API - updating users custom properties in Integration, Extension & APIs

QRS API - updating users custom properties

cesaraccardi — Mon, 07 Mar 2016 12:44:14 GMT

Hello,

I have defined a custom property "Department" and associated to apps/users for access control. I would like to automate the process of going to QMC and manually setting the "Department" values for each user. I believe this should be possible using QRS API but as I don't have much experience with the API am not sure how to do this.

I am using Postman and managed to retrieve the details of a given user as well as the custom properties associated:

Request

GET /qrs/user/2e04436f-a71a-45c5-999c-793a00ba6a77/?Xrfkey=ABCDEFG123456789 HTTP/1.1

Host: myserver

X-Qlik-Xrfkey: ABCDEFG123456789

Response

In this case User 1 is associated to Finance and Sales, now let's say I wanted to move it to Executive and Sales. Can I just update the value of "Finance" to "Executive"? I have tried sending a PUT request like below but it doesn't work (it gives a 409 Conflict error message). Does anybody know why?

PUT /qrs/user/2e04436f-a71a-45c5-999c-793a00ba6a77?Xrfkey=ABCDEFG123456789 HTTP/1.1

Host: myserver

X-Qlik-Xrfkey: ABCDEFG123456789

Content-Type: application/json

{

"id": "2e04436f-a71a-45c5-999c-793a00ba6a77",

"customProperties": [

{

"id": "fb5e68ec-d382-4bd1-b9f3-81c5a5f1b3e1",

"value": "Executive"

}

]

}

Thanks in advance,

Cesar

Re: QRS API - updating users custom properties

Mon, 07 Mar 2016 15:12:23 GMT

Hi Cesar,

As you noticed, I had the same kind of issue with updates => 409 Conflict.

I could solve it by sending the modifiedDate in the PUT body message to the actual date and hour.

The format of the is not important YYY-MM_DD HH:MM:SS is good enought.

This might not be the only step to make it work, for other similar request, I then received 400 Bad Request due to invalid body content, I am still on it, each body structure depends on the object type, sending same structure as received with the GET method is not working in every case ...

Ghislain

Re: QRS API - updating users custom properties

cesaraccardi — Mon, 07 Mar 2016 16:29:36 GMT

Thanks for the reply Ghislain,

I will try adding the modifiedDate as you suggested and will come back later with the results.

Cesar

Re: QRS API - updating users custom properties

cesaraccardi — Tue, 08 Mar 2016 12:22:14 GMT

Hi,

I managed to get the update property working, in order to do this I have copied the JSON response of the GET user and changed the fields highlighted in green:

So looks like in this case we need to provide the actual date and time to both the modifiedDate of the User as well as the property that is being changed.

I am not going to close this thread yet because I want to test add/removing properties as well.

Cesar

Re: QRS API - updating users custom properties

cesaraccardi — Tue, 08 Mar 2016 14:13:15 GMT

I managed to add/remove properties as well, the process is similar to updating. As long as the ModifiedDate is changed to an actual date and time it works fine.

Re: QRS API - updating users custom properties

Thu, 10 Mar 2016 13:59:53 GMT

The way I understand how Qlik works is that it will use modifiedDate for detecting dirty write situations. So when updating an entity in Qlik, you should pass the existing modifiedDate that you can fetch with GET qrs/user/full

Re: QRS API - updating users custom properties

cesaraccardi — Thu, 10 Mar 2016 14:19:20 GMT

I noticed that the modifiedDate is replaced by a "system"date after the request is processed so you don't need to send the exact date and time obtained with GET qrs/user/full apparently.

Re: QRS API - updating users custom properties

Thu, 10 Mar 2016 14:36:34 GMT

Hmm interesting. Where is it replaced and by whom? By Qlik? We've been monitoring all JSON traffic and I'm pretty sure you need to pass the exact same modifiedDate that was in Qlik repository before update. I'm not sure about the precision of the date though, if you add a couple of seconds to modifiedDate in PUT (compared to existing modifiedDate) I always get 409 conflict error.

Re: QRS API - updating users custom properties

cesaraccardi — Thu, 10 Mar 2016 14:56:20 GMT

Basically what I am doing is sending a GET qrs/user/{id}, copying the JSON, changing the parameters I want to update and setting the modifiedDate to actual date time (doing this manually, with a precision of minutes). Example:

Request:

"modifiedDate": "2016-03-10T14:49:18.684Z"

Response - 200 OK:

"modifiedDate": "2016-03-10T14:50:09.281Z"

Re: QRS API - updating users custom properties

Fri, 11 Mar 2016 07:48:06 GMT

We actually contacted Qlik, and they can reproduce the 409 issue.

They updated the documentation on this:

https://help.qlik.com/en-US/sense-developer/2.2/Subsystems/RepositoryServiceAPI/Content/RepositoryServiceAPI/RepositoryS…

"Many JSON structs in the Qlik Sense Repository Service (QRS) API include the modifiedDate property, which is used to avoid conflicts in the repository database. For example, when updating an entity, leave the modifiedDate property unchanged. If the modifiedDate property for the updated entity differs from the modifiedDate property for the entity in the QRS, there is a conflict (that is, the entity in the QRS has already been updated by someone else)."

Re: QRS API - updating users custom properties

cesaraccardi — Fri, 11 Mar 2016 14:10:52 GMT

Thanks for sharing that Toni, I will start using the modifiedDate from QRS from now on.

Re: QRS API - updating users custom properties

Fri, 12 Aug 2016 02:49:44 GMT

Hello Cesar,

I have been wrestling with the same problem for days. Your approach gave me great hints!

I think basically if we need to do any POST requests with QRS API, we need the modifiedDate field in the data model.

Thanks a lot!

Mengyi

Re: QRS API - updating users custom properties

cesaraccardi — Fri, 12 Aug 2016 08:00:24 GMT

Hi Yuan,

I am glad to see that this post has proven to be helpful to you, wish you luck on your implementation!

Cheers,

Cesar

Re: QRS API - updating users custom properties

mbj — Sun, 10 Sep 2017 13:03:12 GMT

hey guys, great discussion.

I created a little example to help others

```

createCustomProperty('testBies', [1, 2]);

export function createCustomProperty(name, choiceValues = ['no values initialized']) {

var customProperty = {

"name": name,

"valueType": "Text",

"objectTypes": ["App", "ContentLibrary", "DataConnection", "ReloadTask", "Stream", "User"],

"choiceValues": choiceValues

}

var result = qrs.post('/qrs/CustomPropertyDefinition', null, customProperty)

console.log('result of create custom property: ', result)

result.name = 'UpdatedName';

var result = qrs.put('/qrs/CustomPropertyDefinition/' + result.id, null, result)

console.log('result after update', result)

}

```

PS: You can find a lot of API documentation in the slide generator on http://integration.qlik.com/slides

Re: QRS API - updating users custom properties

Anonymous — Tue, 24 Apr 2018 12:59:45 GMT

Hey Cesar,

Can we fetch User wise assigned custom properties from Qliksense Server using QRS API?

You can look into this which I have posted:

Custom Properties for Users using QRS API's

Pls Suggest.

Regards,

Balraj Ahlawat

Re: QRS API - updating users custom properties

bekahbeets — Thu, 13 Dec 2018 21:32:39 GMT

I am getting either a 409 or a 400 exception when I run the following PUT command. I mainly get a "Received error code: 400::The "GetAllByMany" operation failed" error.

What is weird is I get a response with the apps data when I comment out the customProperties attribute. When i add in the customproperties attribute and json, i get the error.

Put('/app/' + appId,
{

"modifiedDate": lastModifiedDate, 
"modifiedByUserName": "instance////un",
"customProperties": [
{
"modifiedDate": lastModifiedDate,
"modifiedByUserName":  "instance////un",
"value": 'Node C'
}
] 
},
'json'