18
Views
11
Comments
API conflict
Discussion

Is there possibility of any conflict between APIs?
When integrating new API, is that going to affect existing APIs integrated in systems in any way?


2019-11-11 17-10-24
Manish Jawla
 
MVP

Hi @Ayushi Kumari ,

It totally depends upon what you are integrating & where, for example if you are adding new API for same integration end point, but this time request/response structure got changed, then it sometimes effect the previous/existing integration method.

If you are integrating the new API in new module or in separate application then there will be very less chance of any conflict.

If you can share your scenario, what kind of new integration you have done and where, then it will be helpful to dig more. 

Regards,

Manish Jawla

2025-06-19 10-02-53
Ayushi Kumari

Hi @Manish Jawla

I’m using an API to fetch data for a few fields on the statement page with NavisionId as the input. I also have a new API that retrieves other fields using NavisionId and ExitDate as input parameters. Both APIs must use the same NavisionId.

2019-11-11 17-10-24
Manish Jawla
 
MVP

You need to check request/response structure of both the API's, if 2 different structures are created by Outsystems, then there will be no conflict but If both API methods are sharing the same structure for (request/response) then there is a chance of conflict.

If you want to avoid such conflict it will be better to have separate request/response structure and do it manually.

check this link as well for reference: 

https://success.outsystems.com/documentation/11/integration_with_external_systems/rest/consume_rest_apis/rest_api_structures/ 

Hope this helps,

regards,

manish Jawla

2025-06-19 10-02-53
Ayushi Kumari

Thank you for your reply — this will be very helpful in integrating the new API.

2019-11-11 17-10-24
Manish Jawla
 
MVP
2018-12-10 12-16-21
Goncalo Duarte Almeida

Hello @Ayushi Kumari 

Not necessarily. A new API in OutSystems will only affect existing APIs if it changes something they also depend on, such as shared logic, endpoints, authentication, or data structure. If it is implemented separately and backward compatibility is maintained, existing integrations should continue to work normally.

2025-06-19 10-02-53
Ayushi Kumari

Hi @Goncalo Duarte Almeida


I have a scenario where I’m using an API to fetch data for certain fields on the statement page, with NavisionId as the input. Additionally, I have a new API that retrieves other fields using NavisionId and ExitDate as input parameters. Both APIs must use the same NavisionId to ensure consistency.

2018-12-10 12-16-21
Goncalo Duarte Almeida

Hi @Ayushi Kumari 


There is no conflict in this case. Both APIs use the same NavisionId, but they retrieve different data and have different input requirements.

As long as both APIs use NavisionId consistently and do not introduce changes to shared logic or data structures, they can work independently. The main consideration is ensuring that both APIs return consistent data based on the same source..

2020-09-15 13-07-23
Kilian Hekhuis
 
MVP

Hi Ayushi,

When integrating a new API, Service Studio creates seperate structures and methods for this API. I do not know of any conflict that could arise there. But like Manish already wrote, when changing or editing an existing API, e.g. to add a new method manually, or refresh the entire API, the structures can change, as sometimes Service Studio merges two similar structures.

2025-06-19 10-02-53
Ayushi Kumari

Hi @Kilian Hekhuis

I have a scenario where I’m using an API to fetch data for certain fields on the statement page, with NavisionId as the input. Additionally, I have a new API that retrieves other fields using NavisionId and ExitDate as input parameters. Both APIs must use the same NavisionId to ensure consistency.

2020-09-15 13-07-23
Kilian Hekhuis
 
MVP

Hi Ayushi,

Since the NavisionId is just an integer or a text variable, there is no chance of confusion or mixing things up. You can safely consume both APIs (or both methods of the same API). Only when you are dealing with input or output structures that partially overlap you may need to manually fix things, but in my experience this is almost never needed (and I've consumed quite a number of APIs).

Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.