Dealing with relationships via the API

Hello, all!

Using V11 API here.

So that you understand the scenario, I have a many to many relationship between two modules called Pet and Booking.

Currently I am serializing this relationship (to send over a POST request) by the following way:

floof_booking_floof_pet:

{ 'add': ['aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee','aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'] }

This creates the new booking with 2 pets linked to it. However I will have to update this at some point (with a PUT request), adding or removing pets, so I cannot simply send ADD again, right? Because I think this will ADD another relationship to them instead of overwriting whatever is already there.

I'd like a way to overwrite the relationships, so whenever I do a PUT request, I can simply send the new relationships. Is it possible?

Thanks a lot!

0 Andre Serrazina over 2 years ago

Hello Natasha Collimore,

On this scenario I believe you should be looking at the following four endpoints.
These are the ones that are used when adding/removing records in a relationship subpanel in the Sugar graphic user interface:

1 – Create a related record, for creating a new Pet related to a booking
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_11.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/

2 – Link an existing record, for linking an existing Pet to the booking
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_11.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/

3 – Unlink an existing record, to unlink an existing Pet from the booking
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_12.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/

4 – Delete a record, to delete the related Pet
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_11.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_DELETE/

I hope this helps

André
Cancel
Vote Up +1 Vote Down

Sign in to reply

Verify Answer

Cancel
0 Natasha Collimore over 2 years ago in reply to Andre Serrazina

Thanks for your answer, Andre Serrazina.

I can add, create and remove records from the relationship with the PUT request, I would have to use the appropriate ACTION for it (add, delete, create).

But to do so, I'd have to compare the previous state with the new state and then add / remove the relationships to fit the new state. Is there a way to simply overwrite the relationships? So that I just have to pass the new ones and don't worry about the old ones?

Or even a way to empty the relationship? So I can ADD the new ones?
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel
0 Andre Serrazina over 2 years ago in reply to Natasha Collimore

Hello Natasha Collimore,

The only way I can think to clear all the relationship entries is to fetch the id's of the related records, and then use the ID's to unlink them.

I am not aware of any existing endpoint that unlinks all the records from a given relationship, so you could also think about creating a custom endpoint to do that.
Cancel
Vote Up +1 Vote Down

Sign in to reply

Verify Answer

Cancel