Workflows

Start a workflow

This operation starts an AEM workflow related to Content Fragments.

SecuritybearerAuth
Request
Request Body schema: application/json

Request parameters to start a workflow.

type
required
string (WorkflowType)

Type of workflow

workflowModelId
string
Default: "/etc/workflow/models/scheduled_tree_activation"

The workflow model id used for initiating the workflow instance

workflowTitle
string

A freely defined string used to identify the workflow when it executes.

agentId
string
Default: "publish"

The agent id used for publishing the content fragments.

scheduledTime
integer <int64>

The scheduled time as an epoch timestamp

excludeSubFolders
boolean
Default: false

Whether the subfolders should be ignored

filterReferencesByStatus
required
Array of arrays unique

Provides the option to filter the references by status.

Items Enum: "DRAFT" "UNPUBLISHED" "MODIFIED"
Responses
200

OK

400

Bad Request. The Problem Details object will provide more information about the exact cause.

406

Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

413

"The HTTP 413 Content Too Large response status code indicates that the request entity is larger than limits defined by server; the server might close the connection or return a Retry-After header field. Prior to RFC 9110 the response phrase for the status was Payload Too Large. That name is still widely used."

415

Unsupported Media Type. When provided as a response to a PATCH request, the response will provide an Accept-Patch response header to notify the client what patch document media types are supported.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/cf/workflows
Request samples
application/json
{
  • "type": "publish-folder",
  • "workflowModelId": "/etc/workflow/models/scheduled_tree_activation",
  • "workflowTitle": "string",
  • "agentId": "publish",
  • "scheduledTime": 0,
  • "excludeSubFolders": false,
  • "filterReferencesByStatus": [
    ]
}
Response samples
application/json
{
  • "type": "publish-folder",
  • "workflowInstanceId": "string"
}
➔ Next to Batching