How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Workflow executions API

The Workflow executions API from Cognite — 5 operation(s) for workflow executions.

Cognite Workflow executions API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflow executions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

5 operations 5 paths 43 schemas 1 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Workflow executions API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-client-credentials — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-auth-code — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 5

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

Workflow executions 5
POST
/workflows/{workflowExternalId}/versions/{version}/run
Run a workflow
TriggerRunOfSpecificVersionOfWorkflow 2 params body → 202
POST
/workflows/executions/list
Filter workflow executions
ListWorkflowExecutions body → 200
GET
/workflows/executions/{executionId}
Retrieve workflow execution details
ExecutionOfSpecificRunOfWorkflow 1 param → 200
POST
/workflows/executions/{executionId}/cancel
Cancel a workflow execution
WorkflowExecutionCancellation 1 param body → 200404
POST
/workflows/executions/{executionId}/retry
Retry workflow execution
WorkflowExecutionRetry 1 param body → 200404

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are WorkflowExecution (13 properties), TaskExecution (10 properties), WorkflowExecutionResponse (10 properties), TaskDefinition (9 properties). Each schema is shown below with its type and property counts.

Version
string
Identifier for a version. Must be unique for the workflow. No trailing or leading whitespace and no null characters allowed.
TransformationTaskOutput
object
1 property
nextCursor
string
Cursor to get the next page of results. If not present, no more results are available.
SubworkflowTaskParameters
object
1 property
Reference
string
A Reference is an expression that allows dynamically injecting input to a task during execution. References can be used to reference the input of the Workflow,…
TaskExternalId
string
Identifier for the task. Must be unique within the version. No trailing or leading whitespace and no null characters allowed. Task external IDs cannot be exact…
EngineExecutionId
string
Additional UUIDv4 identifier for an execution. Useful for Cognite support to diagnose issues.
SimulatorInputsUnit
object
1 property
TransformationTaskParameters
object
1 property
cursor
string
Cursor to use for paging through results. This cursor is returned in the response of a previous request as nextCursor. If not specified, start from the first p…
TaskDefinition
object
9 properties 3 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
TaskDepends
object
1 property 1 required
ReasonForIncompletion
string
Human-readable reason for terminal failure of a workflow task.
WorkflowExecutionResponse
object
10 properties 6 required
WorkflowExecution
object
13 properties 8 required
CdfTaskParameters
object
Parameters for the CDF Request task type, which can be used to make a request to any CDF API.
1 property
TaskType
string
ExecutionInput
object
Input data to the workflow. The content of the input data can be used as input to the workflow tasks using references. The input data should be in JSON format,…
ListExecutionsFilter
object
4 properties
WorkflowFilter
object
If the version is not specified, all versions for the workflow will be included, ordered by createdTime.
2 properties 1 required
limit
integer
The maximum number of results to return.
SimulatorInput
object
3 properties 2 required
ListExecutionsQuery
object
3 properties
CdfTaskOutput
object
2 properties
WorkflowStatus
string
FunctionTaskOutput
object
3 properties
CancelExecution
object
1 property
WorkflowDefinitionResponse
object
3 properties 2 required
SimulatorTaskOutput
object
Simulation run execution results.
3 properties
WorkflowExecutionId
string
UUIDv4 identifier for a workflow execution.
WorkflowExternalId
string
Identifier for a workflow. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.
DynamicTaskOutput
object
1 property
metadata
object
Custom, application-specific metadata. String key - String value. Keys have a maximum length of 32 characters, values a maximum of 255, and there can be a maxi…
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
FunctionTaskParameters
object
Parameters for the Cognite Function task type.
2 properties
TaskExecution
object
10 properties 6 required
DynamicTaskParameters
object
Dynamic tasks allow the dynamic creation of additional tasks during a workflow execution. There are two things needed to execute a dynamic task. - A list of ta…
1 property
Error
object
Cognite API error.
4 properties 2 required
Authentication
object
1 property 1 required
TaskExecutionId
string
UUIDv4 identifier for the execution of a workflow task.
SimulatorTaskParameters
object
Parameters for the Simulation run task type.
1 property
RetryExecution
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-workflow-executions-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Workflow executions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.