---
title: "Import a workflow scheme"
method: POST
path: "/api/v1/workflow/schemes/import"
tags: ["Workflow"]
---

# Import a workflow scheme

`POST /api/v1/workflow/schemes/import`

Import a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).

Returns "OK" on success.

## Request body

- WorkflowSchemeImportObjectForm
  - `workflowObject` WorkflowSchemeImportExportObjectView
    - `version` string
    - `schemes` WorkflowScheme[]
      - `id` string
      - `creationDate` string, date-time
      - `name` string
      - `variableName` string
      - `description` string
      - `archived` boolean
      - `mandatory` boolean
      - `defaultScheme` boolean
      - `modDate` string, date-time
      - `entryActionId` string
      - `system` boolean
    - `steps` WorkflowStep[]
      - `id` string
      - `creationDate` string, date-time
      - `name` string
      - `schemeId` string
      - `myOrder` integer
      - `resolved` boolean
      - `enableEscalation` boolean
      - `escalationAction` string
      - `escalationTime` integer
    - `actions` WorkflowAction[]
      - `id` string
      - `name` string
      - `schemeId` string
      - `condition` string
      - `nextStep` string
      - `nextAssign` string
      - `icon` string
      - `roleHierarchyForAssign` boolean
      - `assignable` boolean
      - `commentable` boolean
      - `order` integer
      - `saveActionlet` boolean
      - `publishActionlet` boolean
      - `unpublishActionlet` boolean
      - `archiveActionlet` boolean
      - `pushPublishActionlet` boolean
      - `onlyBatchActionlet` boolean
      - `unarchiveActionlet` boolean
      - `deleteActionlet` boolean
      - `destroyActionlet` boolean
      - `moveActionlet` boolean
      - `commentActionlet` boolean
      - `metadata` object
      - `resetable` boolean
      - `nextStepCurrentStep` boolean
      - `moveActionletHashPath` boolean
      - `owner` string
      - `showOn` string[]
      - `hasOnlyBatchActionlet` boolean
      - `hasPublishActionlet` boolean
      - `hasUnpublishActionlet` boolean
      - `hasArchiveActionlet` boolean
      - `hasUnarchiveActionlet` boolean
      - `hasDeleteActionlet` boolean
      - `hasDestroyActionlet` boolean
      - `hasCommentActionlet` boolean
      - `hasResetActionlet` boolean
      - `hasPushPublishActionlet` boolean
      - `hasMoveActionletActionlet` boolean
      - `hasSaveActionlet` boolean
      - `hasMoveActionletHasPathActionlet` boolean
    - `actionSteps` object[]
    - `actionClasses` WorkflowActionClass[]
      - `id` string
      - `actionId` string
      - `name` string
      - `order` integer
      - `clazz` string
      - `actionlet` WorkFlowActionlet
        - `howTo` string
        - `actionClass` string
        - `localizedHowto` string
        - `localizedName` string
        - `name` string
        - `parameters` WorkflowActionletParameter[]
          - `displayName` string
          - `key` string
          - `defaultValue` string
          - `required` boolean
    - `actionClassParams` WorkflowActionClassParameter[]
      - `id` string
      - `actionClassId` string
      - `key` string
      - `value` string
    - `schemeSystemActionWorkflowActionMappings` SystemActionWorkflowActionMapping[]
      - `identifier` string
      - `systemAction` 'NEW' | 'EDIT' | 'PUBLISH' | 'UNPUBLISH' | 'ARCHIVE' | 'UNARCHIVE' | 'DELETE' | 'DESTROY'
      - `workflowAction` WorkflowAction
        - `id` string
        - `name` string
        - `schemeId` string
        - `condition` string
        - `nextStep` string
        - `nextAssign` string
        - `icon` string
        - `roleHierarchyForAssign` boolean
        - `assignable` boolean
        - `commentable` boolean
        - `order` integer
        - `saveActionlet` boolean
        - `publishActionlet` boolean
        - `unpublishActionlet` boolean
        - `archiveActionlet` boolean
        - `pushPublishActionlet` boolean
        - `onlyBatchActionlet` boolean
        - `unarchiveActionlet` boolean
        - `deleteActionlet` boolean
        - `destroyActionlet` boolean
        - `moveActionlet` boolean
        - `commentActionlet` boolean
        - `metadata` object
        - `resetable` boolean
        - `nextStepCurrentStep` boolean
        - `moveActionletHashPath` boolean
        - `owner` string
        - `showOn` string[]
        - `hasOnlyBatchActionlet` boolean
        - `hasPublishActionlet` boolean
        - `hasUnpublishActionlet` boolean
        - `hasArchiveActionlet` boolean
        - `hasUnarchiveActionlet` boolean
        - `hasDeleteActionlet` boolean
        - `hasDestroyActionlet` boolean
        - `hasCommentActionlet` boolean
        - `hasResetActionlet` boolean
        - `hasPushPublishActionlet` boolean
        - `hasMoveActionletActionlet` boolean
        - `hasSaveActionlet` boolean
        - `hasMoveActionletHasPathActionlet` boolean
      - `owner` object
      - `ownerScheme` boolean
      - `ownerContentType` boolean
  - `permissions` Permission[]
    - `id` integer
    - `inode` string
    - `permission` integer
    - `type` string
    - `bitPermission` boolean
    - `individualPermission` boolean
    - `roleId` string

## Response `200`

Imported workflow scheme successfully

- ResponseEntityStringView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` string
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

## Other responses

- `400` — Bad request
- `401` — Invalid User
- `403` — Forbidden
- `406` — Not Acceptable
- `415` — Unsupported Media Type
- `500` — Internal Server Error

---

[API](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api.md) · [All operations](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/anzworldline-solutions/dotcms-rest-api/revisions/0f38cbc3bd36/schema)