Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wegalvanize Control test plans API

A test plan is a document that details how controls are assessed. Test plans identify the testing method or type of evidence obtained, specify the total sample size(split amongst testing rounds), and illustrate test steps or attributes.If your project includes at least one testing round, each control you create has one corresponding test plan.> **Note:**> * To access test plans using the API, the test plans tab must be enabled in the project type associated with the project or framework.>> Test plans located in such resources can be accessed using the API:> * In Internal Control workflow projects that have an "active" state> * In frameworksLearn more about test plans.

Wegalvanize Control test plans API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Control test plans. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.2, at version 1.1.0.

Requests are made against a single base URL, {protocol}://{server}/v1.

3 operations 2 paths 5 schemas 2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.1.0
Base URL
https://apis-us.highbond.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Wegalvanize Control test plans API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (oauth2) (bearerToken). By default, every request must be authenticated.

  • bearerToken — HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a safe and secure way to access data, while pr…

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Control test plans 3

A test plan is a document that details how controls are assessed. Test plans identify the testing method or type of evidence obtained, specify the total sample size (split amongst…

GET
/orgs/{org_id}/control_test_plans
Get organization test plans
getControlTestPlans 13 params → 200400401403404415
GET
/orgs/{org_id}/control_test_plans/{id}
Get a test plan
getControlTestPlan 3 params → 200400401403404415
PATCH
/orgs/{org_id}/control_test_plans/{id}
Update a test plan
updateControlTestPlan 3 params body → 200400401403404415422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), GetControlTestPlansResponse (3 properties), GetControlTestPlanResponse (1 property), UpdateControlTestPlanRequest (1 property). Each schema is shown below with its type and property counts.

Error
object
5 properties 1 required
Errors
object
1 property
UpdateControlTestPlanRequest
object
1 property 1 required
GetControlTestPlanResponse
object
1 property 1 required
GetControlTestPlansResponse
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-control-test-plans-api-openapi.yml Raw ↑

Other APIs Wegalvanize publishes across the network.

Wegalvanize Actions API
Wegalvanize Activities API
Wegalvanize Analyses API
Wegalvanize Attachments API
Wegalvanize Collaborators API
Wegalvanize Collections API
Wegalvanize Compliance Maps API
Wegalvanize Control performance schedules API
Wegalvanize Control tests API
Wegalvanize Controls API
Wegalvanize Custom attributes API
Wegalvanize Entities API