REST API Version 2: External References
When you use the REST API to integrate Max applications with other systems, the client usually does not recognize the Max ID (UUID) of a record, but can recognize the external system ID, for example, the Salesforce ID. The Max REST API automatically handles those IDs and uses them to locate the corresponding Max records by allowing a special formatted string everywhere that the API accepts a reference (UUID) that is used to search records by the standard io_external_id field. The format for external IDs is external-X...Y...Z, where X...Y...Z is the external ID of the relevant record. You can use this syntax in all REST API URLs:
https://<server>/v2/io_showcase/external-xxxxbbbbaaaa
https://<server>/v2/io_showcase?uuids=external-xxxx,external-yyyy,....,external-zzzz
You can also use the following syntax in JSON code for create, update, and delete operations:
{
"io_uuid" : "84a33b7e-833a-47da-95ed-8da49ee9eeb0" ,
"io_name" : "showcase new2" ,
"svmx_job" : "external-job_sfdc_id" ,
},
Additionally, you can use the following syntax to identify records to update in multiple updates:
{
"io_uuid" : "external-record-id" ,
"io_name" : "showcase new2" ,
},
For more information: