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 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 environment variable in Postman to store the Nickname.
Notes:
-
As long as your Forge App doesn't have any data, you can map the Forge App to a different Nickname. Once you add data to a Forge App, you cannot set a Nickname for it, or change an existing Nickname.
-
The only way you can assign a Nickname to an app with data is by first calling the
[DELETE] /forgeapps/meendpoint. This deletes all data associated with that app, including the Nickname. At the end of this tutorial, the HTTP request Clean up HTTP Requests > DEL Delete Forge App Data in Design Automation calls this endpoint and clears the app of all data.
-
If you get stuck while working on this tutorial, you can use DEL Delete Forge App Data in Design Automation to clear all data from the app, and restart from Task 1.
-
Nicknames cannot contain spaces, and 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 (the eye 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 will get a return Status of 200 OK, and you should see a response similar to the following image. The response has only a header and no body.
