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

Charthop guideline API

The guideline API from Charthop — 3 operation(s) for guideline.

Charthop guideline API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

6 operations 3 paths 15 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
Resource Areas
1

Paths & Operations 6

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

guideline 6
GET
/v1/org/{orgId}/guideline
Get all guidelines for a given comp review
findGuidelinesForCompReview 3 params → 200
POST
/v1/org/{orgId}/guideline
Create a new guideline
createGuideline 2 params → 201
GET
/v1/org/{orgId}/guideline/{id}
Get a specific guideline
findGuideline 2 params → 200
PATCH
/v1/org/{orgId}/guideline/{id}
Update a guideline
updateGuideline 3 params → 204
DELETE
/v1/org/{orgId}/guideline/{id}
Delete a guideline
deleteGuideline 2 params → 204
GET
/v1/org/{orgId}/guideline/{id}/calculate
Calculate the matrix values for a specific guideline (which may apply to multiple scenarios in the comp review)
calculateGuideline 2 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Guideline (29 properties), CreateGuideline (15 properties), UpdateGuideline (14 properties), GuidelineCalculation (14 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
ResultsAccess
object
2 properties 1 required
CreateGuideline
object
15 properties 8 required
MoneyRange
object
3 properties
Money
object
3 properties 2 required
UpdateGuideline
object
14 properties
GuidelineCalculation
object
14 properties 9 required
Guideline
object
29 properties 10 required
Attribution
object
6 properties
Deviation
object
2 properties
BasisCondition
object
3 properties 1 required
ValueRange
object
3 properties
ResultsGuidelineCalculation
object
3 properties 1 required
BasisFieldMatrix
object
2 properties 2 required
ResultsGuideline
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-guideline-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API