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 Extract API

Service to extract the resources from an organization based on resource ids.

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

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

This API exposes 2 operations across 2 paths, and defines 9 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.

2 operations 2 paths 9 schemas 1 GET1 POST

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 Extract 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 2

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

Extract 2

Service to extract the resources from an organization based on resource ids.

POST
/orgs/{org_id}/extract
Create extraction request
createExtract 2 params body → 202400401404
GET
/orgs/{org_id}/extract/{session_id}
Get extract information
getExtract 2 params → 200400401404

Schemas 9

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

CreateExtractRequest
object
The data associated with the resource.
1 property 1 required
ExtractionType
RobotAppConfiguration
Errors
object
1 property
CreateExtractResponse
object
The data associated with the resource.
1 property 1 required
RobotIdConfiguration
Error
object
5 properties 1 required
GetExtractResponse
object
The data associated with the resource.
1 property 1 required
ImpactReportTargetConfiguration

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-extract-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 test plans API
Wegalvanize Control tests API
Wegalvanize Controls API
Wegalvanize Custom attributes API