Closed matthew-white closed 4 months ago
We discussed this on a call yesterday. Renaming uuid
to id
in the REST API would be a breaking change, so we've decided not to make this change. Going forward for new features in the future, we'll try to set up more consistency between names in Collect vs. Central.
We use different names for the entity UUID in different places:
name
of the secondary instance.id
attribute of the<entity>
element.id
for the query parameter and the node name: #668uuid
.__id
.The goal of this issue is to enhance consistency by replacing
uuid
in the REST API withid
. Maybe we could do so in a way that would be backwards compatible (e.g., returning bothid
anduuid
).That said, there is some precedent within the REST API of naming the unique identifier something other than
id
. Submissions are uniquely identified by their instance ID, but the instance ID is namedinstanceId
within the REST API, notid
.