Workflows
, your environments might contain several workflows with different workflow steps.The workflows themselves consist of a number of steps, with two predefined steps, Published and Archived. Workflow steps indicate a specific stage in the content production process. For example, Draft -> Review -> Legal approval -> Published. Every variant of a content item (such as English, Spanish, French) can be moved to a specific workflow step.
The combination of workflow and its workflow step might affect who can edit the variant and who can move the variant to another workflow step. Check how to set up a workflow for your content.
Retrieve workflow steps
Deprecated
Get the workflow steps from the default workflow in your environment.
Deprecation noticeIn April 2022, this endpoint was deprecated in favor of the Retrieve workflows endpoint, which supports multiple workflows.
Deprecation noticeIn April 2022, this endpoint was deprecated in favor of the Retrieve workflows endpoint, which supports multiple workflows.GET
https://manage.kontent.ai/v2/projects/{environment_id}/workflowRequest
Path parameters
environment_idIdentifies your environment.
Request samples
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript
import { ManagementClient } from '@kontent-ai/management-sdk';
const client = new ManagementClient({
environmentId: 'KONTENT_AI_ENVIRONMENT_ID',
apiKey: 'KONTENT_AI_MANAGEMENT_API_KEY',
});
const response = await client.listWorkflows().toPromise();
const steps = response.data.find(
(workflow) => workflow.codeName === 'default',
).steps;
Response
Status (200)
A list of workflow steps in the specified environment.
Example responses
[
{
"id": "eee6db3b-545a-4785-8e86-e3772c8756f9",
"name": "Draft",
"codename": "draft",
"transitions_to": [
"c199950d-99f0-4983-b711-6c4c91624b22",
"7a535a69-ad34-47f8-806a-def1fdf4d391"
]
},
{
"id": "9d2b0228-4d0d-4c23-8b49-01a698857709",
"name": "Scheduled",
"codename": "scheduled",
"transitions_to": []
},
{
"id": "c199950d-99f0-4983-b711-6c4c91624b22",
"name": "Published",
"codename": "published",
"transitions_to": []
},
{
"id": "7a535a69-ad34-47f8-806a-def1fdf4d391",
"name": "Archived",
"codename": "archived",
"transitions_to": []
}
]Update a workflow
Update an existing workflow, manage its scope, workflow steps and their transitions, and role permissions. Always make sure that all steps eventually transition to the Published step.When removing a workflow step, make sure the step is not in use. You can't remove a used workflow step.
PUT
https://manage.kontent.ai/v2/projects/{environment_id}/workflows/{workflow_identifier}Request
Path parameters
environment_idIdentifies your environment.
workflow_identifierIdentifies the workflow by its internal ID (e.g.,
8bfdb62d-7aa1-473b-9d80-311ef93db108) or codename (e.g., codename/my-workflow).Body schema
Application/json
Specify what you want to update in the workflow.
nameThe workflow's display name.
codenameThe workflow's codename.
scopes[]Specifies the content types and collections that this workflow is limited to. If both content types and collections are empty, the workflow can be used for any type of content in collection that isn't limited to any other workflow.Changing the workflow's scope doesn't affect existing content items unless you change their workflow manually.
steps[]The workflow steps in this workflow.
Prefer codenames over IDs when referring to workflow stepsYou can reference existing workflow steps by their codename or ID. We recommend using codenames because it makes your code cleaner and easier to manage. Use ID only when you need to change the codename of a workflow step.
If you want to reuse codenames of existing workflow steps in new workflow steps, you need to make two requests. First remove the workflow step with the desired codename. This make the codename available. Then add a new workflow step.
Prefer codenames over IDs when referring to workflow stepsYou can reference existing workflow steps by their codename or ID. We recommend using codenames because it makes your code cleaner and easier to manage. Use ID only when you need to change the codename of a workflow step.
If you want to reuse codenames of existing workflow steps in new workflow steps, you need to make two requests. First remove the workflow step with the desired codename. This make the codename available. Then add a new workflow step.published_stepThe workflow's predefined Published workflow step.
archived_stepThe workflow's predefined Archived workflow step.
Request samples
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript
import { ManagementClient } from '@kontent-ai/management-sdk';
const client = new ManagementClient({
environmentId: 'KONTENT_AI_ENVIRONMENT_ID',
apiKey: 'KONTENT_AI_MANAGEMENT_API_KEY',
});
const response = await client
.updateWorkflow()
.byWorkflowId('f9f28df0-9dec-4ee3-b087-c501e4b75347')
//.byWorkflowCodename('my-workflow')
.withData({
name: 'My workflow',
scopes: [
{
content_types: [
{
codename: 'article',
},
],
collections: [
{
id: 'b15b6050-80d8-406d-bf21-3012e4ad0ac5',
},
],
},
],
steps: [
{
name: 'First step',
codename: 'first_step',
color: 'sky-blue',
transitions_to: [
{
step: {
id: '16221cc2-bd22-4414-a513-f3e555c0fc93',
},
},
{
step: {
codename: 'archived',
},
},
],
role_ids: ['e796887c-38a1-4ab2-a999-c40861bb7a4b'],
},
{
name: 'Renamed Second step',
codename: 'second_step_renamed',
color: 'rose',
id: '16221cc2-bd22-4414-a513-f3e555c0fc93',
transitions_to: [
{
step: {
codename: 'published',
},
},
],
role_ids: [],
},
],
published_step: {
unpublish_role_ids: [],
create_new_version_role_ids: ['e796887c-38a1-4ab2-a999-c40861bb7a4b'],
},
archived_step: {
role_ids: ['e796887c-38a1-4ab2-a999-c40861bb7a4b'],
},
})
.toPromise();
Response
Status (200)
The updated workflow.
idThe workflow's internal ID. The ID of the default workflow is always
00000000-0000-0000-0000-000000000000.nameThe workflow's display name.
codenameThe workflow's codename.
scopes[]Specifies the content types and collections that this workflow is limited to. If both content types and collections are empty, the workflow can be used for any type of content in collection that isn't limited to any other workflow.Changing the workflow's scope doesn't affect existing content items unless you change their workflow manually.
steps[]The workflow steps in this workflow.
published_stepThe workflow's predefined Published workflow step.
scheduled_stepThe workflow's predefined Scheduled workflow step.
archived_stepThe workflow's predefined Archived workflow step.
Example responses
{
"id": "8e38928b-50b6-4e9e-ab53-af35d6fcfcb8",
"name": "My workflow",
"codename": "my_workflow",
"scopes": [
{
"content_types": [
{
"id": "1cdb6e21-3330-4f0f-88cd-171098950e4f"
},
{
"id": "2ea20d43-5293-43a4-8bd2-9674a92b20ec"
}
],
"collections": [
{
"id": "b15b6050-80d8-406d-bf21-3012e4ad0ac5"
},
{
"id": "af665269-5b03-409d-b6e4-81a8b34e97fc"
}
]
}
],
"steps": [
{
"id": "b288d00b-f5cd-4afe-97fc-42b9264404f3",
"name": "Draft",
"codename": "draft",
"color": "red",
"transitions_to": [
{
"step": {
"id": "c199950d-99f0-4983-b711-6c4c91624b22"
}
},
{
"step": {
"id": "7a535a69-ad34-47f8-806a-def1fdf4d391"
}
}
],
"role_ids": [
"e25d74b8-f81a-4faf-94b9-b0bf2b3802c6"
]
}
],
"published_step": {
"id": "c199950d-99f0-4983-b711-6c4c91624b22",
"name": "Published",
"codename": "published",
"unpublish_role_ids": [
"e25d74b8-f81a-4faf-94b9-b0bf2b3802c6"
],
"create_new_version_role_ids": [
"e25d74b8-f81a-4faf-94b9-b0bf2b3802c6"
]
},
"scheduled_step": {
"id": "9d2b0228-4d0d-4c23-8b49-01a698857709",
"name": "Scheduled",
"codename": "scheduled"
},
"archived_step": {
"id": "7a535a69-ad34-47f8-806a-def1fdf4d391",
"name": "Archived",
"codename": "archived",
"role_ids": [
"e25d74b8-f81a-4faf-94b9-b0bf2b3802c6"
]
}
}