Prev Next

GetItemList

Inputs

Parameter

Details

parameters

  • C++: const char*
  • C#: string

A JSON string of parameters. Includes:

  • level - the level hierarchy of the requested menu (starting with 1 for first level)
  • currentID, currentName - the id and name of the current menu level
  • levelXID - the ID of the menu level X for all previous levels in the hierarchy; that is, level1ID, level2ID
  • levelXName - the name of the menu level X for all previous levels in the hierarchy; that is, level1Name, level2Name

Outputs via Callbacks

[Optional] AddProperty - multiple calls per item:

  • AddProperty(index, "id", "myitemid");
  • AddProperty(index, "name", "Example Item 3");
  • AddProperty(index, "modifiedDate", "2020-04-06T11:33:44");
  • AddProperty(index, "type", "Requirement");
  • AddProperty(index, "url", "http://example.com/item/3");

[Optional] LogMessage or SetError - to provide user feedback.

Details

This method receives a request to populate the list of items in the External Data window for the selected menu level. This method should fill in the items by calling the AddProperty callback method.

Each item requires five calls to AddProperty to fill in the details of the item in the list. And each item must use a unique 'index' value as the first parameter.

  • id - the id passed in specifies a unique id representing this item; the Plug-in can receive this id back in subsequent calls (such as when requesting item details or notes)
  • name - the user-displayable name of the item
  • modifiedDate - the date/time that the item was last modified, in the format: YYYY-MM-DDTHH:MM:SS
  • type - the type of the item as understood by the external provider; for example Defect, Task, Requirement, Document
  • url - a url that will take a user directly to this item; this is used by Enterprise architect when selecting 'Open External Item in Browser Window'

Don't return an error for a blank response. Simply do nothing.