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 Project types API

Project types define the structure of a project or framework, including the terminology used in the project or framework. Updates to project types apply toall active projects, archived projects, temporarily deleted projects, and frameworks associated with the project type.Each project type has an associated workflow: Workplan (`procedure`) or Internal Control (`control`). Workflows define the components available in a projector framework. The attributes `narrative_terms`, `control_test_terms`, and `test_plan_terms` are not available for a Workplan (`procedure`) workflow.When creating a new project type, only the basic defining attributes are available. After creating the project type default customizable terms and togglesare returned and available on PATCH requests for update.

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

Tagged areas include Project types. 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 Project types 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.

Project types 5

Project types define the structure of a project or framework, including the terminology used in the project or framework. Updates to project types apply to all active projects, ar…

GET
/orgs/{org_id}/project_types
Get project types
getProjectTypes 5 params → 200400401403404415
POST
/orgs/{org_id}/project_types
Create or copy a project type
createProjectType 2 params body → 201400401403404415422
GET
/orgs/{org_id}/project_types/{id}
Get a project type
getProjectType 3 params → 200400401403404
PATCH
/orgs/{org_id}/project_types/{id}
Update a project type
updateProjectType 3 params body → 200400401403404415422
DELETE
/orgs/{org_id}/project_types/{id}
Delete a project type
deleteProjectType 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), GetProjectTypesResponse (2 properties), GetProjectTypeResponse (1 property), UpdateProjectTypeRequest (1 property). Each schema is shown below with its type and property counts.

Error
object
5 properties 1 required
Errors
object
1 property
CreateProjectTypeRequest
object
The data associated with the resource. No terms are available when creating a project type because the workflow determines which terms will be created along wi…
1 property 1 required
UpdateProjectTypeRequest
object
1 property 1 required
GetProjectTypeResponse
object
1 property 1 required
GetProjectTypesResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-project-types-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