REST API - Basics
Verve offers a powerful REST API with each customer deployment, allowing users to attach their internal infrastructure to Verve’s centralized source of truth.
Access
Authentication occurs via retrieving a JWT from your deployment’s authentication provider (if you are using our Python Library, the retrieval of this token is handled automatically via interactive login). Please contact our support team if you require an alternative method of access, such as a API token. You can view the full specification of the RESTful API by visiting <yourdeployment>.prewittridge.app/openapi/ui
.
Basic Concepts and Commands
Verve is, at its core, a powerful graph structure consisting of Items (nodes, in graph terminology) and Relationships (edges, in graph terminology). Items have associated with them Atomics, which are engineering parameters broken out for processing and use.
Projects are conceptual sets that group together Items, Relates, and Atomics, as well as their histories and other metadata. A set of Items within a Project can be tied together as an Item Group. Items also have two valuable states: Approval State and Verification State.
Project
Projects are conceptual sets that group together Items, Relates, and Atomics, as well as their histories and other metadata.
To access a list of all projects available to your user:
GET /project
To directly access details about a single project:
GET /project/id/<project_id>
To access a list of all branches associated with a project:
GET /project/id/<project_id>/branch
Items
Items represent nodes in the Verve graph. This can have a type Requirement, a Verification Event, or even a Folder, Component, or File.
For more, see: REST API - Items
Atomics
Atomics are engineering parameters associated with a specific item. An Atomic is always the member of exactly one Item, but an Item can have many Atomics.
For more, see: REST API - Atomics