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

Nuxeo Workflow API

Workflow Operations

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

Tagged areas include Workflow. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 16 operations across 12 paths, and defines 11 schemas. It is described by OpenAPI 3.0.2, at version LTS 2021.

Requests are made against 2 base URLs: https://{host}:{port}/nuxeo/api/v1, https://nightly.nuxeo.com/nuxeo/api/v1.

16 operations 12 paths 11 schemas 1 DELETE9 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
LTS 2021
Base URL
https://{nuxeo-server}/nuxeo/api/v1
Authentication
HTTP Basic, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Nuxeo Workflow API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_auth). An API key is passed in the header as X-Authentication-Token (token).

Paths & Operations 16

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

Workflow 16

Workflow Operations

GET
/id/{docId}/@task
List tasks of the given document
DocumentIdTaskAdapterGet 4 params → 200401404
GET
/path/{docPath}/@task
List tasks of the given document
DocumentPathTaskAdapterGet 4 params → 200401404
GET
/task
Query tasks by user and workflow ids
TaskGet 9 params → 200401404
GET
/task/{taskId}
Get a task by its id
TaskIdGet 1 param → 200401404
PUT
/task/{taskId}/delegate
Delegate a task
TaskDelegatePut 3 params → 200401404
PUT
/task/{taskId}/reassign
Reassign a task
TaskReassignPut 3 params → 200401404
PUT
/task/{taskId}/{action}
Complete task
TaskActionPut 2 params body → 200401404
GET
/id/{docId}/@workflow
Get the workflow instances launched on the given document
DocumentIdWorkflowAdapterGet 1 param → 200401404
POST
/id/{docId}/@workflow
Start a workflow instance on the given document
DocumentIdWorkflowAdapterPost 1 param body → 200401404
GET
/path/{docPath}/@workflow
Get the workflow instances launched on the given document
DocumentPathWorkflowAdapterGet 1 param → 200401404
POST
/path/{docPath}/@workflow
Start a workflow instance on the given document
DocumentPathWorkflowAdapterPost 1 param body → 200401404
GET
/workflow
Get the workflow instances launched by the current user
WorkflowGet → 200401404
POST
/workflow
Start a workflow instance
WorkflowPost body → 200401404
DELETE
/workflow/{workflowInstanceId}
Delete a workflow instance by its id
WorkflowInstanceDelete 1 param → 200401404
GET
/workflow/{workflowInstanceId}
Find a workflow instance by its id
WorkflowInstanceGet 1 param → 200401404
GET
/workflow/{workflowInstanceId}/graph
Get the json serialization of a workflow instance graph
WorkflowInstanceGraphGet 1 param → 200401404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are task (15 properties), workflow (6 properties), taskCompletionRequest (4 properties), workflowRequest (4 properties). Each schema is shown below with its type and property counts.

tasks
object
2 properties 2 required
workflowGraph
workflows
object
2 properties 2 required
taskInfo
object
2 properties 2 required
taskCompletionRequest
object
4 properties 1 required
workflowRequest
object
4 properties 1 required
taskComments
object
2 properties 2 required
workflow
object
6 properties 1 required
task
object
15 properties 1 required
Property
object
2 properties 2 required
taskAction
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-workflow-api-openapi.yml Raw ↑

Other APIs Nuxeo publishes across the network.

Nuxeo ACL API
Nuxeo Adapter API
Nuxeo Annotation API
Nuxeo Audit API
Nuxeo Automation API
Nuxeo Blob API
Nuxeo Business Object API
Nuxeo Children API
Nuxeo Configuration API
Nuxeo Conversion API
Nuxeo Directory API
Nuxeo Document API