Inconsistencies in SaaS REST API

stefanstoichev123 — Tue, 19 Jul 2022 20:54:20 GMT

Hi all,

noticed some inconsistencies in SaaS REST API and want to check if this is a "bug or a feature" type of thing 🙂

for example: when calling GET /v1/items the response have data property that contains all the items (in this case). This is more or less valid for all "old" endpoints (like /v1/reloads, /v1/collections, /v1/spaces etc).

But for the some of the "new" endpoints the response is sometimes in a different format. For example /v1/data-alerts returns data in the following format:

{ "totalCount": 123, "currentPageCount": 123, "links": {...}, "tasks": [{...}, {...}, ...] }

(the same format can be seen for /v1/notification-digests/{digestId}/executions for example but the data is under executions property)

And I can understand the totalCount, links and currentPageCount but why is the "real" data:

called tasks (the api is for data alerts)
why not named as the rest of the endpoints - data

Is this normal behaviour or its an issue with the API? If its an expected then shall we expect such "dualism" in the future and is there any rule for when to expect data and when something else?

Regards!

Stefan

Re: Inconsistencies in SaaS REST API

Akshesh_Patel — Wed, 20 Jul 2022 13:41:25 GMT

Hi,

Thanks for bringing this up, let me check with the R&D team and I will get back to you asap.

Thanks

topic Re: Inconsistencies in SaaS REST API in Integration, Extension & APIs

Inconsistencies in SaaS REST API

Re: Inconsistencies in SaaS REST API