Skip to content

Process Hello World execution

An example process that takes a name as input, and echoes it back as output. Intended to demonstrate a simple process with a single literal input.

Operation ID: executeHello-worldJob
Authorization: None

Header parameters

Prefer string
Indicates client preferences, including whether the client is capable of asynchronous processing. Allowed values: `respond-sync`, `respond-async`.

Request body

Mandatory execute request JSON

Required: Yes

Content type: application/json

Schema: object

{
  "inputs": {
    "name": "World",
    "message": "An optional message."
  }
}

Responses

Process output schema

Content type: application/json

Schema: object

Example

{}

Started asynchronous execution. Created job.

Content type: application/json

Schema: object

Properties

Property Type Required Description
processID string No —
type string Yes Allowed values: process.
jobID string Yes —
status string Yes Allowed values: accepted, running, successful, failed, dismissed.
message string No —
created string · date-time No —
started string · date-time No —
finished string · date-time No —
updated string · date-time No —
progress integer No Minimum: 0. Maximum: 100.
links array of object No —

Example

{
  "processID": "string",
  "type": "process",
  "jobID": "string",
  "status": "accepted",
  "message": "string",
  "created": "2026-01-01T00:00:00Z",
  "started": "2026-01-01T00:00:00Z",
  "finished": "2026-01-01T00:00:00Z",
  "updated": "2026-01-01T00:00:00Z",
  "progress": 0,
  "links": [
    {
      "href": "string",
      "rel": "service",
      "type": "application/json",
      "hreflang": "en",
      "title": "string"
    }
  ]
}

The requested URI was not found.

Content type: application/json

Schema: object of any

Properties

Property Type Required Description
type string Yes —
title string No —
status integer No —
detail string No —
instance string No —

Example

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Content type: text/html

Schema: string

Example

string

A server error occurred.

Content type: application/json

Schema: object of any

Properties

Property Type Required Description
type string Yes —
title string No —
status integer No —
detail string No —
instance string No —

Example

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Content type: text/html

Schema: string

Example

string

Unexpected error

Content type: application/json

Schema: object of any

Properties

Property Type Required Description
type string Yes —
title string No —
status integer No —
detail string No —
instance string No —

Example

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}