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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Charthop

Charthop scenario API

The scenario API from Charthop — 13 operation(s) for scenario.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 16 operations across 13 paths, and defines 19 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

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

16 operations 13 paths 19 schemas 1 DELETE3 GET1 PATCH11 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
ChartHop
Resource Areas
1

Paths & Operations 16

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

scenario 16
GET
/v1/org/{orgId}/scenario
Return all scenarios in the organization paginated
findScenarios 5 params → 200400401404
POST
/v1/org/{orgId}/scenario
Create a scenario
createScenario 4 params → 201400401403404
POST
/v1/org/{orgId}/scenario/bulk/archive
Archive a set of scenarios
bulkArchiveScenarios 2 params → 200400401403404
POST
/v1/org/{orgId}/scenario/bulk/delete
Delete a set of scenarios
bulkDeleteScenarios 2 params → 200400401403404
POST
/v1/org/{orgId}/scenario/bulk/unarchive
Unarchive a set of scenarios
bulkUnarchiveScenarios 2 params → 200400401403404
GET
/v1/org/{orgId}/scenario/{scenarioId}
Return a particular scenario by id
getScenario 2 params → 200400404
PATCH
/v1/org/{orgId}/scenario/{scenarioId}
Update an existing scenario
updateScenario 4 params → 204400401403404
DELETE
/v1/org/{orgId}/scenario/{scenarioId}
Delete a scenario
deleteScenario 2 params → 204400401403404
GET
/v1/org/{orgId}/scenario/{scenarioId}/audit-log
Return past audit log events for a scenario, paginated
getScenarioAuditLog 5 params → 200400401404
POST
/v1/org/{orgId}/scenario/{scenarioId}/combine
Combine multiple scenarios into another scenario
combineScenarios 3 params → 200400401403404
POST
/v1/org/{orgId}/scenario/{scenarioId}/dates
Adjust the dates of the changes in a scenario
adjustDatesScenario 3 params → 200400401403404
POST
/v1/org/{orgId}/scenario/{scenarioId}/export/audit
Export a scenario's audit log
exportScenarioAuditLog 3 params → 201400403404
POST
/v1/org/{orgId}/scenario/{scenarioId}/merge
Merge a scenario into the primary timeline
mergeScenario 3 params → 200400401403404
POST
/v1/org/{orgId}/scenario/{scenarioId}/recalculate-metadata
Manually recalculate a scenario's metadata
recalculateScenarioMetadata 2 params → 200400401404
POST
/v1/org/{orgId}/scenario/{scenarioId}/update-shared-view
Update a scenario view config
updateScenarioSharedView 3 params → 400401403404
POST
/v1/org/{orgId}/scenario/{scenarioId}/update-shared-views
Upsert multiple scenario view configs in a single atomic request
updateScenarioSharedViews 3 params → 400401403404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Scenario (37 properties), Process (29 properties), Event (22 properties), CreateScenario (13 properties). Each schema is shown below with its type and property counts.

LogData
object
4 properties 3 required
CostImpact
object
3 properties 3 required
ScenarioBudgetImpact
object
6 properties 5 required
ScenarioMetadata
object
9 properties 4 required
AccessAction
object
3 properties 1 required
Process
object
29 properties 9 required
CreateScenario
object
13 properties 2 required
ScenarioSharedViewConfig
object
5 properties
UpdateScenario
object
11 properties
Attribution
object
6 properties
AdjustScenarioDateRequest
object
2 properties
CombineScenarioRequest
object
3 properties 1 required
ResultsAccess
object
2 properties 1 required
Money
object
3 properties 2 required
ResultsScenario
object
3 properties 1 required
ResultsEvent
object
3 properties 1 required
Scenario
object
37 properties 11 required
Event
object
22 properties 6 required
ShareAccess
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-scenario-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
AE Profile APIs.io
Charthop action API
AE Profile APIs.io
Charthop ai API
AE Profile APIs.io
Charthop ai-credit-limit API
AE Profile APIs.io
Charthop ai-hint API
AE Profile APIs.io
Charthop ai-prompt API
AE Profile APIs.io
Charthop app API
AE Profile APIs.io
Charthop appConfig API
AE Profile APIs.io
Charthop approval API
AE Profile APIs.io
Charthop approval-delegate API
AE Profile APIs.io
Charthop approval-request API
AE Profile APIs.io
Charthop assessment API
AE Profile APIs.io
#scenario
← Back to C APIs
API Details
ID
charthop:charthop-scenario-api
Base URL
https://api.charthop.com
Docs
https://docs.charthop.com/charthop-for-developers
Provider
Charthop
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network