Get Process Definition

Get a specific process definition by ID.

GET /commerce/processes/definitions/{containerIdOrAlias}/{processId}

Error

A valid request URL is required to generate request examples

200

{
  "_links": {
    "empty": true
  },
  "attributes": {},
  "containerAlias": "<string>",
  "containerId": "<string>",
  "id": "<string>",
  "tasks": [
    {
      "description": "<string>",
      "id": "<string>",
      "inputs": [
        {
          "helpMessage": "<string>",
          "label": "<string>",
          "maxLength": 123,
          "maximum": 123,
          "minLength": 123,
          "minimum": 123,
          "name": "<string>",
          "options": [
            {}
          ],
          "pattern": "<string>",
          "required": true
        }
      ],
      "name": "<string>",
      "priority": 123,
      "skippable": true,
      "subject": "<string>"
    }
  ],
  "variables": [
    {
      "name": "<string>"
    }
  ],
  "version": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

containerIdOrAlias · string · required

containerIdOrAlias

processId · string · required

processId

Response

200

application/hal+json

OK

_links · Links · object

Show child attributes

attributes · object

Show child attributes

containerAlias · string

containerId · string

id · string

tasks · TaskDefinition · object[]

Show child attributes

variables · WorkflowProcessVariable · object[]

Show child attributes

version · string