Wegalvanize Walkthroughs API
A walkthrough is a series of steps you perform to establish the reliability of controls and test the design of controls. Each control you define has a correspondingwalkthrough that is used to verify that the control is designed appropriately. In a Workplan workflow project, a walkthrough is called an execute procedure.> **Note**> * Only walkthroughs in projects that have an `"active"` state can be accessed using the API.> * To access walkthroughs using the API, the walkthroughs tab must be enabled in the project type associated with the project.Learn more about walkthroughs.
Wegalvanize Walkthroughs API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Walkthroughs. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Wegalvanize Walkthroughs 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.
A walkthrough is a series of steps you perform to establish the reliability of controls and test the design of controls. Each control you define has a corresponding walkthrough th…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), GetWalkthroughsResponse (3 properties), GetWalkthroughResponse (1 property), Errors (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Wegalvanize 12
Other APIs Wegalvanize publishes across the network.