The API uses links
to standard hypermedia objects to help clients locate related resources relevant within a set of JSON data. For example, the JSON below shows the sort of response you get when uploading a file attachment. Its links
array may accommodate various related resources, but in this case presents only the case ticket under which the file is tracked. The rel
represents the link relation, in this case a conceptual parent
object, and the href
that provides a navigable path to the resource once you prefix it with your hostname token.
{
"caseId": "F-CS-1203600",
"statusMessage": "Ticket has been successfully updated with file",
"links": [
{
"href": "/case-management/v2/cases/F-CS-1203600",
"rel": "parent"
}
]
}