API To generate A resolved link which points To A specific UI page and takes into account anyrequired parameters for the UI view page To render properly. The best way To see how To usethis API Is By looking At A real-world example.
Here's the scenario: you want to generate a clickable link that takes the end user to the page that lets them see the details of a specific catalog request. Here's what you will need in order to use this API: the place identifying the page in the UI to display. If you use the UI in a browser, you'll see this in the URL. In our example, visit a page that displays a specific request, and you'll see that the place associated with that page is: csp.catalog.request.submitteddetails next, you'll need to populate all necessary params that the UI page requires. Again, if you use a browser, you can see what these params are. For our scenario, the necessary param keys are: requestId catalogItemId Once you have this information (along with the value to our required keys mentioned earlier, you are ready to craft a linkResolveRequest. Below is example JSON. Clearly, you'll need to supply your appropriate values for requestId and catalogItemId
{ "links" : [ { "place" : "csp.catalog.request.submitteddetails", "params" : [ { "key" : "requestId", "value" : "f301558a-4789-4d64-ae84-736d9245a243" }, { "key" : "catalogItemId", "value" : "de3ac822-6f97-40bc-a53d-d034deb95b3d" } ] } ] }
Once you POST against this API supplying your link request, you'll get the hrefs that you can embed in emails or use directly. If properly submitted, This API's response might look something like below, which can be used to direct a user to the configured page in the UI:
Solution users only
id of the tenant
the request containing details on the link to resolve
{
"links": [
{
"place": "string",
"params": [
{
"value": "string",
"key": "string"
}
]
}
]
}