younifyd
Menu

Get Workflow By Uuid

Get a workflow

GET/api/rest/v1/workflows/{uuid}

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Get Workflow By Uuid action (under Workflows).
  3. Fill in the fields below, then reference the result from later steps as {{getWorkflowByUuid.response.data}}.

Request

Path parameters

uuidstring (uuid)required

This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate. It is essential for identifying the specific entity in the API requests. Ensure that the UUID is correctly formatted and corresponds to an existing entity in the system.

Response

Returns 200 with an object. Read it in later steps with {{getWorkflowByUuid.response.data.<field>}}.

uuidstring (uuid)

Workflow UUID

codestring

Workflow code

labelsobject

Locale code

Default {}

enabledboolean

Whether the workflow is enabled

stepsarray<object>

List of workflow steps

uuidstring (uuid)

Step UUID

codestring

Step code

typestring

Step type (e.g. enrichment, review)

labelsobject

Locale code

Default {}

descriptionsobject

Locale code

Default {}

allotted_timeobject | null2 fields

Allotted time for the step (e.g. `{"value": 1, "unit": "days"}` or nullable)

channels_and_localesobject

Step configuration for channels and locales

json
{
  "uuid": "6f37476a-04c2-46c0-b6d0-e18316959068",
  "code": "enrichment_workflow",
  "labels": {
    "fr_FR": "Workflow d'enrichissement"
  },
  "enabled": true,
  "steps": [
    {
      "uuid": "f626d0e5-84a5-41fc-8215-65508c253edb",
      "code": "marketing_enrichment",
      "type": "enrichment",
      "labels": {
        "en_US": "Marketing enrichment",
        "fr_FR": "Enrichissement marketing"
      },
      "descriptions": {
        "en_US": "Enrich marketing attributes"
      },
      "allotted_time": {
        "value": 3,
        "unit": "days"
      },
      "channels_and_locales": {
        "ecommerce": [
          "en_US"
        ],
        "mobile": [
          "en_US",
          "fr_FR"
        ]
      }
    },
    {
      "uuid": "b2c1f3d4-5e6a-4c8b-9f0e-2d3e4f5a6b7c",
      "code": "marketing_review",
      "type": "review",
      "labels": {},
      "descriptions": {},
      "allotted_time": null,
      "channels_and_locales": {
        "ecommerce": [
          "en_US"
        ]
      }
    }
  ]
}

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.