To set environment variable from API response.

[nileshvaghasiya]

How to set environment variable from API response in Portman?

We are having "collectionVariables" property to set variable at collection level but I want to use variable in multiple collections so I need to set as a environment variable.

Example: I have two swagger json 1) Register and 2) Risk.
When create register then I got RegisterId that I need to use in Create Risk API.
Since these are separate collections, the "collectionVariables" property won't work for sharing variables between them.

Thanks..

[jpjpjp]

Hi,

This might not be the best answer to this question, but one way to do this is to run an external script, using the extendTests directive. Your external script can then call pm.environment.set() as appropriate.

Here's an example of what your config might look like:

version: 1.0

tests:
  integrationTests:
    - name: /categories tests
      operations:
          - openApiOperationId: getAllCategories
            openApiResponse: '200'
            variations:
              - name: SetUpEnvironment
                tests:
                  extendTests:
                  - tests:
                    - file:./scripts/post-setEnvironmentVars.js

Then your script could looks something like this:

pm.test('Ensure we got an array of categories in result', function () {
  pm.expect(categories,
    "GET /categories endpoint did not return an object with a 'categories' array"
  ).to.be.an('array');
});

const categories = pm.response.json().categories;

pm.test("Set environment variable 'numCategories' to the length of the 'categories' list", function () {
    pm.environment.set("numCategories", categories.length.toString());
});

When working with external scripts, I find it easiest to write something in the script file, generate the test collection and export it to Postman (skipping the newman run using the --runNewman=false directive), and then iteratively tweak the script in Postman until I get it right. At that point I copy the contents of the script back to my local file.

[nileshvaghasiya]

Superb mate.
I got the solution with your recommendation.

Thank you so much for your reply 👍

[thim81]

The standard way is to use assignVariables, which sets the variables on the collection itself so that the requests can run standalone, without any need for environment variables.

Out of curiosity: why would you want to update the environment variables instead of the collection variables?

[nileshvaghasiya]

Yes you are right but I have multiple collections and I want to use one collection's Id to another collection because of dependency each other.

Thank you for the reply..

[nileshvaghasiya]

Is there any way to set global or environment variable with newman run?

[nileshvaghasiya]

@jpjpjp

[jpjpjp]

Use the same approach as I described above with an external script. But instead of calling pm.environment.set(), call pm.globals.set instead.

https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-api-reference/#using-global-variables-in-scripts

[nileshvaghasiya]

Thank you for your reply..
That I did but PORTMAN is not reading value from global variable while running the whole suite when SET NEWMAN = TRUE in CLI file.

[jpjpjp]

Portman uses collection variables. You could use any of the mechanisms that Portman provides to set collection variables or you could call pm.collection variables.set(...) in your script.

If you need to use global or environment variables (for example to share them between collections as you described in your original post) you can't access these variables directly from the Portman config, you'll need to reference them via external scripts.