SugarCRM Rest API Rules

Do you get a Note's ID in the response?

Hello,

Yes I get the Note's ID in the response.

Thanks.

I just ran exactly this same request and I got new Note under specified Account.

Are you able to access the new Note itself?

Request 1: Note appears under specified account:

POST sg-richarddemo.demo.sugarcrm.eu/.../Notes

{
"name": "Test Note 16",
"parent_id": "6c39e3a2-b234-11e6-876e-02b6c8b587a1",
"parent_type": "Accounts",
"note_type_c": "note",
"assigned_user_id": "1",
"team_name": {
"id": "1",
"name": "Global",
"primary": "true",
"selected": "false"
}
}

Request 2: Note is created, but doesn't under specified account

{
"parent_id": "6c39e3a2-b234-11e6-876e-02b6c8b587a1",
"name": "Test Note 31"}

My question is, other than trial and error, how would I find out which fields are necessary for a note to appear under the specified account. I.e. if request 2 was the starting point, how would I find out that parent_type (and possibly other fields) are also necessary: both requests specify a parent_id.

Request 2: {
"parent_id": "6c39e3a2-b234-11e6-876e-02b6c8b587a1",
"name": "Test Note 31"}

is incorrect. You specify a parent_id but you don't specify which module you want to have it connected to? 

The notes module uses a so called 'flex relate'. Which means it can be connected to any module in the system (if it configured). 

To find out how the api works you should take a look at the development guide ( https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_9.0/Integration/Web_Services/REST_API/) and ofcourse just try things in the ui of sugar with developer tools open to see which requests the system does make. 

Minimum required fields for  that scenario are:

• name
• parent_type
• parent_id
• team_name
• assigned_user_id

If not specified assigned_user_id it will remain empty.

If not specified team_name it will inherit from user who created the record.

Both parent_type and parent_id are required in order to specify a Parent record.

Sorry this was an omission in the transcription, Both requests were posted to this endpoint:

POST /rest/v11_4/Notes
Host: sg-richardemo.demo.sugarcrm.eu

Thanks for the tips.

Ok, thanks, but is this the sort of information that's defined in the API doc, or is it derived from a combination of seeing what api requests the SugarCrm GUI makes / SugarCRM doc / SugarCRM experience.

Both. The api docs are not very specific per module. That's a common thing that needs addressing

Hi Timothy,
That's a business logic - either to be aware of how to deal with it via code or employ configuring

Therefore, you are trying to put some data into Sugar via API, there is an option for non-developer to make it in two steps:

1) to put data as it is by declaring a custom endpoint




2) design data transformations and data population with Logic Builder instead of coding them  - here is the example of your case -  e.g. to create a Note and relate it to the Account without knowledge of API business logic:


It took 15 min to make it with design, so I can help you to make it work in your Sugar - just drop me a line via Sugar Messages or dch@integroscrm.com