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

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

17 operations 13 paths 14 schemas 6 GET1 PATCH5 POST5 PUT

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 17

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

process 17
GET
/v1/org/{orgId}/process
Retrieve a number of previously run processes
findProcesses 16 params → 200400401403
POST
/v1/org/{orgId}/process
Creates a new process in the pending state
createProcess 2 params → 201400401403
GET
/v1/org/{orgId}/process/last-sync/{appUserId}
Get last success sync and last sync for given appUserId
getAppProcessStatus 2 params → 200400401403
POST
/v1/org/{orgId}/process/self-serve
Creates a new process in the pending state
createSelfServeProcess 7 params → 201400401403
POST
/v1/org/{orgId}/process/{createIdOverride}
Creates a new process with a specified createId in the pending state
createProcessWithUserId 3 params → 201400401403
GET
/v1/org/{orgId}/process/{processId}
Check the status of a particular process
getProcess 3 params → 200400401403
PATCH
/v1/org/{orgId}/process/{processId}
Update the status of a process, marking its progress or setting status to DONE or ERROR
updateProcess 3 params → 400401403
PUT
/v1/org/{orgId}/process/{processId}/decrement
Decrement the step of an asynchronous process
decrement 2 params → 400401403
GET
/v1/org/{orgId}/process/{processId}/events
Get events associated to a particular process
getProcessEvents 2 params → 200400401403
GET
/v1/org/{orgId}/process/{processId}/file
Download the file associated with a particular process
getProcessFile 2 params → 400401403
POST
/v1/org/{orgId}/process/{processId}/file
Upload a file to be attached to a process, and mark the process as complete
completeWithFileExport 3 params → 400401403
PUT
/v1/org/{orgId}/process/{processId}/increment
Increment the step of an asynchronous process
increment 2 params → 400401403
GET
/v1/org/{orgId}/process/{processId}/log
Download the newline-delimited JSON log associated with a particular process
getProcessLogFile 2 params → 400401403
POST
/v1/org/{orgId}/process/{processId}/log
Append log messages to a process
appendToProcessLogFile 3 params → 400401403
PUT
/v1/org/{orgId}/process/{processId}/resume
Resume an asynchronous process
resume 3 params → 400401403
PUT
/v1/org/{orgId}/process/{processId}/resumeWithFile
Resume an asynchronous process
resumeWithFile 3 params → 400401403
PUT
/v1/org/{orgId}/process/{processId}/state
Update process state
updateStatefulProcess 3 params → 400401403

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Process (29 properties), CreateProcess (17 properties), UpdateProcess (11 properties), Attribution (6 properties). Each schema is shown below with its type and property counts.

Process
object
29 properties 9 required
ProcessEvent
object
5 properties 3 required
LogData
object
4 properties 3 required
ResultsProcess
object
3 properties 1 required
ResultsAccess
object
2 properties 1 required
AccessAction
object
3 properties 1 required
CreateProcess
object
17 properties 6 required
ProcessEventResponse
object
1 property 1 required
AppProcessStatus
object
2 properties
AppendLogRequest
object
1 property 1 required
ProcessEventUpdate
object
2 properties 2 required
UpdateProcess
object
11 properties
Attribution
object
6 properties
ProcessEventUpdatePayload
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-process-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
#process
← Back to C APIs
API Details
ID
charthop:charthop-process-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