NAV

API Notices for Release 1.24

Change to the “Next” link in some APIs

We made a change that affects the Next link in some api/v2/ endpoints. If there is code that relies on having unencoded values in the “Next” parameter, then it’ll need to be decoded.

Note: Some tools will encode the query string parameters for you automatically, and each in different ways. The values shown below for requests show the unencoded as well as an example encoded value to indicate the difference between this. That means if you try to test the following, you may get different results depending on which tool you are using to make the request and how that tool is doing encoding internally.

An example of a case unaffected by the change:

Example 1

Encoded request:

https://test.helmconnect.com/api/v2/public/locations?$filter=Name%20eq%20'Helm%20%20%20Operations'

Unencoded request:

https://test.helmconnect.com/api/v2/public/locations?$filter=Name eq 'Helm   Operations'

Returned response with Next link in 1.23:

Data": {
    "Results": [],
    "Page": 1,
    "Next": "https://test.helmconnect.com/api/v2/public/locations?page=2&$filter=Name eq 'Helm   Operations'"
}

Returned response with Next link in 1.24 (the same as 1.23, because this is an example of a request that did not change):

Data":{
    "Results": [],
    "Page": 1,
    "Next": "https://test.helmconnect.com/api/v2/public/locations?page=2&$filter=Name eq 'Helm   Operations'"
}

Examples of cases affected by the change:

Example 2

Encoded request:

https://test.helmconnect.com/api/v2/public/locations?$filter=Modified%20lt%20datetime'2022-01-01T10%3A30%3A25.123456%2B00%3A00'

Unencoded request:

https://test.helmconnect.com/api/v2/public/locations?$filter=Modified lt datetime'2022-01-01T10:30:25.123456+00:00'

Returned response with Next link in 1.23:

Data":{
    "Results": [],
    "Page": 1,
    "Next": "https://test.helmconnect.com/api/v2/public/locations?page=2&$filter=Modified lt datetime'2022-01-01T10:30:25.123456%2B00:00'"
}

Returned response with Next link in 1.24 (notice the format of the Next link is different):

Data":{
    "Results": [],
    "Page": 1,
    "Next": "https://test.helmconnect.com/api/v2/public/locations?page=2&$filter=Modified lt datetime'2022-01-01T10%3A30%3A25.123456%2B00%3A00'"
}

Example 3

Encoded request:

https://test.helmconnect.com/api/v2/public/locations?$filter=Modified%20lt%20datetime%272022-01-01T10%3A30%3A25.123456%2B00%3A00%27

Unencoded request:

https://test.helmconnect.com/api/v2/public/locations?$filter=Modified lt datetime'2022-01-01T10:30:25.123456+00:00'

Returned response with Next link in 1.23:

Data":{
    "Results": [],
    "Page": 1,
    "Next": "https://test.helmconnect.com/api/v2/public/locations?page=2&$filter=Modified lt datetime'2022-01-01T10:30:25.123456%2B00:00'"
}

Returned response with Next link in 1.24 (notice the format of the Next link is different):

Data":{
    "Results": [],
    "Page": 1,
    "Next": "https://test.helmconnect.com/api/v2/public/locations?page=2&$filter=Modified lt datetime%272022-01-01T10%3A30%3A25.123456%2B00%3A00%27"
}

The affected endpoints are: