Items represent nodes in the Verve graph. This can have a type Requirement, a Verification Event, or even a Folder, Component, or File.
Endpoints and Data Structures
GET endpoints and parameters
To access a list of all Items within a project:
Acceptable query parameters are:
groupid=<group_id>: This only returns items that are a member of the specified Group ID
rtype=<relationship_type>: This restricts what upstream and downstream items are populated in the
childrenarrays. Can be sent multiple times.
filter_string=<text string>: This works as a simple text search across an item’s Title and Body strings, and only returns items that match the text filter. Case insensitive
To access information about a specific Item:
The ID or “Data Identifier” of the item returned.
Title of the Item returned.
Detailed description of the Item returned. Intended for modification.
Rendered description of the Item returned, having rendered any Atomics tags and replaced them with their corresponding values.
Description of a specific Item Type. These can be customized to your deployment, but commonly used items are:
Timestamp of most recent modification.
Whether or not this item is locked from being edited.
List of atomics associated with the Item. See the section on Atomics for details.
List of approvals associated with the Item. In format:
Computed approval state based on approval statuses. For a deeper understanding, please see Status Icons
List of children downstream from the item. In format:
List of parents upstream from the item. In format:
One of four values:
Computed verification state based on verification statuses. For a deeper understanding, please see Status Icons. Same enumeration as
List of groups the item is a member of.
POST and PUT endpoints and parameters
To create a new item:
To update a specific item:
To delete an item:
Short-form title text
Long-form description text of the item in question.
If the item is locked for editing.
If already set to
ID of project item is a member of.
Integer corresponding to specific Item Type. These can be customized to your deployment, but commonly used items are:
One of four values: