The example below is an automation using the API Name Values Task to create a new workspace named value within the DfE Find and Use an API Management Portal. This automation as with other automations will involve 2 stages.

Stage 1: Generating an automation token

Stage 2: Creating named values using the Platform Automation API endpoint following these steps:

  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 generated from Stage 1 above into the Token textbox.
  5. Find the endpoint URL and method for the named values task you want to automate by referencing the Create a named value section of the API Technical documentation specification..
  6. Copy the URL from the Create a 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.

The sequence of steps described above can be followed for other automation tasks and operations by simply replacing the endpoint URL and method in Step 6.