Forge uses the Client ID to uniquely identify an app. The Client ID can be long and cryptic, and hence a source of irritation when you reference the data you add to your app.
A Nickname lets you map a Client ID to an easy-to-use name that you can use in place of the Client ID. This tutorial uses the dasNickName Postman Environment Variable to store the Nickname.
Notes:
-
Once your add data to a Forge App, you are not allowed to set a nickname for the app. The only way you can assign a nickname to an app with data is by first calling the
[DELETE] /forgeapps/meendpoint. This endpoint deletes all data associated with that app, including any existing nickname. The request Extras > Delete Forge App Data in Design Automation in this Postman Collection calls this endpoint ([DELETE] /forgeapps/me) and clears the app of all data.
-
If you get stuck while working on this tutorial, and are unable to proceed, use this request to clear all data from the app, and restart from Task 1.
-
Nicknames must be globally unique. If the nickname is already in use, even by someone else, Forge returns a
409 Conflicterror when you try to set the Nickname.
-
Click the Environment quick look icon on the upper right corner of Postman.
-
In the CURRENT VALUE column, in the dasNickName row, enter a Nickname for your app.
-
Click the Environment quick look icon again, to hide the variables.
-
On the Postman sidebar, click Task 2 - Create a Nickname > PATCH Create Nickname. The request loads.
-
Click Send. If the request is successful, you should see a response similar to the following image. The response has only a header and no body.
