A IRI is an Internationalized Resource Identifier.
In the context of the API, an IRI is the full path where a specific resource can be accessed.
For example:
/api/book/1ed2867c-0fbd-6918-bc3b-915bd23351ea
In POST
and PUT
operations, the JSON entries that refer to other API resources must
contain the IRI, not only the ID of the resource.
This is incorrect:
{ "book": "1ed2867c-0fbd-6918-bc3b-915bd23351ea", "rating": 10 }
This is correct:
{ "book": "/api/book/1ed2867c-0fbd-6918-bc3b-915bd23351ea", "rating": 10 }
Cannot find the answer to your question? Visit our support page for personalized support by our staff.