This section will guide you through the automation of Named Values using the Platform Automation API

Managing Named Values

The Named Values task supports the following operations:

  • Create one or more Named Values
  • Retrieve all Named Values
  • Delete a Named Value

Creating Named Values

  1. Open the Postman application on your desktop or go to the Postman web portal to login or create an account.
  2. Select the Authorization tab. This can be done at the folder level if all endpoints are to use the same bearer token, or it can be assigned at the endpoint request level.
  3. Select Bearer Token from the Auth Type dropdown list.
  4. Paste the copied Automation token value from the Department for Education (DfE) Find and use an API Management Portal into the Token textbox.
  5. Find the endpoint URL and method for the Named values task you want to automate by referencing the Find and Use an API specification documentation.
  6. Copy the URL from the Creating Named Value endpoint specification.
  7. Open a new request in Postman.
  8. Select the POST method from the methods dropdown list within Postman.
  9. Paste the copied endpoint URL into the request textbox.
  10. Select the Send button to submit the request. This will return a response for the API that you can view within the response body in Postman. The response will contain various fields and values relating to the created Named values. You can download the JSON response file.
  11. Confirm your automation is as expected by logining into the Department for Education (DfE) Find and Use an API Management Portal to view the newly created Named Values. See Viewing workspace named values list.

Retrieve All Named Values

  1. Open the Postman application on your desktop or go to the Postman web portal to login or create an account.
  2. Select the Authorization tab. This can be done at the folder level if all endpoints are to use the same bearer token, or it can be assigned at the endpoint request level.
  3. Select Bearer Token from the Auth Type dropdown list.
  4. Paste the copied Automation token value from the Department for Education (DfE) Find and use an API Management Portal into the Token textbox.
  5. Find the endpoint URL and method for the Named values task you want to automate task by referencing the Find and Use an API specification documentation.
  6. Copy the URL from the Retrieving Named Value endpoint specification.
  7. Open a new request in Postman.
  8. Select the GET method from the methods dropdown list within Postman.
  9. Paste the copied endpoint URL into the request textbox.
  10. Select the Send button to submit the request. This will return a response for the API that you can view within the response body in Postman. The response will contain various fields and values all Named Values within the workspace associated with the Automation token. You can download the JSON response file.
  11. Confirm your automation is working as expected by logining into the DfE Find and Use an API Management Portal to view and compare the retrieved Named Values list in response body in Postman with list within the DfE Find and Use an API Management Portal portal. See Viewing workspace named values list.

Delete a Named Values

  1. Open the Postman application on your desktop or go to the Postman web portal to login or create an account.
  2. Select the Authorization tab. This can be done at the folder level if all endpoints are to use the same bearer token, or it can be assigned at the endpoint request level.
  3. Select bearer token from the Auth Type dropdown list.
  4. Paste the copied Automation token value from the Department for Education (DfE) Find and use an API Management Portal into the Token textbox.
  5. Find the endpoint URL and method for the Named values task you want to automate by referencing the Find and Use an API specification documentation.
  6. Select the URL from the Deleting Named Values endpoint specification.
  7. Open a new request in Postman.
  8. Select the DELETE method from the methods dropdown list within Postman.
  9. Paste the copied endpoint URL into the request textbox.
  10. Select the Send button to submit the request. This will return a response message for the API that you can view within the response body in Postman.
  11. Confirm your automation is working as expected by logining into the DfE Find and Use an API Management Portal to view and compare the current Named Values list which will no longer have the Named Value deleted from Postman. See Viewing workspace named values list.