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 Results files API

A results file is a supporting document or concluding memo that relates to a project. Results files typically contain information associatedwith the reporting phase of a project.> **Note —**Only results files in projects that have an `"active"` state can be accessed using the API.Learn more about results files.

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

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

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

5 operations 2 paths 6 schemas 1 DELETE2 GET1 PATCH1 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 Results files 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 5

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

Results files 5

A results file is a supporting document or concluding memo that relates to a project. Results files typically contain information associated with the reporting phase of a project.…

GET
/orgs/{org_id}/projects/{project_id}/results_files
Get results files
getResultsFiles 5 params → 200400401403404415
POST
/orgs/{org_id}/projects/{project_id}/results_files
Create a results file
createResultsFile 3 params body → 201400401403404415422
GET
/orgs/{org_id}/results_files/{id}
Get a results file
getResultsFile 3 params → 200400401403404
PATCH
/orgs/{org_id}/results_files/{id}
Update a results file
updateResultsFile 3 params body → 200400401403404415422
DELETE
/orgs/{org_id}/results_files/{id}
Delete a results file
deleteResultsFile 2 params → 204400401403404422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), GetResultsFilesResponse (2 properties), UpdateResultsFileRequest (1 property), GetResultsFileResponse (1 property). Each schema is shown below with its type and property counts.

Error
object
5 properties 1 required
GetResultsFilesResponse
object
2 properties 2 required
Errors
object
1 property
CreateResultsFileRequest
object
The data associated with the resource.
1 property 1 required
GetResultsFileResponse
object
1 property 1 required
UpdateResultsFileRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-results-files-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