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 Workflows in Asset Inventory/Asset Manager API

Workflows contain a set of statuses that a certain item belonging to that workflow can be in. Any items in this workflow can move between certain statuses and the transition can trigger certain events which will execute their handlers.Workflow statuses represent all possible states an item of the workflow can be in. Statuses can be associated with Events to allow transition from one status to another within the same workflow.Every workflow must have exactly one "default" status. You can make a status the default status by setting or updating the default flag on that status. This default status cannot be deleted.

Wegalvanize Workflows in Asset Inventory/Asset Manager API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows in Asset Inventory/Asset Manager. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

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

14 operations 7 paths 15 schemas 3 DELETE5 GET3 PATCH3 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 Workflows in Asset Inventory/Asset Manager 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 14

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

Workflows in Asset Inventory/Asset Manager 14

Workflows contain a set of statuses that a certain item belonging to that workflow can be in. Any items in this workflow can move between certain statuses and the transition can t…

GET
/orgs/{org_id}/workflows
List Workflows
getWorkflows 1 param → 200400401403404
POST
/orgs/{org_id}/workflows
Create a workflow
createWorkflow 1 param body → 201400401403404415422
GET
/orgs/{org_id}/workflows/{id}
Get a workflow
getWorkflow 3 params → 200401403404
PATCH
/orgs/{org_id}/workflows/{id}
Update a workflow
updateWorkflow 2 params body → 200400401403404415422
DELETE
/orgs/{org_id}/workflows/{id}
Delete a workflow
deleteWorkflow 2 params → 204400401403404
GET
/orgs/{org_id}/workflows/{api_name}
Get a workflow by api name
getWorkflowByApiName 3 params → 200401403404
POST
/orgs/{org_id}/workflows/{workflow_id}/statuses
Create a workflow status
createWorkflowStatus 2 params body → 201400401403404415422
GET
/orgs/{org_id}/statuses/{id}
Get a workflow status
getWorkflowStatus 3 params → 200400401403404
PATCH
/orgs/{org_id}/statuses/{id}
Update a workflow status
updateWorkflowStatus 2 params body → 200400401403404415422
DELETE
/orgs/{org_id}/statuses/{id}
Delete a workflow status
deleteWorkflowStatus 3 params → 204400401403404
POST
/orgs/{org_id}/status_event_mappings
Create a status event mapping
createStatusEventMapping 1 param body → 201400401403404415422
GET
/orgs/{org_id}/status_event_mappings/{id}
Get a status event mapping
getStatusEventMapping 2 params → 200400401403404
PATCH
/orgs/{org_id}/status_event_mappings/{id}
Update a status event mapping
updateStatusEventMapping 2 params body → 200400401403404415422
DELETE
/orgs/{org_id}/status_event_mappings/{id}
Delete a status event mapping
deleteStatusEventMapping 2 params → 204400401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are EventPlainJson (10 properties), Error (5 properties), SingleWorkflowResponseWithIncludes (2 properties), SingleWorkflowStatusResponseWithIncluded (2 properties). Each schema is shown below with its type and property counts.

SingleWorkflowStatusResponse
object
The data associated with the resource.
1 property 1 required
MultipleWorkflowsResponse
object
The data associated with the resource.
1 property 1 required
CreateStatusEventMappingPayload
object
The data associated with the resource.
1 property 1 required
Error
object
5 properties 1 required
SingleWorkflowStatusResponseWithIncluded
object
The data associated with the resource.
2 properties 1 required
SingleWorkflowResponse
object
The data associated with the resource.
1 property 1 required
UpdateWorkflowStatusPayload
object
The data associated with the resource.
1 property 1 required
Errors
object
1 property
UpdateWorkflowPayload
object
The data associated with the resource.
1 property 1 required
SingleWorkflowResponseWithIncludes
object
The data associated with the resource.
2 properties 2 required
UpdateStatusEventMappingPayload
object
The data associated with the resource.
1 property 1 required
EventPlainJson
object
The plain JSON representation of an Event.
10 properties
CreateWorkflowStatusPayload
object
The data associated with the resource.
1 property 1 required
CreateWorkflowPayload
object
The data associated with the resource.
1 property 1 required
SingleStatusEventMappingResponse
object
The data associated with the resource.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-workflows-in-asset-inventory-asset-manager-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