Stats

  • Locked Locked
  • Replies 3
  • Subscribers 66
  • Views 4636
  • Members are here 0
This discussion has been locked.
You can no longer post new replies to this discussion. If you have a question you can start a new discussion

How do I update a 'test case' attribute in a vPlan using the vManager API (vAPI)

Sean Collins

Hi All,

I have a vPlan (in .vplanx format) which contains a hierarchy of sections and at the bottom of the hierarchy, each section contains a test case, checker or coverage item.

Each item has associated vPlan attributes such as 'Implementation Note', 'Details', 'Owner' etc.

In my case, I'd like to change the value of an attribute (actually a user-defined attribute) associated with a test case from 'false' to 'true'. I'd like to do this using the vAPI.

I've previously used the vAPI for basic operations such as getting a list of sessions but it's not clear to me which of the vAPI commands I'd use to change a vPlan attribute value.

Please could someone give me some pointers and if possible some example JSON code.

Thanks.

  • Sean Collins

    I've now managed to answer my own question .....

    I simply used the planning/update-metrics-port endpoint, so the JSON code I used was like this:

    {
        "sticky-context": {
            "vplan": "/the/absolute/path/to/my_vplan.vplanx"
        },
        "hierarchy": "the/full/path/to/my_test_case",
        "metrics-port": {
            "my_attribute": "true"
        }
    }

    Note that I initially had issues getting the correct name of the attribute ('my_attribute'). It's not the displayed name (as you see in the vManager Planning tab) but the actual name defined in the project profile. The actual name can be shown in the Administration tab of vManager (enabled with the -admin option when invoking vManager). In the 'User Attributes' section there are 2 columns, 'Name' and 'Display Name'. Ensure the string in the 'Name' column is used.

  • StephenH
    in reply to Sean Collins

    Sean, I'm glad you got this working. There are other similar endpoints in vAPI for listing all the plan nodes (recursively if desired) as well as for updating sections, parameters etc.

    Feel free to mail me directly if you want a hand with this; you have my coordinates already Slight smile

  • Sean Collins
    in reply to StephenH

    Thanks for the offer of support Steve, I'm only running basic vAPI commands/endpoints at the moment but will be sure to get in touch if I get stuck Wink

Community Guidelines

The Cadence Design Communities support Cadence users and technologists interacting to exchange ideas, news, technical information, and best practices to solve problems and get the most from Cadence technology. The community is open to everyone, and to provide the most value, we require participants to follow our Community Guidelines that facilitate a quality exchange of ideas and information. By accessing, contributing, using or downloading any materials from the site, you agree to be bound by the full Community Guidelines.