December 15, 2021 5:04 am

We are making important changes to the Get Recent Updates APIs

After instituting API rate limits early this year to ensure server stability for all customers, we have noticed that certain APIs still place a greater load on the system than others, so we have decided to make some important updates to ensure quality service for everyone.

We will remove the array of notified users from the Get Recent Updates APIs on February 9, 2022.

Below, we will explain more about what to expect and what you, the customer, may need to do to.

Summary

 

Target APIs

We will remove the contents of the “notification” array from the responses of the following APIs:

  1. Get Recent Updates: This API returns the space’s recent updates.
    1. https://developer.nulab.com/docs/backlog/api/2/get-recent-updates/#
  2. Get Project Recent Updates: This API returns the project’s recent updates.
    1. https://developer.nulab.com/ja/docs/backlog/api/2/get-user-recent-updates/#
  3. Get User Recent Updates: This API returns the user’s recent updates.
    1. https://developer.nulab.com/docs/backlog/api/2/get-user-recent-updates/#

 

Target items

In the case of adding an issue, the contents of the “notifications” are currently the users who have been mentioned or notified. This will be modified to return an empty array.

 

API response before the contents of the “notifications” are removed

[ 
    { 
        "id": 3153,
        "project": {...}, 
        "type": 2, 
        "content": {...}, 
       "notifications": [ 
            { 
                "id": 25, 
                "alreadyRead": false, 
                "reason": 2, 
                "user": { 
                    "id": 5686, 
                    "userId": "takada", 
                    "name": "takada", 
                    "roleType": 2, 
                    "lang": "ja", 
                    "mailAddress": "takada@nulab.example" 
                },
                "resourceAlreadyRead":false 
            }, 
            ...
        ],
        "createdUser": {...}, 
        "created": "2013-12-27T07:50:44Z"
    },
    ... 
] 

 

API response after the contents of the “notifications” are removed

[ 
    { 
        "id": 3153,
        "project": {...}, 
        "type": 2, 
        "content": {...}, 
       "notifications": [],
        "createdUser": {...}, 
        "created": "2013-12-27T07:50:44Z"
    },
    ... 
] 

 

Customer actions required

If you are using any of the target APIs and you are using the contents of the “notifications” array, you will need to take action.

If you are using any of the target APIs but you are not using the contents of the “notifications” array, you do not need to take action. (There is no error in parsing the response when you call the API from your application.)

Get the “notifications”

You can get the “notifications” using the Activity API.

  1. Get the recent updates from the target APIs above.
  2. Get the "id" of the recent updates for which you want to get "notifications". In the example below, it is 3153.
[ 
    { 
        "id": 3153,
        "project": {...}, 
        "type": 2, 
        "content": {...}, 
        "notifications": [], 
        "createdUser": {...}, 
        "created": "2013-12-27T07:50:44Z"
    },
    ... 
] 
  1. Send a request to the Activity API using the "id" obtained in step 2.
  2. You can get the "notifications" from the response.
{
   "id": 3153,
    "project": {...}, 
    "type": 2, 
    "content": {...}, 
    "notifications": [
        {
            "id": 25,
            "alreadyRead": false,
            "reason": 2,
            "user": {
                "id": 25,
                "userId": "admin",
                "name": "admin",
                "roleType": 1,
                "lang": "ja",
                "mailAddress": "eguchi@nulab.example"
            }
        }
    ],
    "createdUser": {...}, 
    "created": "2013-12-27T07:50:44Z"
}

You may reach the API rate limit if you send requests to the activity details API for all the updates retrieved by the target API.

Please use the activity details API only for activities that require "notifications" items.

Thank you for helping us create a stable Backlog

We apologize for any inconvenience and appreciate your understanding and cooperation as we work to create a stable product and user experience for everyone.

If you have any questions or feedback, please contact us.

Back to list