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

Entities may be business units, departments, locations, or key initiatives that are within the scope of the organization. Entities have a hierarchical structure composed of parent and child entities. Once you have set up your organization's nested entity structure, you can tag different items with entities.Learn more about entities.

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

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

This API exposes 10 operations across 4 paths, and defines 11 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.

10 operations 4 paths 11 schemas 2 DELETE4 GET2 PATCH2 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 Entities 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 10

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

Entities 10

Entities may be business units, departments, locations, or key initiatives that are within the scope of the organization. Entities have a hierarchical structure composed of parent…

GET
/orgs/{org_id}/entities
Get entities
getEntities 4 params → 200400401403404415
POST
/orgs/{org_id}/entities
Create an entity
createEntity 2 params body → 201400401403404415422
GET
/orgs/{org_id}/entities/{id}
Get an entity
getEntity 3 params → 200400401403404415
PATCH
/orgs/{org_id}/entities/{id}
Update an entity
updateEntity 3 params body → 200400401403404415422
DELETE
/orgs/{org_id}/entities/{id}
Delete an entity
deleteEntity 2 params → 204400401403404415
GET
/orgs/{org_id}/entity_categories
Get a list of entity categories
getEntityCategories 4 params → 200400401403404415
POST
/orgs/{org_id}/entity_categories
Create an entity category
createEntityCategory 2 params body → 201400401403404415422
GET
/orgs/{org_id}/entity_categories/{id}
Get an entity category
getEntityCategory 3 params → 200400401403404415
PATCH
/orgs/{org_id}/entity_categories/{id}
Update an entity category
updateEntityCategory 3 params body → 200400401403404415422
DELETE
/orgs/{org_id}/entity_categories/{id}
Delete an entity category
deleteEntityCategory 2 params → 204400401403404415

Schemas 11

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

CreateEntityCategoryResponse
object
1 property 1 required
Error
object
5 properties 1 required
GetEntityResponse
object
1 property 1 required
UpdateEntityRequest
object
The data associated with the resource.
1 property 1 required
Errors
object
1 property
CreateEntityRequest
object
The data associated with the resource.
1 property 1 required
CreateEntityCategoryRequest
object
The data associated with the resource.
1 property 1 required
UpdateEntityCategoryRequest
object
The data associated with the resource.
1 property 1 required
GetEntitiesResponse
object
The data associated with the resource.
2 properties 1 required
GetEntityCategoriesResponse
object
2 properties 1 required
GetEntityCategoryResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-entities-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