20 Replies Latest reply on Jul 15, 2016 6:39 AM by Bryce Gilhooly

POSTing documents with notifications suppressed

Bryce Gilhooly Apr 27, 2016 11:43 AM

We have a need to batch-update content in live production space, without (ideally) removing access to the space during the update. I scoured Jive REST API v3.14 → Document entity to try to find a way to suppress notifications and couldn't find anything.

I captured the JSON submitted when I publish a document (through a browser) and tick the 'minor edit' box and noted the following two properties were added to the request:

"moveNotifyStreams": false,

"minorEdit": true,

I tried adding those properties to the POST, but I'm still receiving notifications and emails (per my notification settings).

Any help would be fantastic!

Bryce.

Re: POSTing documents with notifications suppressed

jlevi Apr 27, 2016 11:54 AM (in response to Bryce Gilhooly)

Have you looked at Update a binary document using the API ? The query parameter is "minor" if you look at the Content Service in the API: https://developers.jivesoftware.com/api/v3/cloud/rest/ContentService.html

From the mentioned document: "Once you have the document ID you are ready to upload a new binary document version. Remember to put the document ID in the URL and add minor=true as a query parameter if you don't want notifications or activity stream updates to be generated."
1 person found this helpful
Like (1)

Actions
- Re: POSTing documents with notifications suppressed
  
  Bryce Gilhooly Apr 27, 2016 11:56 AM (in response to jlevi)
  
  That sounds like it will do the trick!
  
  I'll take a stab at that this afternoon and report back.
  
  Thanks for the advice, Joey!
  
  Like (1)
  
  Actions
  - Re: POSTing documents with notifications suppressed
    
    Bryce Gilhooly Apr 27, 2016 12:34 PM (in response to Bryce Gilhooly)
    
    Hey,
    
    So I did the PUT request with the endpoint: /api/core/v3/contents/175118?minor=true and still received a notification in both my Jive and outlook inboxes.
    
    For some additional context (in case this helps?), I'm doing a...
    GET request on the above content
    Converting the content from JSON
    Updating the document.content.text field with the new HTML
    Converting the whole document object back to JSON
    PUT to /api/core/v3/contents/175118?minor=true
    
    The PDF you shared (thanks!) is more directly geared towards suppressing notifications when the binary content 'attached' to the document is updated, rather than the document itself?
    
    Let me know,
    Bryce.
    
    Like (0)
    
    Actions
    - Re: POSTing documents with notifications suppressed
      
      jlevi Apr 27, 2016 12:51 PM (in response to Bryce Gilhooly)
      
      I shared that example because you were attempting to add a field to the JSON to suppress notifications whereas the minor update option is a query parameter to the contents service. Even if the content in question was a collaboration document, the "minor=true" query parameter should suppress notifications. Which version of Jive are you using?
      
      Like (0)
      
      Actions
      - Re: POSTing documents with notifications suppressed
        
        Bryce Gilhooly Apr 27, 2016 12:54 PM (in response to jlevi)
        
        We're on 7.0.2.0, hosted
        
        Jive REST Rest API v3.4 → Content service (hosted 7.x documentation) indicates it should work the same though
        
        Like (0)
        
        Actions
        
        Re: POSTing documents with notifications suppressed
        
        jlevi Apr 27, 2016 12:59 PM (in response to Bryce Gilhooly)
        
        Yeah, I was just looking at some old cases where it was broken in Jive 6. Just wanted to make sure. Is moderation turned on for the place you are altering?
        
        Like (0)
        
        Actions
        
        Re: POSTing documents with notifications suppressed
        
        Bryce Gilhooly Apr 27, 2016 1:00 PM (in response to jlevi)
        
        Nope, moderation is off (almost entirely) because it's an internal instance.
        
        Like (0)
        
        Actions
        
        Re: POSTing documents with notifications suppressed
        
        jlevi Apr 27, 2016 1:16 PM (in response to Bryce Gilhooly)
        
        Okay - since it should be working, it might be a bug in that version of Jive. Can you open a support case and ask if this is a known issue for 7.0.2.0?
        
        Like (1)
        
        Actions
        
        Re: POSTing documents with notifications suppressed
        
        Bryce Gilhooly Apr 27, 2016 1:59 PM (in response to jlevi)
        
        Will do.
        
        Appreciate your help looking into this with me
        
        Bryce.
        
        Like (0)
        
        Actions
        
        Re: POSTing documents with notifications suppressed
        
        Bryce Gilhooly May 3, 2016 10:52 AM (in response to Bryce Gilhooly)
        
        Hey Joey ,
        
        It was a bug in 7, resolved in 8.
        
        Thanks again,
        Bryce.
        
        Like (0)
        
        Actions
- Re: POSTing documents with notifications suppressed
  
  Bryce Gilhooly Apr 27, 2016 12:03 PM (in response to jlevi)
  
  Also, where https://community.jivesoftware.com/docs/DOC-148779 is?
  
  I hit an unauth page when I tried to view it.
  
  Thanks again,
  Bryce.
  
  Like (0)
  
  Actions
  - Re: POSTing documents with notifications suppressed
    
    jlevi Apr 27, 2016 12:10 PM (in response to Bryce Gilhooly)
    
    Sorry about that. It was in a secret group. I have made it available in the Developer space here: Uploading a Binary Document Using the REST API
    1 person found this helpful
    
    Like (2)
    
    Actions
Re: POSTing documents with notifications suppressed

mcollinge Apr 28, 2016 2:02 AM (in response to Bryce Gilhooly)

We're working with Jive 8.0.2.0 and have done exactly that. There are 2 parts to tackling this..

Content Creation

You'll need to pass in published and updated parameters into the query string (not the body options), backdated to a certain date+time. This option needs to be run with an account that has admin rights to the whole site. I think this option was introduced in Jive 8.. but I'm not 100% sure on that (it certainly wasn't in Jive 6).

E.g. (you'll need to add updated as well)

Content Updates

You'll need to add minor=true to the query string to suppress the update notification. This option was available in Jive 6 upwards.

3 people found this helpful
Like (2)

Actions
- Re: POSTing documents with notifications suppressed
  
  Bryce Gilhooly Apr 28, 2016 8:21 AM (in response to mcollinge)
  
  Hey, Matt.
  
  First things first, thanks for the super detailed reply. Appreciate you taking the time to break that down for net-new and existing content
  
  I cut a case in our group to see if this is a known issue with 7.x instances per the suggestion that Joey made, but if I get time I'm going to test this out in our (soon to be official) cloud instance later today and report back.
  
  Thanks again,
  Bryce.
  
  Like (1)
  
  Actions
  - Re: POSTing documents with notifications suppressed
    
    Bryce Gilhooly Apr 28, 2016 10:24 AM (in response to Bryce Gilhooly)
    
    Adding the minor=true to the query and POSTing a new doc (on a cloud instance) resulted in a notification being created in my /inbox, but the notification was already read. I'm pretty sure this would not trigger an email notification, but I can't be 100% sure since we don't have the mailservers configured on that instance.
    
    I tried adding: ?published=2016-04-27T10:07:59.000Z&updated=2016-04-27T10:08:59.000Z to the end of the query when POSTing a new document and I did not receive a notification (read or unread).
    
    Kudos (again) for the flawless write-up on suppressing notifications on both existing and new content.
    
    Bryce.
    1 person found this helpful
    
    Like (1)
    
    Actions
    - Re: POSTing documents with notifications suppressed
      
      mcollinge Apr 29, 2016 1:15 AM (in response to Bryce Gilhooly)
      
      Not a problem; it's something we've just gone through for a batch process that was bugging the members of our site (element14.com), so the details were fresh in my mind One tool I'd recommend is Postman, which makes it super quick to check how an API call will work before you code it up.. it even helps generate the code you'd need in different formats.
      1 person found this helpful
      
      Like (1)
      
      Actions
      - Re: POSTing documents with notifications suppressed
        
        Bryce Gilhooly Apr 29, 2016 6:46 AM (in response to mcollinge)
        
        Postman has been super valuable for testing when something goes wrong in Windows PowerShell (my API tool of choice); almost as valuable as using element14.com when looking for best practices and good examples of established Jive communities (and fixing some Raspberry PI questions a while back ).
        
        Like (1)
        
        Actions
    - Re: POSTing documents with notifications suppressed
      
      james.dellow Jul 15, 2016 1:17 AM (in response to Bryce Gilhooly)
      
      Bryce Gilhooly we'll test this anyway, but just to clarify - was it the minor flag and the date or just the date that suppressed the notification? cc Joel Gralton
      
      Like (0)
      
      Actions
      - Re: POSTing documents with notifications suppressed
        
        mcollinge Jul 15, 2016 2:10 AM (in response to james.dellow)
        
        Use the minor flag to suppress notifications when you're updating content. And use the published date to suppress them when you create content.
        
        One thing you might want to consider is using the published / updated date to stop batch-published content from appearing in Recent Content widgets.. back-date it by something like a week (depending on your community activity level) so that it won't appear.
        1 person found this helpful
        
        Like (1)
        
        Actions
        
        Re: POSTing documents with notifications suppressed
        
        Bryce Gilhooly Jul 15, 2016 6:39 AM (in response to mcollinge)
        
        James Dellow
        
        Exactly what Matt Collinge said is how I approached the scenario.
        
        When I did my GET request on each document before the update, I took note of the latest update timestamp,converted it accordingly and included that on my update.
        
        Hope that helps,
        Bryce.
        
        Like (1)
        
        Actions